Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

CouponArray Type

Represents zero or more coupons.


Array Elements

Type Description
Coupon Represents a single coupon.

JSON XML

Example

[
    {
        "Id": 1,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "Description": "10% off when you spend $100 or more",
        "Code": "TENOFF",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/c/1",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/c/1\" rel=\"noindex,nofollow\">10% off when you spend $100 or more</a>"
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "Description": "20% off when you spend $300 or more",
        "Code": "TWENTYOFF",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/c/2",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/c/2\" rel=\"noindex,nofollow\">20% off when you spend $300 or more</a>"
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "MerchantId": 1,
        "MerchantName": "Example Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "Description": "30% off when you spend $500 or more",
        "Code": "THIRTYOFF",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/c/3",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/c/3\" rel=\"noindex,nofollow\">30% off when you spend $500 or more</a>"
    }
]
<CouponArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Coupon>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <Description>10% off when you spend $100 or more</Description>
        <Code>TENOFF</Code>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <TermsAndConditions>Cannot be combined with any other offer.</TermsAndConditions>
        <StartDate>null</StartDate>
        <EndDate>null</EndDate>
        <TrackingUrl>https://t.cfjump.com/0/c/1</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/c/1" rel="noindex,nofollow"&gt;10% off when you spend $100 or more&lt;/a&gt;</TrackingCode>
    </Coupon>
    <Coupon>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <Description>20% off when you spend $300 or more</Description>
        <Code>TWENTYOFF</Code>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <TermsAndConditions>Cannot be combined with any other offer.</TermsAndConditions>
        <StartDate>null</StartDate>
        <EndDate>null</EndDate>
        <TrackingUrl>https://t.cfjump.com/0/c/2</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/c/2" rel="noindex,nofollow"&gt;20% off when you spend $300 or more&lt;/a&gt;</TrackingCode>
    </Coupon>
    <Coupon>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <MerchantId>1</MerchantId>
        <MerchantName>Example Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <Description>30% off when you spend $500 or more</Description>
        <Code>THIRTYOFF</Code>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <TermsAndConditions>Cannot be combined with any other offer.</TermsAndConditions>
        <StartDate>null</StartDate>
        <EndDate>null</EndDate>
        <TrackingUrl>https://t.cfjump.com/0/c/3</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/c/3" rel="noindex,nofollow"&gt;30% off when you spend $500 or more&lt;/a&gt;</TrackingCode>
    </Coupon>
</CouponArray>

Related Links