Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

DataFeed Type

Represents a single data feed.


Properties

Name Type Description
Id
Integer The ID of the data feed.
DateCreated
DateTime The date and time that the data feed was created.
DateModified
DateTime The date and time that the data feed (or one of its items) was last modified.
MerchantId
Integer The ID of the merchant who created this data feed.
MerchantName
String The campaign name of the merchant who created this data feed.
MerchantAvatarUrl
Url The address of the avatar image of the merchant who created this data feed.
Name
String The name of the data feed.
Type
DataFeedType The type of the data feed.
ItemsCount
Integer The number of items in the data feed.
Items
DataFeedItemArray Zero or more items that are part of the data feed.

Remarks

If you use the GET DataFeeds function to retrieve multiple data feeds, then the Items property of each DataFeed object will be NULL.

If you use the GET DataFeeds/[id] function to retrieve a single data feed, then the Items property will contain a DataFeedItemArray object.

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",
    "Name": "Example Pty Ltd Product Feed",
    "Type": "Product Catalogue",
    "ItemsCount": 3,
    "Items":
    [
        {
            "Id": 1,
            "DateCreated": "2000-01-01T00:00:00.000",
            "DateModified": "2000-01-01T00:00:00.000",
            "SKU": "P0001",
            "Name": "100 Piece Puzzle",
            "Category": "Puzzles",
            "Description": "A puzzle featuring a picture of a puppy.",
            "TargetUrl": "https://www.example.com/",
            "ImageUrl": "https://c.cfjump.com/Products/0/1.jpg",
            "Image50Url": "https://c.cfjump.com/Products/0/1@50x50.jpg",
            "Image100Url": "https://c.cfjump.com/Products/0/1@100x100.jpg",
            "Image120Url": "https://c.cfjump.com/Products/0/1@120x120.jpg",
            "Image200Url": "https://c.cfjump.com/Products/0/1@200x200.jpg",
            "Image300Url": "https://c.cfjump.com/Products/0/1@300x300.jpg",
            "Image400Url": "https://c.cfjump.com/Products/0/1@400x400.jpg",
            "Price": "$10",
            "Brand": null,
            "Colour": null,
            "ContentRating": null,
            "Currency": null,
            "DeliveryCost": null,
            "DeliveryTime": null,
            "Features": null,
            "Gender": null,
            "Genre": null,
            "Keywords": null,
            "ModelNumber": null,
            "Platform": null,
            "PriceRrp": null,
            "PriceSale": null,
            "PromoText": null,
            "Size": null,
            "StockLevel": null,
            "SubCategory": null,
            "Custom1": null,
            "Custom2": null,
            "Custom3": null,
            "Custom4": null,
            "TrackingUrl": "https://t.cfjump.com/0/p/1",
            "TrackingCode": "<a href=\"https://t.cfjump.com/0/p/1\" rel=\"noindex,nofollow\">100 Piece Puzzle</a>"
        },
        {
            "Id": 2,
            "DateCreated": "2000-01-01T00:00:00.000",
            "DateModified": "2000-01-01T00:00:00.000",
            "SKU": "P0002",
            "Name": "200 Piece Puzzle",
            "Category": "Puzzles",
            "Description": "A puzzle featuring a picture of a puppy.",
            "TargetUrl": "https://www.example.com/",
            "ImageUrl": "https://c.cfjump.com/Products/0/2.jpg",
            "Image50Url": "https://c.cfjump.com/Products/0/2@50x50.jpg",
            "Image100Url": "https://c.cfjump.com/Products/0/2@100x100.jpg",
            "Image120Url": "https://c.cfjump.com/Products/0/2@120x120.jpg",
            "Image200Url": "https://c.cfjump.com/Products/0/2@200x200.jpg",
            "Image300Url": "https://c.cfjump.com/Products/0/2@300x300.jpg",
            "Image400Url": "https://c.cfjump.com/Products/0/2@400x400.jpg",
            "Price": "$15",
            "Brand": null,
            "Colour": null,
            "ContentRating": null,
            "Currency": null,
            "DeliveryCost": null,
            "DeliveryTime": null,
            "Features": null,
            "Gender": null,
            "Genre": null,
            "Keywords": null,
            "ModelNumber": null,
            "Platform": null,
            "PriceRrp": null,
            "PriceSale": null,
            "PromoText": null,
            "Size": null,
            "StockLevel": null,
            "SubCategory": null,
            "Custom1": null,
            "Custom2": null,
            "Custom3": null,
            "Custom4": null,
            "TrackingUrl": "https://t.cfjump.com/0/p/2",
            "TrackingCode": "<a href=\"https://t.cfjump.com/0/p/2\" rel=\"noindex,nofollow\">200 Piece Puzzle</a>"
        },
        {
            "Id": 3,
            "DateCreated": "2000-01-01T00:00:00.000",
            "DateModified": "2000-01-01T00:00:00.000",
            "SKU": "P0003",
            "Name": "300 Piece Puzzle",
            "Category": "Puzzles",
            "Description": "A puzzle featuring a picture of a puppy.",
            "TargetUrl": "https://www.example.com/",
            "ImageUrl": "https://c.cfjump.com/Products/0/3.jpg",
            "Image50Url": "https://c.cfjump.com/Products/0/3@50x50.jpg",
            "Image100Url": "https://c.cfjump.com/Products/0/3@100x100.jpg",
            "Image120Url": "https://c.cfjump.com/Products/0/3@120x120.jpg",
            "Image200Url": "https://c.cfjump.com/Products/0/3@200x200.jpg",
            "Image300Url": "https://c.cfjump.com/Products/0/3@300x300.jpg",
            "Image400Url": "https://c.cfjump.com/Products/0/3@400x400.jpg",
            "Price": "$20",
            "Brand": null,
            "Colour": null,
            "ContentRating": null,
            "Currency": null,
            "DeliveryCost": null,
            "DeliveryTime": null,
            "Features": null,
            "Gender": null,
            "Genre": null,
            "Keywords": null,
            "ModelNumber": null,
            "Platform": null,
            "PriceRrp": null,
            "PriceSale": null,
            "PromoText": null,
            "Size": null,
            "StockLevel": null,
            "SubCategory": null,
            "Custom1": null,
            "Custom2": null,
            "Custom3": null,
            "Custom4": null,
            "TrackingUrl": "https://t.cfjump.com/0/p/3",
            "TrackingCode": "<a href=\"https://t.cfjump.com/0/p/3\" rel=\"noindex,nofollow\">300 Piece Puzzle</a>"
        }
    ]
}
<DataFeed 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>
    <Name>Example Pty Ltd Product Feed</Name>
    <Type>Product Catalogue</Type>
    <ItemsCount>3</ItemsCount>
    <Items>
        <DataFeedItem>
            <Id>1</Id>
            <DateCreated>2000-01-01T00:00:00.000</DateCreated>
            <DateModified>2000-01-01T00:00:00.000</DateModified>
            <SKU>P0001</SKU>
            <Name>100 Piece Puzzle</Name>
            <Category>Puzzles</Category>
            <Description>A puzzle featuring a picture of a puppy.</Description>
            <TargetUrl>https://www.example.com/</TargetUrl>
            <ImageUrl>https://c.cfjump.com/Products/0/1.jpg</ImageUrl>
            <Image50Url>https://c.cfjump.com/Products/0/1@50x50.jpg</Image50Url>
            <Image100Url>https://c.cfjump.com/Products/0/1@100x100.jpg</Image100Url>
            <Image120Url>https://c.cfjump.com/Products/0/1@120x120.jpg</Image120Url>
            <Image200Url>https://c.cfjump.com/Products/0/1@200x200.jpg</Image200Url>
            <Image300Url>https://c.cfjump.com/Products/0/1@300x300.jpg</Image300Url>
            <Image400Url>https://c.cfjump.com/Products/0/1@400x400.jpg</Image400Url>
            <Price>$10</Price>
            <Brand i:nil="true" />
            <Colour i:nil="true" />
            <ContentRating i:nil="true" />
            <Currency i:nil="true" />
            <DeliveryCost i:nil="true" />
            <DeliveryTime i:nil="true" />
            <Features i:nil="true" />
            <Gender i:nil="true" />
            <Genre i:nil="true" />
            <Keywords i:nil="true" />
            <ModelNumber i:nil="true" />
            <Platform i:nil="true" />
            <PriceRrp i:nil="true" />
            <PriceSale i:nil="true" />
            <PromoText i:nil="true" />
            <Size i:nil="true" />
            <StockLevel i:nil="true" />
            <SubCategory i:nil="true" />
            <Custom1 i:nil="true" />
            <Custom2 i:nil="true" />
            <Custom3 i:nil="true" />
            <Custom4 i:nil="true" />
            <TrackingUrl>https://t.cfjump.com/0/p/1</TrackingUrl>
            <TrackingCode>&lt;a href="https://t.cfjump.com/0/p/1" rel="noindex,nofollow"&gt;100 Piece Puzzle&lt;/a&gt;</TrackingCode>
        </DataFeedItem>
        <DataFeedItem>
            <Id>2</Id>
            <DateCreated>2000-01-01T00:00:00.000</DateCreated>
            <DateModified>2000-01-01T00:00:00.000</DateModified>
            <SKU>P0002</SKU>
            <Name>200 Piece Puzzle</Name>
            <Category>Puzzles</Category>
            <Description>A puzzle featuring a picture of a puppy.</Description>
            <TargetUrl>https://www.example.com/</TargetUrl>
            <ImageUrl>https://c.cfjump.com/Products/0/2.jpg</ImageUrl>
            <Image50Url>https://c.cfjump.com/Products/0/2@50x50.jpg</Image50Url>
            <Image100Url>https://c.cfjump.com/Products/0/2@100x100.jpg</Image100Url>
            <Image120Url>https://c.cfjump.com/Products/0/2@120x120.jpg</Image120Url>
            <Image200Url>https://c.cfjump.com/Products/0/2@200x200.jpg</Image200Url>
            <Image300Url>https://c.cfjump.com/Products/0/2@300x300.jpg</Image300Url>
            <Image400Url>https://c.cfjump.com/Products/0/2@400x400.jpg</Image400Url>
            <Price>$15</Price>
            <Brand i:nil="true" />
            <Colour i:nil="true" />
            <ContentRating i:nil="true" />
            <Currency i:nil="true" />
            <DeliveryCost i:nil="true" />
            <DeliveryTime i:nil="true" />
            <Features i:nil="true" />
            <Gender i:nil="true" />
            <Genre i:nil="true" />
            <Keywords i:nil="true" />
            <ModelNumber i:nil="true" />
            <Platform i:nil="true" />
            <PriceRrp i:nil="true" />
            <PriceSale i:nil="true" />
            <PromoText i:nil="true" />
            <Size i:nil="true" />
            <StockLevel i:nil="true" />
            <SubCategory i:nil="true" />
            <Custom1 i:nil="true" />
            <Custom2 i:nil="true" />
            <Custom3 i:nil="true" />
            <Custom4 i:nil="true" />
            <TrackingUrl>https://t.cfjump.com/0/p/2</TrackingUrl>
            <TrackingCode>&lt;a href="https://t.cfjump.com/0/p/2" rel="noindex,nofollow"&gt;200 Piece Puzzle&lt;/a&gt;</TrackingCode>
        </DataFeedItem>
        <DataFeedItem>
            <Id>3</Id>
            <DateCreated>2000-01-01T00:00:00.000</DateCreated>
            <DateModified>2000-01-01T00:00:00.000</DateModified>
            <SKU>P0003</SKU>
            <Name>300 Piece Puzzle</Name>
            <Category>Puzzles</Category>
            <Description>A puzzle featuring a picture of a puppy.</Description>
            <TargetUrl>https://www.example.com/</TargetUrl>
            <ImageUrl>https://c.cfjump.com/Products/0/3.jpg</ImageUrl>
            <Image50Url>https://c.cfjump.com/Products/0/3@50x50.jpg</Image50Url>
            <Image100Url>https://c.cfjump.com/Products/0/3@100x100.jpg</Image100Url>
            <Image120Url>https://c.cfjump.com/Products/0/3@120x120.jpg</Image120Url>
            <Image200Url>https://c.cfjump.com/Products/0/3@200x200.jpg</Image200Url>
            <Image300Url>https://c.cfjump.com/Products/0/3@300x300.jpg</Image300Url>
            <Image400Url>https://c.cfjump.com/Products/0/3@400x400.jpg</Image400Url>
            <Price>$20</Price>
            <Brand i:nil="true" />
            <Colour i:nil="true" />
            <ContentRating i:nil="true" />
            <Currency i:nil="true" />
            <DeliveryCost i:nil="true" />
            <DeliveryTime i:nil="true" />
            <Features i:nil="true" />
            <Gender i:nil="true" />
            <Genre i:nil="true" />
            <Keywords i:nil="true" />
            <ModelNumber i:nil="true" />
            <Platform i:nil="true" />
            <PriceRrp i:nil="true" />
            <PriceSale i:nil="true" />
            <PromoText i:nil="true" />
            <Size i:nil="true" />
            <StockLevel i:nil="true" />
            <SubCategory i:nil="true" />
            <Custom1 i:nil="true" />
            <Custom2 i:nil="true" />
            <Custom3 i:nil="true" />
            <Custom4 i:nil="true" />
            <TrackingUrl>https://t.cfjump.com/0/p/3</TrackingUrl>
            <TrackingCode>&lt;a href="https://t.cfjump.com/0/p/3" rel="noindex,nofollow"&gt;300 Piece Puzzle&lt;/a&gt;</TrackingCode>
        </DataFeedItem>
    </Items>
</DataFeed>

Related Links