GET products/search

Updated on Tue, 2012-02-21

Find relevant products based on queries performed by end-users. To best learn how to use the search API effectively, consult our guide to Using the Product Search API.

Parameters

qrequired

Search query. Should be URL encoded.

Example Values: price:[1.00 to 5.75]

pageoptional

The page number (starting at 1) to return.

Example Values: 10

rppoptional

The number of results to return per page, up to a max of 100.

Example Values: 50

sortoptional

Returns results ordered by the given sort value. Valid options include:

  • DFLT: Default
  • PRLH: Price: Low to High
  • PRHL: Price: High to Low
  • CSLH: Cost: Low to High
  • CSHL: Cost: High to Low
  • PRFT: Profit
  • CAPR: Canadian Priced
  • ASIN: ASI Number
  • SPNM: Supplier Name
  • SPRT: Supplier Rating
  • CASP: Canadian Suppliers
  • PRNM: Product Name
  • PRNB: Product Number
  • PRCF: Confirmed Product
  • PRNW: New Product

Example Values: PRLH

dloptional

Provides a list of relevant search dimensions to help narrow down the current result. Valid options include:

  • category: Return a list of categories.
  • color: Return a list of colors.
  • size: Return a list of sizes.
  • material: Return a list of materials.
  • shape: Return a list of shapes.
  • supplier: Return a list of supplier.

Example Values: supplier,category

callbackoptional

Only available for JSON format. If supplied, the response will use the JSONP format with a callback of the given name.

Resource Information

Requires Authentication?Yes
Response Formatsjson
xml
HTTP MethodsGET