Product Search V3
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: 3.0
- Path: /V3/productSearch
- Schemas: productsearch.xsd, common.xsd
- Markets: All markets
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. It is 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:
|
| 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 response will return products.
When set to 0, the response does not return any products |
| show_refinements | bool (optional) 0 or 1 |
When set to 1, the response will return refinements if they are available.
When set to 0, the response will not return refinements. |
| show_subcategories | bool (optional) 0 or 1 |
When set to 1, the response will return any available subcategories.
When set to 0, the response does not return subcategories. |
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 if there are available subcategories to return. Details of each subcategory are provided below.Attributes:
Categories will only be returned if they are enabled for the client. The element will be empty elsewhere. The response 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:
|
| Products | Contains each individual product offering (list of Product elements). Each Product element contains an Offer element:
Refinements are returned only if they are enabled for the client. The element are empty elsewhere. The response will return a warning if Refinements are disabled in the client profile. |
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
- 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 ipod with the service.
<ProductSearch> <Categories total_subcategories="67"> <SubCategory> <Title>Accessoires GPS</Title> <Value>100304123</Value> <NumberOfProducts>9</NumberOfProducts> </SubCategory> <SubCategory> <Title>Housse / Rangement</Title> <Value>110201</Value> <NumberOfProducts>8</NumberOfProducts> </SubCategory> <SubCategory> <Title>Elément Séparé</Title> <Value>122501</Value> <NumberOfProducts>8</NumberOfProducts> </SubCategory> <SubCategory> <Title>Téléphone portable sans abonnement</Title> <Value>100020213</Value> <NumberOfProducts>7</NumberOfProducts> </SubCategory> <SubCategory> <Title>Jeux &amp;amp;amp;amp;amp;amp;amp;Jouets</Title> <Value>168001</Value> <NumberOfProducts>6</NumberOfProducts> </SubCategory> <SubCategory> <Title>Accessoires multimédia auto</Title> <Value>100085613</Value> <NumberOfProducts>6</NumberOfProducts> </SubCategory> </SubCategory> <SubCategory> <Title>CD</Title> <Value>150701</Value> <NumberOfProducts>3</NumberOfProducts> </SubCategory> <SubCategory> <Title>Encre, Cartouche, Toner</Title> <Value>100005613</Value> <NumberOfProducts>3</NumberOfProducts> </SubCategory> <SubCategory> <Title>Art de la table &amp;amp;amp;amp;amp;amp;amp;de la cuisine</Title> <Value>141601</Value> <NumberOfProducts>1</NumberOfProducts> </SubCategory> <SubCategory> <Title>Football</Title> <Value>164101</Value> <NumberOfProducts>1</NumberOfProducts> </SubCategory> <SubCategory> <Title>Accessoires Moto</Title> <Value>173801</Value> <NumberOfProducts>1</NumberOfProducts> </SubCategory> </Categories> <Products totalResultsReturned="5" firstResultPosition="1" totalResultsAvailable="4887"> <Product> <Offer type="MANUFACTURER_PRODUCTS" id="a601c2dd05dc01d7a4f95463a1ca6dee"> <Title> ALPINE Autoradio CD/MP3 USB iDA-X303 + Clé USB 8 Go USB 2.0 </Title> <Description> Dédié à l&amp;amp;amp;amp;amp;amp;amp;#39;iPod, l&amp;amp;amp;amp;amp;amp;amp;#39;autoradio iDA-X303 surprend par ses fonctionnalités et sa puissance audio. Compati... </Description> <Images> <Image> <Url> http://img.kelkoo.com/fr/medium/036/305/16088800637395628034638347684096305036.jpg </Url> <Height>90</Height> <Width>90</Width> </Image> </Images> <Url> http://fr.shoppingapis.kelkoo.com:10080//ctl/go/sitesearchGo?.ts=1249302536577&amp;amp;amp;amp;amp;amp;amp;.sig=ZlNEb0o54jnDCzP.5A4F9T7CO6k-&amp;amp;amp;amp;amp;amp;amp;offerId=a601c2dd05dc01d7a4f95463a1ca6dee&amp;amp;amp;amp;amp;amp;amp;searchId=17224113191_1249302536572_1398520&amp;amp;amp;amp;amp;amp;amp;affiliationId=222&amp;amp;amp;amp;amp;amp;amp;country=fr&amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;comId=2969601&amp;amp;amp;amp;amp;amp;amp;catId=173101 </Url> <CompareUrl> http://fr.kelkoopartners.net/p-autoradio-et-video-embarquee-173101/alpine-ida-x303-19608762?partnerId=222&amp;amp;amp;amp;amp;amp;amp;partner=test </CompareUrl> <Merchant id="2969601"> <Name>Pixmania</Name> </Merchant> <CatalogID>173101-19608762</CatalogID> <Category id="173101"> <Name>Autoradio et Vidéo embarquée</Name> </Category> <Price currency="eur"> <Price>245.99</Price> <DeliveryCost>9.9</DeliveryCost> <TotalPrice>255.89</TotalPrice> </Price> <ProductClass>0</ProductClass> <Availability>1</Availability> <DeliveryTime>sous 48 heures</DeliveryTime> <Warranty>2 ans</Warranty> <Promo> <Promo> Code KELPIX090801, 8 EUR de réduction à partir de 200 EUR d&amp;amp;amp;amp;amp;amp;amp;#39;achat (Exp 09-08-2009) </Promo> </Promo> <ShopInfo> Code KELPIX090801, 8 EUR de réduction à partir de 200 EUR d&amp;amp;amp;amp;amp;amp;amp;#39;achat (Exp 09-08-2009) </ShopInfo> <OffensiveContent>false</OffensiveContent> <FinancingOption/> </Offer> </Product> <Product> <Offer type="MANUFACTURER_PRODUCTS" id="6317fbfd36a4c73611d5bc337f504073"> <Title>Générique - Dock pour iPod Shuffle</Title> <Description> Dock pour iPod SHUFFLE Le dock pour iPod shuffle se connecte à tous ordinateur par le port USB Parfait pour les voyages ou pour ajouter à vos accessoires actuelles ... </Description> <Images> <Image> <Url> http://img.kelkoo.com/fr/medium/860/866/00110316897238722974198099089074798866860.jpg </Url> <Height>90</Height> <Width>90</Width> </Image> </Images> <Url> http://fr.shoppingapis.kelkoo.com:10080//ctl/go/sitesearchGo?.ts=1249302536579&amp;amp;amp;amp;amp;amp;amp;.sig=IkTOjw_.N3DkNAzmalSGZkD7N60-&amp;amp;amp;amp;amp;amp;amp;offerId=6317fbfd36a4c73611d5bc337f504073&amp;amp;amp;amp;amp;amp;amp;searchId=17224113191_1249302536572_1398520&amp;amp;amp;amp;amp;amp;amp;affiliationId=222&amp;amp;amp;amp;amp;amp;amp;country=fr&amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;comId=9014323&amp;amp;amp;amp;amp;amp;amp;catId=122701 </Url> <Merchant id="9014323"/> <Category id="122701"> <Name>Lecteur MP3 / Multimédia</Name> </Category> − <Price currency="eur"> <Price>14.35</Price> <DeliveryCost>P&amp;amp;amp;amp;amp;amp;amp;P: N.C.</DeliveryCost> <TotalPrice>14.35</TotalPrice> </Price> <ProductClass>0</ProductClass> <Availability>2</Availability> <Promo/> <OffensiveContent>false</OffensiveContent> <FinancingOption/> </Offer> </Product> <Product> <Offer type="MANUFACTURER_PRODUCTS" id="ef3b07576d2d34b7270a7aa834e825bf"> <Title>Apple IPOD NANO V4 8 GO ROSE</Title> <Description> iPod nano incarne les progrès constants effectués par Apple </Description> <Images> <Image> <Url> http://img.kelkoo.com/fr/medium/090/152/00168422642122766599511506984786956152090.jpg </Url> <Height>90</Height> <Width>90</Width> </Image> </Images> <Url> http://fr.shoppingapis.kelkoo.com:10080//ctl/go/sitesearchGo?.ts=1249302536581&amp;amp;amp;amp;amp;amp;amp;.sig=_u8qEsg_.TkzfovIGB21H1RvXfg-&amp;amp;amp;amp;amp;amp;amp;offerId=ef3b07576d2d34b7270a7aa834e825bf&amp;amp;amp;amp;amp;amp;amp;searchId=17224113191_1249302536572_1398520&amp;amp;amp;amp;amp;amp;amp;affiliationId=222&amp;amp;amp;amp;amp;amp;amp;country=fr&amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;comId=7833123&amp;amp;amp;amp;amp;amp;amp;catId=122701 </Url> <Merchant id="7833123"> <Name>Amg-Diffusion</Name> </Merchant> <Category id="122701"> <Name>Lecteur MP3 / Multimédia</Name> </Category> <Price currency="eur"> <Price>153.96</Price> <DeliveryCost>9.0</DeliveryCost> <Taxes> <Tax> <Id>1</Id> <Value>0.01</Value> </Tax> </Taxes> <TotalPrice>162.97</TotalPrice> </Price> <ProductClass>0</ProductClass> <Availability>1</Availability> <DeliveryTime>sous 5 jours</DeliveryTime> <Promo/> <ShopInfo>AMG DIFFUSION</ShopInfo> <OffensiveContent>false</OffensiveContent> <FinancingOption/> </Offer> </Product> <Product> <Offer type="MANUFACTURER_PRODUCTS" id="c3673104f866d055fc6fa5c60f246cb5"> <Title>Apple - iPhone 3GS 32Go Blanc</Title> <Description> - Ecran tactile 3,5&amp;amp;amp;amp;amp;amp;amp;quot; - Appareil photo 3 Mégapixels autofocus et caméra vidéo - iPod 32Go - GPS intégré - 3G+ </Description> <Images> <Image> <Url> http://img.kelkoo.com/fr/medium/680/449/37128899694751152244406936702769449680.jpg </Url> <Height>90</Height> <Width>90</Width> </Image> </Images> <Url> http://fr.shoppingapis.kelkoo.com:10080//ctl/go/sitesearchGo?.ts=1249302536582&amp;amp;amp;amp;amp;amp;amp;.sig=jA8RDWPTaizz3SpQdbxhPChm8L4-&amp;amp;amp;amp;amp;amp;amp;offerId=c3673104f866d055fc6fa5c60f246cb5&amp;amp;amp;amp;amp;amp;amp;searchId=17224113191_1249302536572_1398520&amp;amp;amp;amp;amp;amp;amp;affiliationId=222&amp;amp;amp;amp;amp;amp;amp;country=fr&amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;comId=3660123&amp;amp;amp;amp;amp;amp;amp;catId=100020213 </Url> <Merchant id="3660123"> <Name>espaceSFR.com</Name> </Merchant> <Category id="100020213"> <Name>Téléphone portable sans abonnement</Name> </Category> <Price currency="eur"> <Price>759.0</Price> <DeliveryCost>0</DeliveryCost> <TotalPrice>759.0</TotalPrice> </Price> <ProductClass>0</ProductClass> <Availability>N</Availability> <DeliveryTime>sous 48 heures</DeliveryTime> <Warranty>Garantie 1 an</Warranty> <Promo/> <OffensiveContent>false</OffensiveContent> <FinancingOption/> </Offer> </Product> <Product> <Offer type="MANUFACTURER_PRODUCTS" id="63b2d84a559dbf84effb5f747bb0ad1f"> <Title> Alpine - IVA-W502R - Autoradio DVD/CD/MP3/WMA/AAC/DiVX - iPod - Ecran tactile 17.5cm </Title> <Description> Alpine offre toutes les possibilités de divertissement pour le plaisir de vos passagers. L&amp;amp;amp;amp;amp;amp;amp;#39;IVA-W505R/-W502R vous permet de lire des DVD et d&amp;amp;amp;amp;amp;amp;amp;#39;utiliser d&amp;amp;amp;amp;amp;amp;amp;#39;autres sources ... </Description> <Images> <Image> <Url> http://img.kelkoo.com/fr/medium/518/175/00134763368200988231953226095928219175518.jpg </Url> <Height>90</Height> <Width>90</Width> </Image> </Images> <Url> http://fr.shoppingapis.kelkoo.com:10080//ctl/go/sitesearchGo?.ts=1249302536583&amp;amp;amp;amp;amp;amp;amp;.sig=4RArsniDmqVa36oIwdwd8BR0GAM-&amp;amp;amp;amp;amp;amp;amp;offerId=63b2d84a559dbf84effb5f747bb0ad1f&amp;amp;amp;amp;amp;amp;amp;searchId=17224113191_1249302536572_1398520&amp;amp;amp;amp;amp;amp;amp;affiliationId=222&amp;amp;amp;amp;amp;amp;amp;country=fr&amp;amp;amp;amp;amp;amp;amp;wait=true&amp;amp;amp;amp;amp;amp;amp;comId=7859923&amp;amp;amp;amp;amp;amp;amp;catId=173101 </Url> <Merchant id="7859923"> <Name>ADN-Autoradio</Name> </Merchant> <Category id="173101"> <Name>Autoradio et Vidéo embarquée</Name> </Category> <Price currency="eur"> <Price>890.0</Price> <DeliveryCost>7.95</DeliveryCost> <TotalPrice>897.95</TotalPrice> </Price> <ProductClass>0</ProductClass> <Availability>1</Availability> <DeliveryTime>24 à 48 heures</DeliveryTime> <Warranty>1 An</Warranty> <Promo> <Promo> Code , 3% de reduction avec le code promo Kelkoo03 (Exp ) </Promo> </Promo> <ShopInfo> Code , 3% de reduction avec le code promo Kelkoo03 (Exp ) </ShopInfo> <OffensiveContent>false</OffensiveContent> <FinancingOption/> </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>