Skip to main content

ProductContent

Updated

Access:

Affiliate access, no authentication required.
Frequency limitation(s): 3600 request(s) per hour. 5000 request(s) per day.

Description:

This module retrieves all available advertising content for a given product in a Merchant's datafeed.
 
The potential content to be returned includes:

  • Product Details - All available information from the respective Merchant datafeed, such as name, price, imagery, etc.
  • Ads/Videos - All ads/videos that have been tagged by the Merchant as related/relevant to this particular product (or the brand name or category of this product) are returned. Additionally, ALL text coupon ads for the Merchant are included in the results as well.
  • Related Products - Using historical sales information from the Merchant in question, we perform a lookup of products that customers frequently purchase in tandem with the requested product. All information from the Merchant's datafeed on these related products is returned with your request.

There are several ways to identify what product you want content returned for:

  • First, you can specify a merchant Id and a product SKU: click for an example.
  • Second, you could be more precise and supply the exact datafeed Id (since some Merchants have multiple datafeeds) along with the product SKU: click for an example.
  • Lastly, you could supply an AvantLink product-specific click-through URL in place of any individual Merchant/datafeed/SKU parameters. That URL value will then be parsed to retrieve all of the necessary product identification: click for an example.

 

Supported Output Formats:

  • xml

Parameters:

  • affiliate_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned Affiliate identifier.
  • module
    • Type: string
    • Required: true
    • Description: For this module, specify "ProductContent".
  • website_id
    • Type: integer
    • Required: true
    • Description: An AvantLink assigned affiliate website identifier.
  • app_id
    • Type: integer
    • Required: false
    • Description: The AvantLink assigned identifier for an App Market application. When specified, this will trigger the construction of customized click-through URLs that track back to the particular app for any resulting sales.
  • custom_tracking_code
    • Type: string
    • Required: false
    • Description: A custom string to be appended to AvantLink click-through URLs, for use with your own personal tracking mechanisms.
  • datafeed_id
    • Type: integer
    • Required: false
    • Description: Some Merchants have multiple datafeeds. If you specify the datafeed id it will search that specific datafeed for the specified sku. If not specified the API will search all available merchant datafeeds for the specified sku.
  • merchant_id
    • Type: integer
    • Required: false
    • Description: An AvantLink assigned Merchant identifier.
  • 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.
  • product_url
    • Type: string
    • Required: false
    • Description: Any AvantLink product-specific click-through URL (such as from a datafeed, Product Display Builder, or ProductSearch API tool); the necessary product identification will be parsed out of this URL.
  • sku
    • Type: string
    • Required: false
    • Description: The Merchant's product sku that you would like the content information for.

Related articles