Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Coupon Type

Represents a single coupon.

---

Properties

Name	Type	Description
Id	Integer	The ID of the coupon.
DateCreated	DateTime	The date and time that the coupon was created.
DateModified	DateTime	The date and time that the coupon was last modified.
MerchantId	Integer	The ID of the merchant who created this coupon.
MerchantName	String	The campaign name of the merchant who created this coupon.
MerchantAvatarUrl	Url	The address of the avatar image of the merchant who created this coupon.
Description	String	The description of the coupon.
Code	String	The code that the customer enters at the merchant checkout.
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 coupon is scheduled to start.
EndDate	DateTime	The date that the coupon is scheduled to end.
TrackingUrl	Url	The tracking link for this coupon, 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": "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\" referrerpolicy=\"no-referrer-when-downgrade\" rel=\"nofollow sponsored\" onmousedown=\"this.rel = 'nofollow sponsored';\">10% off when you spend $100 or more</a>"
}

<Coupon 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>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" referrerpolicy="no-referrer-when-downgrade" rel="nofollow sponsored" onmousedown="this.rel = 'nofollow sponsored';"&gt;10% off when you spend $100 or more&lt;/a&gt;</TrackingCode>
</Coupon>

Related Links

• GET Coupons Function
• GET Coupons/[id] Function
• CouponArray Type