Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

PromotionArray Type

Represents zero or more promotion.

---

Array Elements

Type	Description
Promotion	Represents a single promotion.

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": "Free shipping for June",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/o/1",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/o/1\" referrerpolicy=\"no-referrer-when-downgrade\" rel=\"nofollow sponsored\" onmousedown=\"this.rel = 'nofollow sponsored';\">Free shipping for June</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": "Free shipping for July",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/o/2",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/o/2\" referrerpolicy=\"no-referrer-when-downgrade\" rel=\"nofollow sponsored\" onmousedown=\"this.rel = 'nofollow sponsored';\">Free shipping for July</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": "Free shipping for October",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "TrackingUrl": "https://t.cfjump.com/0/o/3",
        "TrackingCode": "<a href=\"https://t.cfjump.com/0/o/3\" referrerpolicy=\"no-referrer-when-downgrade\" rel=\"nofollow sponsored\" onmousedown=\"this.rel = 'nofollow sponsored';\">Free shipping for October</a>"
    }
]

<PromotionArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <Promotion>
        <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>Free shipping for June</Description>
        <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/o/1</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/o/1" referrerpolicy="no-referrer-when-downgrade" rel="nofollow sponsored" onmousedown="this.rel = 'nofollow sponsored';"&gt;Free shipping for June&lt;/a&gt;</TrackingCode>
    </Promotion>
    <Promotion>
        <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>Free shipping for July</Description>
        <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/o/2</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/o/2" referrerpolicy="no-referrer-when-downgrade" rel="nofollow sponsored" onmousedown="this.rel = 'nofollow sponsored';"&gt;Free shipping for July&lt;/a&gt;</TrackingCode>
    </Promotion>
    <Promotion>
        <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>Free shipping for October</Description>
        <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/o/3</TrackingUrl>
        <TrackingCode>&lt;a href="https://t.cfjump.com/0/o/3" referrerpolicy="no-referrer-when-downgrade" rel="nofollow sponsored" onmousedown="this.rel = 'nofollow sponsored';"&gt;Free shipping for October&lt;/a&gt;</TrackingCode>
    </Promotion>
</PromotionArray>

Related Links

• GET Promotions Function
• GET Promotions/[id] Function
• Promotion Type