Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Promotion Type

Represents a single promotion.

---

Properties

Name	Type	Description
Id	Integer	The ID of the promotion.
DateCreated	DateTime	The date and time that the promotion was created.
DateModified	DateTime	The date and time that the promotion was last modified.
MerchantId	Integer	The ID of the merchant who created this promotion.
MerchantName	String	The campaign name of the merchant who created this promotion.
MerchantAvatarUrl	Url	The address of the avatar image of the merchant who created this promotion.
Description	String	The description of the promotion.
TargetUrl	Url	The address of the landing page on the merchant's website.
TermsAndConditions	String	The terms and conditions that apply to the customer.
StartDate	DateTime	The date that the promotion is scheduled to start.
EndDate	DateTime	The date that the promotion is scheduled to end.
TrackingUrl	Url	The tracking link for this promotion, used to keep track of clicks and transactions.
TrackingCode	String	Fully formatted HTML code that can be embedded directly on an affiliate website.

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 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/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 July</a>"
}

<Promotion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <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 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/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 July&lt;/a&gt;</TrackingCode>
</Promotion>

Related Links

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