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.
Name	String	The name of the data feed.
Type	DataFeedType	The type of the data feed.
UpdateFrequency	DataFeedUpdateFrequency	The automatic update frequency 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",
    "Name": "Example Pty Ltd Product Feed",
    "Type": "Product Catalogue",
    "UpdateFrequency": "Daily",
    "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://www.example.com/Product1.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
        },
        {
            "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://www.example.com/Product2.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
        },
        {
            "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://www.example.com/Product3.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
        }
    ]
}

<DataFeed 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>
    <Name>Example Pty Ltd Product Feed</Name>
    <Type>Product Catalogue</Type>
    <UpdateFrequency>Daily</UpdateFrequency>
    <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://www.example.com/Product1.jpg</ImageUrl>
            <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" />
        </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://www.example.com/Product2.jpg</ImageUrl>
            <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" />
        </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://www.example.com/Product3.jpg</ImageUrl>
            <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" />
        </DataFeedItem>
    </Items>
</DataFeed>

Related Links

• GET DataFeeds Function
• GET DataFeeds/[id] Function
• DataFeedArray Type
• DataFeedItem Type
• DataFeedItemArray Type
• DataFeedType Enumeration
• DataFeedUpdateFrequency Enumeration