Home > Shopping Services > Product Search > Product Search V2

Product Search V2

The Product Search web service returns product offerings for a selected keyword, category and/or merchant. This service is the key component in our shopping web services and it will provide you with a powerful search engine that allow your users to quickly search and browse millions of product offerings from our partners.

Name: Product Search
Version: 2.0
Path: /V2/productSearch
Schemas: productsearch.xsd, common.xsd
Markets: All markets

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

Request Parameters

The Product Search web service supports the folowing request parameters:

Name	Type	Summary
query	string	The keywords to search for. Ex. Sony. the query parameter is optional when using category or refinements.
category	integer (optional)	The category to search in. must be the category ID.
merchantId	integer (optional)	Limit the search to a specific merchant.Merchant ID’s can be obtained from Offer Elements in Product Search and Catalog Listing web services.
max_refines	integer (optional) 0-2000	Specifies the maximum number of refinement values to be returned for each refinement key. (Can only be used when specifying category)
refinement	string (optional)	The refinement value to use in this request. Based on product search behavior. Can only be used when specifying category. Can only be used if enabled in the client profile.
sort	string (optional)	Sort the results by: price_ascending price_descendingtotalprice_ascending totalprice_descending
start	integer (optional) default 1	The starting result position to return.
results	integer (optional)	The number of offers to return
show_products	bool (optional) 0 or 1	When set to 1, the reponse will return products. When set to 0, the reponse will not return any products
show_refinements	bool (optional) 0 or 1	When set to 1, the reponse will return refinements if they are available, if set to 0, the reponse will not return refinements.
show_subcategories	bool (optional) 0 or 1	When set to 1, the reponse will return any available subcategories. If set to 0, the reponse will not return subcategories. Can only be used if enabled in the client profile.

Response Elements

Top level Elements

Name	Summary
Categories	Contains a list of subcategories. Only returned if show_subcategories=1 is specified in the request and there are available subcategories to return. Details of each subcategory are provided below.Attributes: total_subcategories: integer indicating total subcategories returned Categories will only be returned if they are enabled for the client. The element will be empty elsewhere. The reponse will return a warning if categories are disabled in the client profile.
Refinements	Each Refinement element contains a list of RefineValue elements. Only returned if category is specified in the request, there are available Refinements to return and that show_refinements is true.Attributes: label: The display value of the refinement. name: An attribute specifying the display name for the refinement key totalvalues: An attribute specifying the number of values returned for this refinement key
Products	Contains each individual product offering. (list of Product elements). Each Product element contains either a Catalog or an Offer element, and has an attribute named type to indicate whether the enclosed element is a Catalog or an Offer element.Attributes: totalResultsAvailable: The number of query matches in the database totalResultsReturned: The number of query matches returned. This may be lower than the number of results requested if there were fewer total results available firstResultPosition: The position of the first result in the overall search Refinements will only be returned if they are enabled for the client. The element will be empty elsewhere. The reponse will return a warning if Refinements are disabled in the client profile.

Name

Summary

SubCategory Elements

Name	Summary
Title	Contains the display name for the subcategory.
NumberOfProducts	Contains the number of products available for this subcategory.
Value	Contains the category ID for the subcategory that can be used as a value for the category request parameter.

RefineValue Elements

Name	Summary
Title	Contains the display name for the Refinement.
NumberOfProducts	Contains the number of products available for this Refinement.
Value	Contains the value for the Refinement that can be used as a value for the refinement request parameter.

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.
Category	Contains the name of the Category. Has the attribute: id: Contains the unique identifer of the Category.
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.
DeliveryTime	Contains the delivery time.
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.
CatalogID	Contains a Catalog Id if the offer has been matched to a product in our database. The Catalog Id can be used to reviews, specs or listings for the Catalog.

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 ipod with the service.

