Catalog Listings V3

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.

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 of the first Offer to return.
results integer (optional) The number of Offers to return.

Pagination

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:
    ‘/V3/catalogListings?catalogId=124901-17118932
  • Use the following query to retrieve the first five Offers:
    ‘/V3/catalogListings?catalogId=124901-17118932&results=5′
  • Use the following query to retrieve the next five Offers:
    ‘/V3/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

  • Common fields are used.
  • All offer types can be contained in this service: offer types

Sample Response

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


<CatalogListings firstResultPosition="1" totalResultsAvailable="1" totalResultsReturned="1">
<Offer type="MANUFACTURER_PRODUCTS" id="a1def8837478df3ecd946d8ab21557c0">
<Title>Apple - NANO 8GO PACK ROSE</Title>
<Description>
Baladeur MP3, photo et vidéo - Seconde génération / Capacité totale de 8 Go / 132 heures de musique MP3 / Compatible MP3, AAC , JPEG et MPEG4 / Fourni avec un chargeur ...
</Description>
<Images>
<Image>
<Url>
http://img.kelkoo.com/fr/medium/069/851/00148354910093830221121249933374490851069.jpg
</Url>
<Height>90</Height>
<Width>90</Width>
</Image>
</Images>
<Url>
http://fr.shoppingapis.kelkoo.com:10080//ctl/go/sitesearchGo?.ts=1249304655848&amp;amp;amp;amp;amp;amp;.sig=g9iQ44uDcrX1ZWYdCs9W5l1MPdk-&amp;amp;amp;amp;amp;amp;offerId=a1def8837478df3ecd946d8ab21557c0&amp;amp;amp;amp;amp;amp;searchId=17224113191_1249304655846_23418986&amp;amp;amp;amp;amp;amp;affiliationId=222&amp;amp;amp;amp;amp;amp;country=fr&amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;comId=210001&amp;amp;amp;amp;amp;amp;catId=122701
</Url>
<CompareUrl>
http://fr.kelkoopartners.net/p-lecteur-mp3-multimedia-122701/apple-ipod-nano-8-go-3eme-generation-rose-18900135?partnerId=222&amp;amp;amp;amp;amp;amp;partner=test
</CompareUrl>
<Merchant id="210001">
<Name>Darty.com</Name>
</Merchant>
<CatalogID>122701-18900135</CatalogID>
<Category id="122701">
<Name>Lecteur MP3 / Multimédia</Name>
</Category>
<Price currency="eur">
<Price>149.79</Price>
<DeliveryCost>0</DeliveryCost>
<Taxes>
<Tax>
<Id>1</Id>
<Value>0.2</Value>
</Tax>
</Taxes>
<TotalPrice>149.98999</TotalPrice>
</Price>
<ProductClass>0</ProductClass>
<Availability>1</Availability>
<DeliveryTime>sous 24 heures</DeliveryTime>
<Warranty>Garantie Darty 1 an pièces et main d&amp;amp;amp;amp;amp;amp;#39;oeuvre</Warranty>
<Promo/>
<OffensiveContent>false</OffensiveContent>
<FinancingOption/>
</Offer>
<Warnings>
<Warning>
The "merchantId" parameter is not given. The default value "-1" is used.
</Warning>
<Warning>
The "logicalType" parameter is not given. The default value "and" is used.
</Warning>
<Warning>
The "start" parameter is not given. The default value "1" is used.
</Warning>
<Warning>
The "results" parameter is not given. The default value "20" is used.
</Warning>
</Warnings>
</CatalogListings>

Related Web Services

Catalog Reviews and Catalog Search