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/Merchant/DataFeeds?apiKey=[apiKey]&type=[type]&updateFrequency=[updateFrequency]

Parameters

Name Type Description
apiKey
Required
String A valid API key that represents a merchant account.
type
Optional
DataFeedType If specified, filters results by type.
updateFrequency
Optional
DataFeedUpdateFrequency If specified, filters results by automatic update frequency.

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.
500 Internal Server Error An unexpected error occured while processing your request.
503 Service Unavailable The API call rate limit for the user account has been exceeded.
NOTE: As of 2019-02-01, the response from the server will change:
429 Too Many Requests

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/Merchant/DataFeeds?apiKey=ABC123 HTTP/1.1
Accept: application/json
Host: api.commissionfactory.com
GET /V1/Merchant/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",
        "Name": "Example Pty Ltd Product Feed",
        "Type": "Product Catalogue",
        "UpdateFrequency": "Daily",
        "ItemsCount": 3,
        "Items": null
    },
    {
        "Id": 2,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Example Pty Ltd Specials",
        "Type": "Special Offers",
        "UpdateFrequency": "Weekly",
        "ItemsCount": 4,
        "Items": null
    },
    {
        "Id": 3,
        "DateCreated": "2000-01-01T00:00:00.000",
        "DateModified": "2000-01-01T00:00:00.000",
        "Name": "Example Pty Ltd Packages",
        "Type": "Product Catalogue",
        "UpdateFrequency": "Manual",
        "ItemsCount": 5,
        "Items": null
    }
]
<DataFeedArray xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://api.commissionfactory.com/V1/Merchant">
    <DataFeed>
        <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 i:nil="true" />
    </DataFeed>
    <DataFeed>
        <Id>2</Id>
        <DateCreated>2000-01-01T00:00:00.000</DateCreated>
        <DateModified>2000-01-01T00:00:00.000</DateModified>
        <Name>Example Pty Ltd Specials</Name>
        <Type>Special Offers</Type>
        <UpdateFrequency>Weekly</UpdateFrequency>
        <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>
        <Name>Example Pty Ltd Packages</Name>
        <Type>Product Catalogue</Type>
        <UpdateFrequency>Manual</UpdateFrequency>
        <ItemsCount>5</ItemsCount>
        <Items i:nil="true" />
    </DataFeed>
</DataFeedArray>

Related Links