Catalog Listings V2

The Catalog Listings web service returns the offers for a selected catalog. This web service is a one of our key components in kelkoo and will help you bring price comparison to your site.

You can now use the new V3 Version. Check the documentation

Request Parameters

The Catalog Listing web service supports the following parameters:

Name Type Summary
catalogId numeric (required) The Catalog Id of the Catalog of which to return Offers for. Catalog Id’s can be obtained using Catalog Search or Product Search.
start numeric (optional) default 1 The index number iof the first Offer to return.
results integer (optional) The number of Offers to return.

Paginating

You can limit the number of Offers the service return by using the ‘results’ parameter, and you can control the start index of the first Offer returned by using the start parameter. Use this to build pagination features on your listing result pages.

  • Use the following query to retrieve Offers for Catalog ‘124901-17118932′, a Canon EOS 400D Digial Camera:
    ‘/V2/catalogListings?catalogId=124901-17118932
  • Use the following query to retrieve the first five Offers:
    ‘/V2/catalogListings?catalogId=124901-17118932&results=5′
  • Use the following query to retrieve the next five Offers:
    ‘/V2/catalogListings?catalogId=124901-17118932&start=5&results=5′

Response Elements

Web Service Element

Name Summary
CatalogListings Contains Offer elements. Has the attributes:

  • id: The ID of this catalog
  • numOffers: The number of offers for this catalog

Offer elements

Name Summary
ProductName Contains the product name/title provided by the advertiser.
Summary Contans the marketing text provided by the advertiser.
Url Contains the URL of the offer on the advertiser website.
CompareUrl Contains the URL of the Compare Prices page on the Kelkoo website (case of offer matching with a product)
Merchant Contains the name of the advertiser. Has the attribute:

  • id: Contains the unique identifer of the advertiser.
Price Contains the price of the offer as a decimal value. Has the attribute:

  • currency: Contains the three letter currency code as defined in the ISO 4217 standard
DeliveryCost Contains the delivery cost.
Taxes Contains the list of taxes that apply to this offer:

  • id: The id of the tax
  • description: A description of the tax. This is optional
  • value: The amount
Availability Contains the availability.
Used Contains whether or not the product is new or used.
GridImage Contains the list image url, height and width defined as an image element.
ListImage Contains the list image url, height and width defined as an image element.

Image elements

The image elements describe the url, width and height of an image. We recommend always using the width and height in tags.

Name Summary
Url The image Url.
Width The image width in pixels.
Height The image height in pixels.

Sample Response

The following is a sample response when you search for the catalogID: 16172369 with the service.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CatalogListings firstResultPosition="1" id="16172369" totalResultsAvailable="4" totalResultsReturned="4">
<Offer id="31074122701fr6264050f04d405d06757347dc32b81c4">
<Url>http://fr.shopping.yahooapis.com/ctl/go/sitesearchGo?offerId=31074122701fr6264050f04d405d06757347dc32b81c4&amp;amp;amp;amp;amp;amp;searchId=null&amp;amp;amp;amp;amp;amp;affiliationId=96912377&amp;amp;amp;amp;amp;amp;country=fr&amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;.ts=1166544340940&amp;amp;amp;amp;amp;amp;.sig=fQ6crhRGPtKT.VMx6UOOoVUj3Dg-</Url>
<CompareUrl>http://hifiphotovideo.kelkoo.fr/sbs/122701/16172369.html?partnerId=96912377</CompareUrl>
<ProductName>Refurb iPod nano blanc 1 GB</ProductName>
<Price currency="eur">116.00</Price>
<Taxes>
<Tax>
<Id>1</Id>
<Value>1.0</Value>
</Tax>
</Taxes>
<ListImage>
<Url>URL not found</Url>
<Height>90</Height>
<Width>90</Width>
</ListImage>
<GridImage>
<Url>URL not found</Url>
<Height>90</Height>
<Width>90</Width>
</GridImage>
<Summary>Refurb iPod nano blanc 1 GB - Livraison Gratuite</Summary>
<Merchant id="31074">
<Name>Apple Store Particulier</Name>
</Merchant>
<CatalogID>16172369</CatalogID>
</Offer>
</CatalogListings>

Related Web Services

Catalog Reviews and Catalog Search