Getting Started

Generating API Keys

Calling API Functions

JSON or XML

API Call Rate Limits

Affiliate Accounts

Functions

Types

Merchant Accounts

Functions

Types

GET DataFeeds Function

Retrieves an array of data feeds, optionally filtered by one or more properties.

---

Syntax

GET https://api.commissionfactory.com/V1/Affiliate/DataFeeds?apiKey=[apiKey]&merchantId=[merchantId]&merchantName=[merchantName]&type=[type]

Parameters

Name	Type	Description
apiKey Required	String	A valid API key that represents an affiliate account.
merchantId Optional	Integer	If specified, filters results by merchant ID.
merchantName Optional	String	If specified, filters results by merchant name.
type Optional	DataFeedType	If specified, filters results by type.

Return Value

Type	Description
DataFeedArray	Represents zero or more data feeds.

Errors

Error	Description
400 Bad Request	One or more parameters could not be parsed correctly.
401 Unauthorised	The API key is missing, invalid, or for a different account type; or the user account has been suspended or closed.
429 Too Many Requests	The API call rate limit for the user account has been exceeded.
500 Internal Server Error	An unexpected error occurred while processing your request.

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

Request

GET /V1/Affiliate/DataFeeds?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com

GET /V1/Affiliate/DataFeeds?apiKey=ABC123 HTTP/1.1
Accept: application/xml
Host: api.commissionfactory.com

Response

[
    {
        "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": null
    },
    {
        "Id": 2,
        "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 Specials",
        "Type": "Special Offers",
        "ItemsCount": 4,
        "Items": null
    },
    {
        "Id": 5,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "MerchantId": 2,
        "MerchantName": "Sample Pty Ltd",
        "MerchantAvatarUrl": "https://c.cfjump.com/Avatars/0.png",
        "Name": "Sample Pty Ltd Product Feed",
        "Type": "Product Catalogue",
        "ItemsCount": 5,
        "Items": null
    }
]

<DataFeedArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Affiliate">
    <DataFeed>
        <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 i:nil="true" />
    </DataFeed>
    <DataFeed>
        <Id>2</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 Specials</Name>
        <Type>Special Offers</Type>
        <ItemsCount>4</ItemsCount>
        <Items i:nil="true" />
    </DataFeed>
    <DataFeed>
        <Id>3</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <MerchantId>2</MerchantId>
        <MerchantName>Sample Pty Ltd</MerchantName>
        <MerchantAvatarUrl>https://c.cfjump.com/Avatars/0.png</MerchantAvatarUrl>
        <Name>Sample Pty Ltd Product Feed</Name>
        <Type>Product Catalogue</Type>
        <ItemsCount>5</ItemsCount>
        <Items i:nil="true" />
    </DataFeed>
</DataFeedArray>

Related Links

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