Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

Banner Type

Represents a single banner.

---

Properties

Name	Type	Description
Id	Integer	The ID of the banner.
DateCreated	DateTime	The date and time that the banner was created.
DateModified	DateTime	The date and time that the banner was last modified.
MerchantId	Integer	The ID of the merchant who created this banner.
MerchantName	String	The campaign name of the merchant who created this banner.
MerchantAvatarUrl	Url	The address of the avatar image of the merchant who created this banner.
GroupName	String	The name of the group that the banner belongs to.
Name	String	The name of the banner.
TargetUrl	Url	The address of the landing page on the merchant's website.
Size	BannerSize	The size name of the banner.
Width	Integer	Ths width of the banner.
Height	Integer	The height of the banner.
ImageUrl	Url	The address of the banner image.
AltText	String	The suggested ALT text to use when embedding the banner.
ExpiryDate	DateTime	The date that the banner is scheduled to end.
TrackingUrl	Url	The tracking link for this banner, 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",
    "GroupName": " Default Group",
    "Name": "Banner 1",
    "TargetUrl": "https://www.example.com/",
    "Size": "Full Banner",
    "Width": 468,
    "Height": 60,
    "ImageUrl": "https://t.cfjump.com/a/1/1",
    "AltText": "Example Pty Ltd Banner",
    "ExpiryDate": null,
    "TrackingUrl": "https://t.cfjump.com/0/b/1",
    "TrackingCode": "<a href=\"https://t.cfjump.com/0/b/1\" referrerpolicy=\"no-referrer-when-downgrade\" rel=\"nofollow sponsored\" onmousedown=\"this.rel = 'nofollow sponsored';\"><img style=\"border: none; vertical-align: middle;\" alt=\"Example Pty Ltd Banner\" referrerpolicy=\"no-referrer-when-downgrade\" src=\"https://t.cfjump.com/a/1/1\" /></a>"
}

<Banner 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>
    <GroupName> Default Group</GroupName>
    <Name>Banner 1</Name>
    <TargetUrl>https://www.example.com/</TargetUrl>
    <Size>Full Banner</Size>
    <Width>468</Width>
    <Height>60</Height>
    <ImageUrl>https://t.cfjump.com/a/1/1</ImageUrl>
    <AltText>Example Pty Ltd Banner</AltText>
    <ExpiryDate>null</ExpiryDate>
    <TrackingUrl>https://t.cfjump.com/0/b/1</TrackingUrl>
    <TrackingCode>&lt;a href="https://t.cfjump.com/0/b/1" referrerpolicy="no-referrer-when-downgrade" rel="nofollow sponsored" onmousedown="this.rel = 'nofollow sponsored';"&gt;&lt;img style="border: none; vertical-align: middle;" alt="Example Pty Ltd Banner" referrerpolicy="no-referrer-when-downgrade" src="https://t.cfjump.com/a/1/1" /&gt;&lt;/a&gt;</TrackingCode>
</Banner>

Related Links

• GET Banners Function
• GET Banners/[id] Function
• BannerArray Type
• BannerSize Enumeration