Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET Promotions Function

Retrieves an array of promotions, optionally filtered by one or more properties.

---

Syntax

GET https://api.commissionfactory.com/V1/Affiliate/Promotions?apiKey=[apiKey]&merchantId=[merchantId]&merchantName=[merchantName]

Parameters

Name	Type	Description
apiKey Required	String	A valid API key that represents an affiliate account.
merchantId Optional	Integer	If specified, filters results by merchant ID.
merchantName Optional	String	If specified, filters results by merchant name.

Return Value

Type	Description
PromotionArray	Represents zero or more promotions.

Errors

Error	Description
400 Bad Request	One or more parameters could not be parsed correctly.
401 Unauthorised	The API key is missing, invalid, or for a different account type; or the user account has been suspended or closed.
429 Too Many Requests	The API call rate limit for the user account has been exceeded.
500 Internal Server Error	An unexpected error occurred while processing your request.

JSON XML

Example

Request

GET /V1/Affiliate/Promotions?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com

GET /V1/Affiliate/Promotions?apiKey=ABC123 HTTP/1.1
Accept: application/xml
Host: api.commissionfactory.com

Response

[
    {
        "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/[id] Function
• Promotion Type
• PromotionArray Type