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.
BannerGroupId	Integer	The ID of the group that the banner belongs to.
BannerGroupName	String	The name of the group that the banner belongs to.
BannerGroupTargetUrl	Url	The address of the landing page on the merchant's website.
Name	String	The name of the banner.
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.
DefaultForSize	Boolean	A flag indicating whether or not this banner is the default for its size.

JSON XML

Example

{
    "Id": 1,
    "DateCreated": "2000-01-01T00:00:00.000",
    "DateModified": "2000-01-01T00:00:00.000",
    "BannerGroupId": 1,
    "BannerGroupName": " Default Group",
    "BannerGroupTargetUrl": "https://www.example.com/",
    "Name": "Banner 1",
    "Size": "Wide Skyscraper",
    "Width": 160,
    "Height": 600,
    "ImageUrl": "https://t.cfjump.com/0/a/1",
    "AltText": "Banner 1",
    "DefaultForSize": true
}

<Banner 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>
    <BannerGroupId>1</BannerGroupId>
    <BannerGroupName> Default Group</BannerGroupName>
    <BannerGroupTargetUrl>https://www.example.com/</BannerGroupTargetUrl>
    <Name>Banner 1</Name>
    <Size>Wide Skyscraper</Size>
    <Width>160</Width>
    <Height>600</Height>
    <ImageUrl>https://t.cfjump.com/0/a/1</ImageUrl>
    <AltText>Banner 1</AltText>
    <DefaultForSize>true</DefaultForSize>
</Banner>

Related Links

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