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.
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.
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": "Free shipping for July",
    "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"
}

<Promotion 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>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>
    <AffiliateId>123</AffiliateId>
    <AffiliateContactName>John Smith</AffiliateContactName>
    <AffiliateBusinessName>Example Pty Ltd</AffiliateBusinessName>
</Promotion>

Related Links

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