Catalog Search

The Catalog Search web service returns product catalogs for a selected category ordered by product popularity. This web service will help you bring the latest popular products to your users.

Request Parameters

The Catalog Search web service supports the following request parameters:

Name Type Summary
category numeric (required) The unique id of the category to search in. Category ids can be found from the category search web service.
start numeric (optional) default 1 The index number iof the first catalog to return. It must be higher than 0 and less than the total number of catalogs available.
results integer (optional) The number of Catalogs to return. It must be higher than 0 and less than or equal to 50.
refinement string (optional) The refinement value to use for this catalog.

Response Elements

Top Level Element

Name Summary
CatalogSearch Contains Catalog and Refinements elements. Has the attributes:

  • catid: The unique ID of the category.
  • country: The country of the catalog.
  • firstResultPosition: The position of the first catalog returned.
  • totalResultsAvailable: The total number of catalogs available for the category.

Catalog elements

Name Summary
CatalogID Contains the unique identifier of the catalog. Can be used with related web services to retrieve more additional information for the catalog.
Title Contains the product name of the catalog.
Brand Contains the brand name of the catalog.
LowestPrice Contains the lowest price of the catalog.
HighestPrice Contains the highest price of the catalog.

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.

Sample Response

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

<CatalogSearch catid="122701" country="uk" firstResultPosition="1" totalResultsAvailable="596" totalResultsReturned="20">
−
<Catalog>
<CatalogID>122701-19582042</CatalogID>
<Title>Samsung  YP-U4JAB (4GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19570072</CatalogID>
<Title>Apple iPod classic (120GB, Black)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19570178</CatalogID>
<Title>Apple  iPod nano (8GB, 4th Generation, Black)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-18476969</CatalogID>
<Title>Creative  ZEN (4GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-18994292</CatalogID>
<Title>Apple iPod Touch (32 GB, 1st Generation)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19583165</CatalogID>
<Title>Apple  iPod touch (8GB, 2nd Generation)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-18380481</CatalogID>
<Title>Apple iPod Touch (16 GB, 1st Generation)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19575605</CatalogID>
<Title>Sony NWZ S639F (16 GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-12320690</CatalogID>
<Title>Apple  iPod photo (60GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-18477779</CatalogID>
<Title>Creative  ZEN (16 GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19433563</CatalogID>
<Title>Creative Zen Stone Plus (4GB, Pink)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-18380480</CatalogID>
<Title>Apple iPod iPod touch (8GB, 1st Generation)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-18412567</CatalogID>
<Title>SanDisk Sansa Clip (2GB, Blue)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-17251994</CatalogID>
<Title>Apple  iPod nano (4GB, 2nd Generation, Silver)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19565044</CatalogID>
<Title>Sony  NWZ-E436 (4GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19544358</CatalogID>
<Title>Samsung YP S3 (8GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19560757</CatalogID>
<Title>Creative Zen Mozaic (8GB)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19583172</CatalogID>
<Title>Apple  iPod touch (32 GB, 2nd Generation)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-15394016</CatalogID>
<Title>Apple  iPod (60GB, 5th Generation, White)</Title>
</Catalog>
−
<Catalog>
<CatalogID>122701-19589331</CatalogID>
<Title>SanDisk  Sansa Clip (8GB)</Title>
</Catalog>
</CatalogSearch>

Related Web Services

Catalog Reviews and Catalog Listings