ProductSearch>
−
<Categories total_subcategories="9">
−
<SubCategory>
<Title>Camcorders</Title>
<Value>123501</Value>
<NumberOfProducts>4</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>Digital Camera Accessories</Title>
<Value>125001</Value>
<NumberOfProducts>38</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>Camcorder Accessories</Title>
<Value>100310423</Value>
<NumberOfProducts>13</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>Mobile Phone Accessories</Title>
<Value>125801</Value>
<NumberOfProducts>6</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>Books</Title>
<Value>100801</Value>
<NumberOfProducts>1</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>Painting &amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp; Decorating</Title>
<Value>136101</Value>
<NumberOfProducts>2</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>Digital Cameras</Title>
<Value>124901</Value>
<NumberOfProducts>19</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>Miscellaneous</Title>
<Value>100353523</Value>
<NumberOfProducts>25</NumberOfProducts>
</SubCategory>
−
<SubCategory>
<Title>SD Cards</Title>
<Value>100294323</Value>
<NumberOfProducts>4</NumberOfProducts>
</SubCategory>
</Categories>
−
<Products firstResultPosition="1" totalResultsAvailable="112" totalResultsReturned="3">
−
<Product type="Offer">
−
<Offer id="7802623124901uk80be61e687a81dae52435224fe41bcd8">
−
<Url>
http://uk.shopping.yahooapis.com/ctl/go/sitesearchGo?.ts=1233070832450&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;.sig=sz2Zviv9NLiLx.rTtoZgWdkPz6Q-&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;offerId=7802623124901uk80be61e687a81dae52435224fe41bcd8&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;searchId=87248117222_1233070832450_1521040997&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;affiliationId=96913978&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;country=uk&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;comId=7802623&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;catId=124901
</Url>
−
<CompareUrl>
http://digitalcameras.kelkoo.co.uk/sbs/124901/18904813.html?partnerId=96913978
</CompareUrl>
<ProductName>Canon EOS 450D Digital SLR Camera (Body Only)</ProductName>
<Price currency="gbp">424.85</Price>
<DeliveryCost>0.0</DeliveryCost>
<DeliveryTime>Usually dispatched within 1 to 2 months</DeliveryTime>
<Availability>Availability: Check Site</Availability>
<Used>false</Used>
−
<ListImage>
<Url>http://img.kelkoo.com/uk/medium/img/no-img.jpg</Url>
<Height>90</Height>
<Width>90</Width>
</ListImage>
−
<GridImage>
<Url>http://img.kelkoo.com/uk/medium/img/no-img.jpg</Url>
<Height>90</Height>
<Width>90</Width>
</GridImage>
−
<Summary>
The EOS 450D blends uncompromising performance with ease of use in a lightweight ergonomic body. Capture your world with a 12.2 Megapixel CMOS sensor and the very ...
</Summary>
−
<Merchant id="7802623">
<Name>Amazon</Name>
</Merchant>
<CatalogID>124901-18904813</CatalogID>
−
<Category id="124901">
<Name>Digital Cameras</Name>
</Category>
</Offer>
</Product>
−
<Product type="Offer">
−
<Offer id="279601124901ukd9cdd4210da01de829d9362cfa09e380">
−
<Url>
http://uk.shopping.yahooapis.com/ctl/go/sitesearchGo?.ts=1233070832453&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;.sig=jhiHjoJptiOb1nUxwkICTVcvMPA-&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;offerId=279601124901ukd9cdd4210da01de829d9362cfa09e380&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;searchId=87248117222_1233070832450_1521040997&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;affiliationId=96913978&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;country=uk&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;comId=279601&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;catId=124901
</Url>
−
<CompareUrl>
http://digitalcameras.kelkoo.co.uk/sbs/124901/18904813.html?partnerId=96913978
</CompareUrl>
<ProductName>Canon EOS 450D (Body only)</ProductName>
<Price currency="gbp">439.00</Price>
<DeliveryCost>0.0</DeliveryCost>
<DeliveryTime>Free shipping</DeliveryTime>
<Availability>Availability: In stock</Availability>
<Used>false</Used>
−
<ListImage>
−
<Url>
http://img.kelkoo.com/uk/medium/533/603/0018231437246245435785402694818851603533.jpg
</Url>
<Height>90</Height>
<Width>90</Width>
</ListImage>
−
<GridImage>
−
<Url>
http://img.kelkoo.com/uk/medium/533/603/0018231437246245435785402694818851603533.jpg
</Url>
<Height>90</Height>
<Width>90</Width>
</GridImage>
−
<Merchant id="279601">
<Name>Jessops</Name>
</Merchant>
<CatalogID>124901-18904813</CatalogID>
−
<Category id="124901">
<Name>Digital Cameras</Name>
</Category>
</Offer>
</Product>
−
<Product type="Offer">
−
<Offer id="8358423124901uk676711b3755fc19bfb041903b98f0c1f">
−
<Url>
http://uk.shopping.yahooapis.com/ctl/go/sitesearchGo?.ts=1233070832453&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;.sig=p7TJliA_q4BaOAQ4G_x7sb1linU-&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;offerId=8358423124901uk676711b3755fc19bfb041903b98f0c1f&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;searchId=87248117222_1233070832450_1521040997&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;affiliationId=96913978&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;country=uk&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;comId=8358423&amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;amp;catId=124901
</Url>
−
<CompareUrl>
http://digitalcameras.kelkoo.co.uk/sbs/124901/18904813.html?partnerId=96913978
</CompareUrl>
−
<ProductName>
Canon EOS 450D + 18-55 IS + 55-250 IS Double Lens...
</ProductName>
<Price currency="gbp">619.99</Price>
<DeliveryCost>0.0</DeliveryCost>
<DeliveryTime>2 to 3 Working days</DeliveryTime>
<Availability>Availability: In stock</Availability>
<Used>false</Used>
−
<ListImage>
−
<Url>
http://img.kelkoo.com/uk/medium/567/699/98185922270260261617276862830140699567.jpg
</Url>
<Height>90</Height>
<Width>90</Width>
</ListImage>
−
<GridImage>
−
<Url>
http://img.kelkoo.com/uk/medium/567/699/98185922270260261617276862830140699567.jpg
</Url>
<Height>90</Height>
<Width>90</Width>
</GridImage>
−
<Summary>
Efficient and enduring, the Canon EOS 450D consistently performs highly. Its fluid design and lightweight body makes the camera an easy part of your life, enabling ...
</Summary>
−
<Merchant id="8358423">
<Name>Trade Cameras</Name>
</Merchant>
<CatalogID>124901-18904813</CatalogID>
−
<Category id="124901">
<Name>Digital Cameras</Name>
</Category>
</Offer>
</Product>
</Products>
−
<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>
</Warnings>
</ProductSearch>

Related Web Services

Catalog Search

Subscribe: Entries | Comments
Kelkoo

Kelkoo operates in 10 European countries and Kelkoo is a one-stop shopping service, which helps shoppers to find, research and buy products online with confidence. We provide shoppers with essential tools to compare prices and product features in seconds. Kelkoo users can save on over 3 million products including major brand names.
Pages
Kelkoo International Sites
- België
- Belgique
- Danmark
- Deutschland
- España
- France
- Italia
- Nederland
- Norge
- Sverige
- United-Kingdom

Kelkoo Developer Network