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.
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.
AffiliateId	Integer	The ID of the affiliate that this coupon is assigned to.
AffiliateContactName	String	The contact name of the affiliate that this coupon is assigned to.
AffiliateBusinessName	String	The business name of the affiliate that this coupon is assigned to.

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",
    "Code": "TENOFF",
    "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"
}

<Coupon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <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>
    <Code>TENOFF</Code>
    <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>
</Coupon>

Related Links

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