Skip to main content

ConfigureDatafeed

Updated

Access:

Affiliate authentication required, secure connections (https://) only.
Frequency limitation(s): 250 request(s) per day.

Description:

 

This module allows for the configuration of raw datafeed file subscriptions (Merchant product listings) for Affiliates.

All functionality that is available through the normal Affiliate configuration interface is supported with one exception: customizable fields/columns are not supported - instead, any subscription configured using this API module will return all datafeed fields/columns.

For reference, a sample PHP script has been developed that uses this module to create one raw datafeed file subscription for every active Merchant under a given Affiliate account. This is not necessarily the recommended usage, but does serve to demonstrate the capabilities of this and related API modules. [view source code]

 

Supported Output Formats:

  • csv
  • tab
  • xml

Parameters:

  • affiliate_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned Affiliate identifier.
  • auth_key
    • Type: string
    • Required: true
    • Description: The AvantLink assigned authentication key for a particular Affiliate or Merchant. This is a randomly generated, 32-character, mixed alphanumeric string.
  • datafeed_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned Merchant datafeed identifier, i.e. which datafeed to return product information for.
  • module
    • Type: string
    • Required: true
    • Description: For this module, specify "ConfigureDatafeed".
  • website_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned affiliate website identifier.
  • file_compression
    • Type: string
    • Required: false
    • Description: What compression method, if any, to use for the resulting datafeed file (none, gz, or zip); default = none.
  • file_format
    • Type: string
    • Required: false
    • Description: What file format to use for the resulting datafeed file (csv, tab, or xml); default = tab.
  • on_sale_level
    • Type: integer
    • Required: false
    • Description: A numeric value representing how deeply discounted a product must be for inclusion in the datafeed results. Leave empty or 0 to include all products, regardless of whether they are on sale or not. Specify a value of 100 to restrict to only on-sale products, or 100 + discount to filter further, i.e. 110 includes only products with at least a 10% sale price discount.
  • output
    • Type: string
    • Required: false
    • Description: The specific output format you wish to receive results in. Possible values include: csv (comma-separated text), html, js (javascript document.write statements), rss, tab (tab-delimited text), and xml (the default). Individual modules may not support all output methods.
  • subscription_id
    • Type: integer
    • Required: false
    • Description: An identifier for an existing datafeed subscription, if editing rather than creating a new subscription. Leave empty or specify a value of 0 to create a new datafeed subscription.
  • subscription_name
    • Type: string
    • Required: false
    • Description: The name to use for this datafeed subscription; if left empty a name will be generated automatically.
  • taxonomy_filter_type
    • Type: string
    • Required: false
    • Description: The type of taxonomy-related filtering to apply to this datafeed subscription (e.g. Category, SubCategory, Product Group, or Merchant).
  • taxonomy_filter_values
    • Type: string
    • Required: false
    • Description: Pipe-delimited list of values to filter by in conjunction with the "taxonomy_filter_type" parameter (e.g. Category Ids, SubCategory Ids, Product Group Ids, or Merchant names).

Related articles