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",
        "Description": "10% off when you spend $100 or more",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "AffiliateId": 123,
        "AffiliateContactName": "John Smith",
        "AffiliateBusinessName": "Example Pty Ltd"
    },
    {
        "Id": 1,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Description": "20% off when you spend $300 or more",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "AffiliateId": null,
        "AffiliateContactName": null,
        "AffiliateBusinessName": null
    },
    {
        "Id": 1,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Description": "30% off when you spend $500 or more",
        "TargetUrl": "https://www.example.com/",
        "TermsAndConditions": "Cannot be combined with any other offer.",
        "StartDate": null,
        "EndDate": null,
        "AffiliateId": null,
        "AffiliateContactName": null,
        "AffiliateBusinessName": null
    }
]
<PromotionArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <Promotion>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Description>10% off when you spend $100 or more</Description>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <TermsAndConditions>Cannot be combined with any other offer.</TermsAndConditions>
        <StartDate i:nil="true" />
        <EndDate i:nil="true" />
        <AffiliateId>123</AffiliateId>
        <AffiliateContactName>John Smith</AffiliateContactName>
        <AffiliateBusinessName>Example Pty Ltd</AffiliateBusinessName>
    </Promotion>
    <Promotion>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Description>20% off when you spend $300 or more</Description>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <TermsAndConditions>Cannot be combined with any other offer.</TermsAndConditions>
        <StartDate i:nil="true" />
        <EndDate i:nil="true" />
        <AffiliateId i:nil="true" />
        <AffiliateContactName i:nil="true" />
        <AffiliateBusinessName i:nil="true" />
    </Promotion>
    <Promotion>
        <Id>1</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Description>30% off when you spend $500 or more</Description>
        <TargetUrl>https://www.example.com/</TargetUrl>
        <TermsAndConditions>Cannot be combined with any other offer.</TermsAndConditions>
        <StartDate i:nil="true" />
        <EndDate i:nil="true" />
        <AffiliateId i:nil="true" />
        <AffiliateContactName i:nil="true" />
        <AffiliateBusinessName i:nil="true" />
    </Promotion>
</PromotionArray>

Related Links