API Explorer
App CenterSolution Provider PortalSupport

searchProductsRequest

get
https://api.business.amazon.com/products/2020-08-26/products

Search for a list of products by querying on their attributes and indexed fields.

Usage Plan:

Rate (requests per second)Burst
.510

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.

🚧

productRegion can be either US or DE to return results for the US and German marketplaces, respectively. Selecting any other region will return an error.

📘

To test this API, populate each required input field with the pre-defined example values.

Query Params
string

A list of keywords to use for finding products based on indexed data.

string
enum
required

The region where the customer wants to purchase the product.

string

This field determines the region where to ship the product based on the value in the shippingPostalCode.

string
required

The locale of the request in the form of an IETF language tag. Each ProductRegion supports one or more locales. This value should comply with java.util.Locale.

string

The shipping postal or zip code for customer's request. This parameter doesn't hold geocode.

facets
array of strings
enum

A list of data facets to include in the response. Separate each facet with a comma.

facets
integer

The zero-based number of the page being requested. If not specified, a default value of 0 will be used. When passed, the value must be equal or greater than zero, and less than the number of pages returned in the response. The maximum number of pages that can be fetched is 13.

integer

The requested number of products per page (default 24). Max 24 without privilege.

string

A value that identifies the group within the business account that a customer belongs to. The customer can set this in Amazon Business account information. GroupTag is necessary only if the account associated with x-amz-user-email belongs to more than one group.

string

This field restricts the returned result to this specified category. Categories can be found under refinements->categories->id of this API call's response. Sample categories: 'Electronics', 'Appliances', or 'Baby'

string

This field restricts the returned result to this specified subcategory ID. Subcategory IDs can be found under refinements->subcategories->id of this API call's response when a category or subcategory is specified. Note: there can be multiple levels of subcategories in a category. Sample subcategory IDs: '4997' or '4799'

string

This field restricts the returned results to one of the following specified availability IDs:
2661600011 (In Stock only)
2661601011 (Include Out of Stock)

string

The deliveryDay feature is used to refine the keyword search results. By default, the search returns results with all the available delivery dates. In the returned result refinement, there should be one 'Get It Today' ID, and one 'Get It Tomorrow' ID. If the customer sets the deliveryDay with 'Get It Today' ID, the results will return products that could arrive today or zero matching if no product could arrive today. If the customer sets the deliveryDay with 'Get It Tomorrow' ID, the results will return products that could arrive tomorrow or zero matching if no product could arrive tomorrow.

string

The eligibleForFreeShipping is used to refine the keyword search results. By default, the search should return results with both 'Free Shipping' and not 'Free Shipping by Amazon Business.' In the returned result refinement, there should be one eligibleForFreeShipping Id. It represents 'Free Shipping by Amazon Business.' If the customer sets the eligibleForFreeShipping as this ID, the result will only return products with 'Free Shipping by Amazon Business.'

string

The prime eligible refinement is used to filter prime eligible products. By default, the search returns results with prime eligible and non-prime eligible products.

string

This field restricts the returned result to this specified Universal Product Code (UPC). UPC is printed on product packaging.

string

This field restricts the returned results to this specified ISBN (International Standard Book Number). ISBN is a 13-digit number that uniquely identifies a book.

string

This field restricts the returned results to this specified Stock Keeping Unit (SKU). SKU is a merchant-specific identifier.

string

This field restricts the returned results to this specified EAN (European Article Number). EAN is a 13-digit product identifier.

string

This field restricts the returned results to this specified part number. Part number is a unique number issued by manufacturers to identify individual products.

string

This field restricts the returned results to this specified OEM (Original Equipment Manufacturer) part number. OEM part number is an identifier that indicates the original manufacturer of the part of the product.

searchRefinements
array of strings

A list of search refinements to refine keyword search for relevant results. Separate each refinement with a comma.

searchRefinements
productFilters
array of strings

A list of filters to filter the results for a product by certain values in the response fields. Input the field name, followed by # and the filter value. Separate filters by commas. Use of filters may result in fewer products returned than expected. The filter is currently only implemented for isCustomQuoteEligible.

productFilters
inclusionsForProducts
array of strings
enum

A list specifying the product fields for inclusion in the response object. Excluding this query parameter returns response with all inclusions except upcValues, eanValues, modelNumber, and manufacturerName.

inclusionsForProducts
inclusionsForOffers
array of strings
enum

A list specifying the offer fields for inclusion in the response object. Excluding this parameter results in response returning all inclusions.

inclusionsForOffers
string
enum

The order in which search results are sorted. If not provided or invalid, defaults to RELEVANCE.

Allowed:
integer
≥ 0

Minimum price used to filter search results. When specified, only products with prices greater than or equal to this value are returned. This value uses the marketplace default currency without decimals or sub-units.

integer
≥ 0

Maximum price used to filter search results. When specified, only products with prices less than or equal to this value are returned. This value uses the marketplace default currency without decimals or sub-units.

Headers
string
required

The email address of the customer requesting this resource.

Responses

Updated about 2 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago