Product Search API v1 reference
Amazon Business API for Products
Overview
An API for getting data about products available to Amazon Business customers. This includes information such as the product title, the merchant selling the product, and the current price.
Version information
Version : 2020-08-26
License information
License : Amazon Software License
License URL : https://aws.amazon.com/asl/
URI scheme
Host : api.business.amazon.com
Schemes : HTTPS
Tags
- products : Get data about a particular product
External Docs
Description : Learn more about the Amazon Business API
URL : http://business-api.amazon.com
Operations
searchProductsRequest
productsRequest
searchOffersRequest
getProductsByAsins
Paths
Search for a list products by keyword, and by other additional filter criteria.
GET /products/2020-08-26/products
Operation: searchProductsRequest
Description
Search for a list of products by querying on their attributes and indexed fields.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | keywords optional | A list of keywords to use to find products based on indexed text data. | string |
| Query | productRegion required | The region where you wish to purchase the product. | enum (ProductRegion) |
| Query | shippingRegion optional | This field determines the region where to ship the product based on the value in the shippingPostalCode. | string |
| Query | locale 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 |
| Query | shippingPostalCode optional | The shipping postal/zip code for customer's request. This parameter doesn't hold geocode. | string |
| Query | facets optional | A list of data facets to include in the response. If you include more than one facet in your request separate each facet value with a comma. | < string > array(csv) |
| Query | pageNumber optional | 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 strictly less than the number of pages returned in the response. | integer |
| Query | pageSize optional | The number of items desired in SearchProductsResult response. If not specified, a default value of 24 will be used. Maximum items that can be fetched in single request is 24. | integer |
| Query | groupTag optional | Group identifier to determine on behalf of which group a customer is performing this operation. This can be found in your Amazon Business account information. Only necessary if the customer account belongs to more than one group. | string |
| Query | category optional | The category is used to refine the keyword search results, a keyword search can give results across multiple categories, if category is provided in request, search results will be limited to given category. It is an optional parameter if not provided in request then search results will be across all possible categories the requested keyword belongs. | string |
| Query | subCategory optional | The search subcategory is used to refine the keyword search results, a keyword search within a particular category can give results across multiple subcategories, if subcategory is provided in request, search results will be limited to given subcategory. It is a optional parameter if not provided in request then search results will be across a particular category if category is provided otherwise results will be across all categories the requested keyword belongs. | string |
| Query | availability optional | The availability is used to refine the keyword search results. It is optional and by default, the search should return the results with the option in stock only. So in the returned result refinement part, there should be two availability Ids. One represents the in stock only, and one represents the include out of stock. If user set availability as include out of stock Id, the result will return products including both in stock and out of stock, which also should be shown in products offers. Same logic applies when user set availability equal to in stock only Id. If a random availability id number is provided, the search should return zero matching products. | string |
| Query | deliveryDay optional | The deliveryDay feature is used to refine the keyword search results. It is optional and by default, the search should return the results with all the available delivery dates. In the returned result refinement part, there should be one Get It Today ID, and one Get It Tomorrow ID. If the user set the deliveryDay with Get It Today ID, then it should return the products that could arrive today, or nothing if no product could arrive today. Same logic goes with Get It Tomorrow ID. | string |
| Query | eligibleForFreeShipping optional | The eligibleForFreeShipping is used to refine the keyword search results. It is optional and by default, the search should return the results with both free shipping by Amazon as well as not free Shipping by Amazon. So in the returned result refinement part, there should be one eligibleForFreeShipping Id. It represents Free Shipping by Amazon. If the user set the eligibleForFreeShipping as this ID, then the result will only return the products who will have free shipping by Amazon. | string |
| Query | primeEligible optional | The prime eligible refinement can be used to filter prime-eligible products. By default, all products (including non-prime eligible) will be returned. | string |
| Query | upc optional | UPC (Universal Product Code) is a type of code printed on retail product packaging to aid in identifying a particular item | string |
| Query | isbn optional | International Standard Book Number of the product | string |
| Query | sku optional | A SKU short for Stock Keeping Unit is a merchant specific identifier for a purchasable good | string |
| Query | ean optional | EAN (European Article Number) is a 13-digit product identifier, often represented on products as a barcode | string |
| Query | partNumber optional | value of the Part Number field on the product. It is a unique number that is issued by manufacturers to identify individual products. | string |
| Query | oemPartNumber optional | The OEM Part Number is the original part number assigned to this part by the vehicle manufacturer. | string |
| Query | searchRefinements optional | A list of search refinements to refine keyword search for relevant results. If you include more than one search refinement in your request separate each refinement value with a comma. | < string > array(csv) |
| Header | x-amz-user-email required | Email address of the user requesting this resource | string |
| Query | inclusionsForProducts optional | A list specifying the product fields you want to be included in your response object. If you do not include this query parameter then all inclusions will be returned. | < string > array(csv) |
| Query | inclusionsForOffers optional | A list specifying the offer fields you want to be included in your response object. If you do not include this query parameter then all inclusions will be returned. | < string > array(csv) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Search success Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-requestid (string) : Unique request reference identifier. | SearchProductsResult |
| 400 | The service was unable to process the request. Reasons for the error are described in an error response object. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-requestid (string) : Unique request reference identifier. | ErrorResponse |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Retrieve product data based on an ASIN identifier.
GET /products/2020-08-26/products/{productId}
Operation: productsRequest
Description
Retrieve a product with its ASIN identifier
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | productId required | The Amazon Standard Item Identifier (ASIN) for the product. | string | - |
| Query | productRegion required | The region where you wish to purchase the product. | enum (ProductRegion) | - |
| Query | shippingRegion optional | This field determines the region where to ship the product based on the value in the shippingPostalCode. | string | - |
| Query | locale 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 | - |
| Query | shippingPostalCode optional | The shipping postal/zip code for customer's request. This parameter does not support geocode. | string | - |
| Query | quantity optional | The number of units the customer intends to purchase. This helps Amazon to determine quantity-based discounts if an eligible offer is present. Defaults to 1. | integer | 1 |
| Query | facets optional | A list of data facets to include in the response. If you include more than one facet in your requst separate each facet value with a comma. | < string > array(csv) | - |
| Header | x-amz-user-email required | Email address of the user requesting this resource | string | - |
| Query | inclusionsForProducts optional | A list specifying the product fields you want to be included in your response object. If you do not include this query parameter then all inclusions will be returned. | < string > array(csv) | - |
| Query | inclusionsForOffers optional | A list specifying the offer fields you want to be included in your response object. If you do not include this query parameter then all inclusions will be returned. | < string > array(csv) | - |
| Query | groupTag optional | Group identifier to determine on behalf of which group a customer is performing this operation. This can be found in your Amazon Business account information. Only necessary if the customer account belongs to more than one group. | string | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Product successfully retrieved | ProductsResult |
| 400 | The service was unable to process your request. Reasons for the error are described in an error response object. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Paginated and filtered search for offers of a specific product.
GET /products/2020-08-26/products/{productId}/offers
Operation: searchOffersRequest
Description
Search for offers of a specific product.
Parameters
| Type | Name | Description | Schema | Default |
|---|---|---|---|---|
| Path | productId required | The Amazon Standard Item Identifier (ASIN) for the product for which to get offers. | string | - |
| Query | productRegion required | The region where you wish to purchase the product. | enum (ProductRegion) | - |
| Query | shippingRegion optional | This field determines the region where to ship the product based on the value in the shippingPostalCode. | string | - |
| Query | locale 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 | - |
| Query | shippingPostalCode optional | The shipping postal/zip code for customer's request. This parameter doesn't hold geocode. | string | - |
| Query | pageNumber optional | 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 strictly less than the number of pages returned in the response. | integer | - |
| Query | pageSize optional | The number of items desired per page in response. If not specified, a default value of 24 will be used. Maximum items that can be fetched in single request is 24. | integer | - |
| Query | groupTag optional | Group identifier to determine on behalf of which group a customer is performing this operation. This can be found in your Amazon Business account information. Only necessary if the customer account belongs to more than one group. | string | - |
| Query | filterIds optional | A list of filter ids to apply to query results. | < string > array(csv) | - |
| Query | quantity optional | The number of units the customer intends to purchase. This helps Amazon to determine quantity-based discounts if an eligible offer is present. Defaults to 1. | integer | 1 |
| Header | x-amz-user-email required | Email address of the user requesting this resource | string | - |
| Query | inclusionsForOffers optional | A list specifying the offer fields you want to be included in your response object. If you do not include this query parameter then all inclusions will be returned. | < string > array(csv) | - |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Search success Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-requestid (string) : Unique request reference identifier. | OffersResult |
| 400 | The service was unable to process the request. Reasons for the error are described in an error response object. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-requestid (string) : Unique request reference identifier. | ErrorResponse |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Result for list of ASIN search.
POST /products/2020-08-26/products/getProductsByAsins
Operation: getProductsByAsins
Description
Retrieve products for the ASIN identifier present in the list of ASINs.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Body | productsByAsins optional | Request object to be used to search a list of asins. | ProductsByAsinsRequest |
| Header | x-amz-user-email required | Email address of the user requesting this resource | string |
| Query | inclusionsForProducts optional | A list specifying the product fields you want to be included in your response object. If you do not include this query parameter then all inclusions will be returned. | < string > array(csv) |
| Query | inclusionsForOffers optional | A list specifying the offer fields you want to be included in your response object. If you do not include this query parameter then all inclusions will be returned. | < string > array(csv) |
| Query | groupTag optional | Group identifier to determine on behalf of which group a customer is performing this operation. This can be found in your Amazon Business account information. Only necessary if the customer account belongs to more than one group. | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Products successfully retrieved | ProductsByAsinsResponse |
| 400 | The service was unable to process your request. Reasons for the error are described in an error response object. | ErrorList |
For additional error status codes, descriptions and schemas, see Error responses and schemas.
Produces
application/json
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid authorization input. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-requestid (string):Unique request reference identifier. | ErrorResponse |
| 403 | 403 can be caused for reasons like Access Denied, Unauthorized, Expired Token, Invalid Signature or Resource Not Found. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-requestid (string):Unique request reference identifier. | ErrorResponse |
| 404 | The resource specified does not exist. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-requestid (string):Unique request reference identifier. | ErrorResponse |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-requestid (string):Unique request reference identifier. | ErrorResponse |
| 500 | Encountered an unexpected condition which prevented the server from fulfilling the request. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-requestid (string):Unique request reference identifier. | ErrorResponse |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-requestid (string):Unique request reference identifier. | ErrorResponse |
Definitions
AsinType
The type of the asin returned in the request. STANDARD asins can be purchased directly. VARIATION_PARENT asins cannot be purchased, but are linked to one or more VARIATION_CHILD asins which can. VARIATION_CHILD asins have specific settings for certain attributes, such as the size and color of a shirt. The VARIATION_CHILD asins can have different prices, and can be offered by different merchants.
Possible values:
- STANDARD
- VARIATION_PARENT
- VARIATION_CHILD
Type : enum
| Value | Description |
|---|---|
| STANDARD | - |
| VARIATION_PARENT | - |
| VARIATION_CHILD | - |
Category
The search category is used to give information about relevant categories a product belongs to, it can be used to limit the results to a particular category in subsequent requests.
| Name | Description | Schema |
|---|---|---|
| displayName required | Display name is used to share more human friendly readable description of category. | string |
| id required | Search category id identifies a search category uniquely within a product region. | string |
ErrorResponse
Response returned when request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| errors optional | List of errors encountered while processing the request. | ErrorList |
ErrorList
A list of errors
Type : < Error > array
Error
Error detail returned as part of error response.
| Name | Description | Schema |
|---|---|---|
| code required | The list of possible error codes which can be returned as part of an error response: Possible values: | enum (Code) |
| message required | A message that describes the error condition. | string |
| details optional | Additional details that can help the caller understand or fix the issue. | string |
BuyingRestriction
If present, this object shows any restriction that would prevent someone from buying this product.
| Name | Description | Schema |
|---|---|---|
| title required | A displayable string which explains the restriction | string |
| type required | The type of buying restrictions that exists for a product. Possible values: | string |
Merchant
Information about the merchant selling the product
| Name | Description | Schema |
|---|---|---|
| merchantId required | The unique id of the merchant selling this product. | string |
| name required | The displayable name of the merchant selling this product | string |
| meanFeedbackRating required | Mean of the total ratings given to the merchant selling this product | number (double) |
| totalFeedbackCount required | Total number of reviews for the merchant selling this product | number (integer) |
Condition
Information about the condition of the product.
| Name | Description | Schema |
|---|---|---|
| conditionValue required | The possible condition of the product being sold by the merchant. Possible values: | ConditionValue |
| conditionNote required | Additional details on the product's condition. | string |
| subCondition required | The possible sub condition of the product being sold by the merchant. Possible values: | SubCondition |
ConditionValue
The possible condition of the product being sold by the merchant.
Possible values:
- NEW
- USED
- COLLECTIBLE
- REFURBISHED
- OTHER
- UNKNOWN
Type : enum
| Value | Description |
|---|---|
| NEW | - |
| USED | - |
| COLLECTIBLE | - |
| REFURBISHED | - |
| OTHER | - |
| UNKNOWN | - |
SubCondition
The possible sub condition of the product being sold by the merchant.
Possible values:
- ACCEPTABLE
- CLUB
- GOOD
- LIKE_NEW
- NEW
- OEM
- OPEN_BOX
- REFURBISHED
- UNKNOWN
- VERY_GOOD
Type : enum
| Value | Description |
|---|---|
| ACCEPTABLE | - |
| CLUB | - |
| GOOD | - |
| LIKE_NEW | - |
| NEW | - |
| OEM | - |
| OPEN_BOX | - |
| REFURBISHED | - |
| UNKNOWN | - |
| VERY_GOOD | - |
Offer
An offer for a product being sold by a merchant. This object contains many of the details a buyer would need to decide on whether to purchase a product.
| Name | Description | Schema |
|---|---|---|
| availability required | How soon the product would be available to be shipped once purchased | string |
| buyingGuidance required | If the company for which this API is being called provides Amazon Business with Guided Buying policies, this property provides information about whether their organization supports the purchase of this product. If this is not configured for the account, we return the value "NONE". Possible values: | enum (BuyingGuidance) |
| buyingRestrictions required | When present, entries in this property describe the reasons a buyer is restricted from buying a product. | < BuyingRestriction > array |
| fulfillmentType required | The fulfillment system to use for a product purchase. Possible values: | enum (FulfillmentType) |
| merchant required | Information about the merchant selling the product | Merchant |
| offerId required | The Amazon offer identifier to use when purchasing this product | string |
| price required | A full description of the price of the product. | Price |
| listPrice required | A full description of the price of the product. | Price |
| productCondition required | The possible condition of the product being sold by the merchant. Possible values: | enum (ProductCondition) |
| productConditionNote required | Additional details on the product's condition | string |
| condition required | Information about the condition of the product. | Condition |
| quantityLimits required | The various quantities of the product that can be purchased in a single order. Some products have both a min and max quantity. | OfferQuantityLimits |
| quantityPrice optional | Provides information about the different prices customer can get for higher quantities. | QuantityPrice |
| taxExclusivePrice required | The price of the product without tax. | TaxExclusivePrice |
| deliveryInformation required | Information regarding the estimated delivery time and delivery price. | string |
OfferQuantityLimits
The various quantities of the product that can be purchased in a single order. Some products have both a min and max quantity.
| Name | Description | Schema |
|---|---|---|
| maxQuantity required | The largest number of products you can buy in an order. | integer (int64) |
| minQuantity required | The smallest number of products you can buy in an order. | integer (int64) |
Money
An object that holds the numerical value and the currency code associated with the money.
| Name | Description | Schema |
|---|---|---|
| amount required | The numerical value of the money | number (double) |
| currencyCode required | The currency code for that price amount, which can depend on the requested locale | string |
Price
A full description of the price of the product.
| Name | Description | Schema |
|---|---|---|
| value required | An object that contains numerical amount value and the currency code. | Money |
| formattedPrice required | A displayable version of the price and currency code | string |
| priceType required | A description of the type of price. Some prices are indicative of special business pricing for a customer. Possible values: | string |
TaxExclusivePrice
The price of the product without tax.
| Name | Description | Schema |
|---|---|---|
| taxExclusiveAmount required | An object that contains numerical amount value and the currency code. | Money |
| displayString required | A displayable message about the tax exclusion. | string |
| formattedPrice required | A displayable version of the price and currency code | string |
| label required | A displayable description of the type of tax exclusion. | string |
EditorialReview
A editorial review data entry for this product.
| Name | Description | Schema |
|---|---|---|
| content required | The editorial review content | string |
| source required | The editorial review content source | string |
Taxonomy
A taxonomy data entry for this product.
| Name | Description | Schema |
|---|---|---|
| taxonomyCode required | The taxonomy code | string |
| title required | A displayable string with the name of product category | string |
| type required | The type of taxonomy standard represented by the code. The taxonomy types supported by Amazon. Possible values: | enum (Type) |
ISBN
International Standard Book Number associated with the product
| Name | Description | Schema |
|---|---|---|
| isbn10 optional | Unique 10-digit ISBN associated with the product | string |
| isbn13 optional | Unique 13-digit long ISBN associated with the product | string |
BookInformation
If applicable, book-specific details for this product.
| Name | Description | Schema |
|---|---|---|
| isbn optional | International Standard Book Number associated with the product | ISBN |
| publicationDate optional | Date when the book was published | string (date-time) |
| publishedLanguage optional | Language of the book | string |
Contributor
A product's contributor entry, depending on the type of product it can be a brand, author, etc.
| Name | Description | Schema |
|---|---|---|
| name optional | Name of the contributor | string |
| roles optional | Roles of the contributor in the context of the product | < string > array |
MediaInformation
If applicable, media type information of the product
| Name | Description | Schema |
|---|---|---|
| editions optional | Available editions of the product | < string > array |
| mediaFormats optional | Available formats of the media product (i.e. illustrated, first print, paperback) | < string > array |
CustomerReviewsSummary
Information on the product's rating count and star rating.
| Name | Description | Schema |
|---|---|---|
| numberOfReviews required | The number of customer reviews of a product. | integer |
| starRating required | The star rating of a product. | number (double) |
DimensionValue
Value of a dimension and its index
exp. {index:0, displayString:red}
| Name | Description | Schema |
|---|---|---|
| index optional | index of the value | integer |
| displayString optional | String of the dimension value in its readable form exp. red, sm, 12-packs | string |
Dimension
Dimension with its index, categorical name in its readable form, and a list of values for this dimension
exp. [{index:0, displayString:color, dimensionValues: [{index:0, displayString:red}, ...]}, ...]
| Name | Description | Schema |
|---|---|---|
| index optional | Index of the dimension | integer |
| displayString optional | Categorical name of the dimension in its readable form exp. color, size | string |
| dimensionValues optional | - | < DimensionValue > array |
VariationValue
Contains index that maps to a dimension and value maps to a dimensionValue to represent the variation properties for a child product
exp. {index:0, value: 0}
| Name | Description | Schema |
|---|---|---|
| index optional | Index of the dimension | integer |
| value optional | Integer value which maps to dimensionValue to indicate the variation property of a child product | integer |
Variation
A child product (variation) that contains its ASIN and a list of variationValues showing its variation properties
exp. [ASIN: B07J3G6312: [{index:0, value: 0}, ...]]
| Name | Description | Schema |
|---|---|---|
| asin optional | ASIN of the child product exp. B07J3G6312 | string |
| variationValues optional | - | < VariationValue > array |
ProductVariations
Variations(Child products) for this products including all of the categorical dimensions and their values. exp.
Dimensions: [{index:0, displayString:color, dimensionValues: [{index:0, displayString:red}, ...]}, ...], Variations: [ASIN: B07J3G6312: [{index:0, value: 0}, ...]]
should be interpret as B07J3G6312: [color: red]
| Name | Description | Schema |
|---|---|---|
| dimensions required | A list of dimensions with their index, categorical names in their readable form, and lists of values for these dimensions exp. [{index:0, displayString:color, dimensionValues: [{index:0, displayString:red}, ...]}, ...] | < Dimension > array |
| variations required | A list of child products (variations) which contain their ASINs and lists of variationValues showing their variation properties exp. [ASIN: B07J3G6312: [{index:0, value: 0}, ...], ...] | < Variation > array |
Products Result
The result of a request for product data
| Name | Description | Schema |
|---|---|---|
| asin required | The Amazon ASIN product identifier | string |
| asinType required | The type of the asin returned in the request. STANDARD asins can be purchased directly. VARIATION_PARENT asins cannot be purchased, but are linked to one or more VARIATION_CHILD asins which can. VARIATION_CHILD asins have specific settings for certain attributes, such as the size and color of a shirt. The VARIATION_CHILD asins can have different prices, and can be offered by different merchants. Possible values: | AsinType |
| signedProductId required | Product id signed with information about the request for which it was returned. | string |
| includedDataTypes required | A list of additional data groups, as specified in the request. Each facet contains a logic grouping of data about the product. | < string, < object > array > map |
| features required | A list descriptive features of the product, typically shown as a bulleted list. | < string > array |
| editorialReviews optional | A list of editorial reviews for the product. We support a list of standardized editorial review types, and this list contains as many as we have for a product. | < EditorialReview > array |
| taxonomies required | A list taxonomy classifications for the product. We support a list of standardized taxonomy types, and this list contains as many as we have for a product. | < Taxonomy > array |
| title required | The title of the product, typically shown at the top of an Amazon product page. | string |
| url required | A URL to the product on the Amazon website | string |
| format required | Type of the product on the Amazon website. For books, this is the binding. | string |
| bookInformation required | If applicable, book-specific details for this product. | BookInformation |
| byLine required | A product's by-line contributor information, depending on the type of product it will contain details for brand, author(s), editors, etc. | < Contributor > array |
| mediaInformation required | If applicable, media type information of the product | MediaInformation |
| productOverview required | General descriptive fields of the product | < string, string > map |
| productDetails required | Nested key/value pairs indicating additional information for product parts | < string, < string, string > map > map |
| productVariations required | Variations(Child products) for this products and dimensions for all variations exp. {dimensions: {color: {0:red, 1:blue, ...}, size: {0:xs, 1:sm, ...}, ...}, variations: {B07J3G6312: [1,0], B07J348978: [0,0], ...}} | ProductVariations |
| customerReviewsSummary required | Information on the product's rating count and star rating. | CustomerReviewsSummary |
| productDescription required | Description for the given product. | string |
QuantityPrice
Provides information about the different prices customer can get for higher quantities.
| Name | Description | Schema |
|---|---|---|
| quantityPriceTiers optional | Collection of quantity price tier. | < QuantityPriceTier > array |
QuantityPriceTier
Quantity Price tier defines the price for items if the quantity being purchased falls within the quantities specified in quantityDisplay field.
| Name | Description | Schema |
|---|---|---|
| quantityDisplay required | A localized string indicating the quantity range for which the price in the tier applies. | string |
| unitPrice required | The in price per unit for the item in this quantity tier. | Money |
| minQuantity optional | [DEPRECATED: please use unitPrice and quantityDisplay instead] The minimum quantity of items that the customer needs to buy to reach this price tier. | integer (int64) |
| price optional | [DEPRECATED: please use unitPrice and quantityDisplay instead] | Price |
| savingMessage optional | [DEPRECATED: please use unitPrice and quantityDisplay instead] The savings message of the tier. Exists only when the tier's price is lower than the basis price of the current buying option. | string |
| taxExclusivePrice optional | [DEPRECATED: please use unitPrice and quantityDisplay instead] | TaxExclusivePrice |
Refinement Result
The data that describes the refinements used to narrow down results. These values remains same for all pages in the result set.
| Name | Description | Schema |
|---|---|---|
| categories required | A list of categories which have matches for the stated search keyword. A category id can sent back in the subsequent request to get a shorter list of more relevant search results. | < Category > array |
| subCategories required | A list of sub categories which have matches for given category. A search subcategory Id should be sent back in the next request to get a shorter list of more relevant products. | < SubCategory > array |
| availabilityOptions required | Two availability ids standing for in stock only and include out of stock would appear in the search refinement. Availability Id should be sent as an parameter in the next request to get a more filtered list of products and the availability filtering should return the products whose offers are aligned with the availability ID request passed. | < Availability > array |
| deliveryDayOptions required | Two delivery day ids standing for Get It Today and Get It by Tomorrow would appear in the search refinement. | < DeliveryDay > array |
| eligibleForFreeShippingOptions required | One eligibleForFreeShippingOption Id would appear in the search refinement. EligibleForFreeShippingOption ID should be sent as an parameter in the next request to get a more filtered list of products and this filtering should return the products that are Free shipping by Amazon. | < EligibleForFreeShipping > array |
| primeEligible required | This can be used as a query param which can be used to fetch only prime eligible items. | < PrimeEligible > array |
GetProductsByAsins Api Search results.
The data that describes the results for your list of asin search.
| Name | Description | Schema |
|---|---|---|
| matchingProductCount required | The number of products which matched your search query. This number can be much larger than the number of matching products you can view. The value same for all the pages in the result set. | integer |
| products required | A list of products that match your search criteria | < ProductsResult > array |
| notFoundAsins required | A list of asin for which their is no product found. | < string > array |
ProductsByAsinsRequest
Request object to be used to search a list of asins.
| Name | Description | Schema |
|---|---|---|
| productIds required | The list of Amazon Standard Item Identifier (ASIN) for the product. The maximum number of asins allowed in each call is 30. | < string > array |
| productRegion required | The region where you wish to purchase the product. | enum (ProductRegion) |
| shippingRegion optional | This field determines the region where to ship the product based on the value in the shippingPostalCode. | string |
| locale 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. Pattern : "^[-_]+$" | string |
| shippingPostalCode optional | The shipping postal/zip code for customer's request. This parameter does not support geocode. | string |
| quantity optional | The number of units the customer intends to purchase. This helps Amazon to determine quantity-based discounts if an eligible offer is present. Defaults to 1. | integer |
| facets optional | A list of data facets to include in the response. If you include more than one facet in your requst separate each facet value with a comma. | < enum (Facets) > array |
Search products Result
The data that describes the results of your search query.
| Name | Description | Schema |
|---|---|---|
| matchingProductCount required | The number of products which matched your search query. This number can be much larger than the number of matching products you can view. The value same for all the pages in the result set. | integer |
| searchRefinements required | Search refinements is used to share the refinements available for search result which can be used in subsequent request to narrow down the results , for example search category is a type of search refinement, if search category refinement is used in request , search results will be limited to given search category. | < SearchRefinementResult > array |
| refinements required | Search refinements is used to share the refinements available for search result which can be used in subsequent request to narrow down the results , for example search category is a type of search refinement, if search category refinement is used in request , search results will be limited to given search category. | RefinementResult |
| numberOfPages required | Number of pages of results. | integer |
| products required | A list of products that match your search criteria | < ProductsResult > array |
SearchRefinementResult
Search refinements is used to share the refinements available for search result which can be used in subsequent request to narrow down the results , for example search category is a type of search refinement, if search category refinement is used in request , search results will be limited to given search category.
| Name | Description | Schema |
|---|---|---|
| selectionType required | SelectionType is used to identify selection allowed for a given refinement, for example MultiSelect allows to search with multiple values of a refinement and InsteadSelect allows to search with only single refinement value | string |
| displayValue required | Human friendly name of a given refinement type | string |
| refinementValues required | RefinementValues holds items for a given refinement, for example if Brand is a refinement then refinementValues will have different brands available for a given product | < RefinementValue > array |
RefinementValue
RefinementValue holds items for a given refinement, for example if Brand is a refinement then refinementValues will have different brands available for a given product
| Name | Description | Schema |
|---|---|---|
| displayName required | Name of the Item in a refinement | string |
| searchRefinementValue required | searchRefinementValue is used to share value that will be used to make search request for a given refinement | string |
SubCategory
The search subcategory is used to give information about relevant search subcategories a product belongs to within a category. It can be used to limit the results to a particular search subcategory in subsequent requests.
| Name | Description | Schema |
|---|---|---|
| displayName required | Display name is used to share more human friendly readable description of sub category. | string |
| id required | The search subcategory id identify a search sub category uniquely across a product region. | string |
Availability
Availability is used to limit the product offers to be in stock only or include out of stock. It can be used to limit the subsequent search requests.
| Name | Description | Schema |
|---|---|---|
| displayName required | Availability display name would be more user friendly to illustrate the meaning of its id. | string |
| id required | Availability id uniquely identify a availability option, client can sent back the id to filter asins belonging to given availability option. | string |
DeliveryDay
The deliveryDay is used to limit the product offers to be Get It Today or Get It by Tomorrow.
| Name | Description | Schema |
|---|---|---|
| displayName required | DeliveryDay display name is used to share more human friendly readable description. | string |
| id required | DeliveryDay id would identify the search regrading to it is Get It Today or Get It by Tomorrow. | string |
EligibleForFreeShipping
The EligibleForFreeShipping is used to limit the product to be Free Shipping by Amazon only. It can be used to limit the subsequent search requests.
| Name | Description | Schema |
|---|---|---|
| displayName required | EligibleForFreeShipping display name is used to share more human friendly readable description. | string |
| id required | EligibleForFreeShipping id would identify the search to be Free Shipping by Amazon only. | string |
PrimeEligible
The prime eligible refinement is used to give information about relevant prime eligible products.
| Name | Description | Schema |
|---|---|---|
| displayName required | The prime eligible refinement is used to give information about relevant prime eligible products. | string |
| id required | Prime eligible id identifies a prime eligible option uniquely. | string |
OffersResult
The data that describes the results of your offer query
| Name | Description | Schema |
|---|---|---|
| offerCount optional | The number of offers for the ASIN, after filters are applied. | integer |
| numberOfPages optional | Number of pages of results. | integer |
| featuredOffer optional | A featured offer that is selected based on eligibility requirements and criteria. | Offer |
| offers optional | List of offers in page. | < Offer > array |
| filterGroups optional | List of filter groups | < OfferFilterGroup > array |
OfferFilterGroup
A grouping of related filters.
| Name | Description | Schema |
|---|---|---|
| displayName optional | Displayable and localized filter group description. | string |
| filters optional | List of filters in this group. | < OfferFilter > array |
OfferFilter
A filter to apply when getting offers for a product.
| Name | Description | Schema |
|---|---|---|
| id optional | Filter identifier. Pass on filterIds request parameter to apply this filter on your search | string |
| displayName optional | Displayable and localized filter description. | string |
BuyingGuidance
If the company for which this API is being called provides Amazon Business with Guided Buying policies, this property provides information about whether their organization supports the purchase of this product. If this is not configured for the account, we return the value "NONE".
Possible values:
- PREFERRED
- RESTRICTED
- BLOCKED
- NONE
- UNKNOWN
Type : enum
| Value | Description |
|---|---|
| PREFERRED | - |
| RESTRICTED | - |
| BLOCKED | - |
| NONE | - |
| UNKNOWN | - |
Type
The type of taxonomy standard represented by the code. The taxonomy types supported by Amazon.
Possible values:
- UNSPSC
- ECLASS
Type : enum
| Value | Description |
|---|---|
| UNSPSC | - |
| ECLASS | - |
ProductCondition
The possible condition of the product being sold by the merchant.
Possible values:
- NEW
- USED
- COLLECTIBLE
- REFURBISHED
- OTHER
- UNKNOWN
Type : enum
| Value | Description |
|---|---|
| NEW | - |
| USED | - |
| COLLECTIBLE | - |
| REFURBISHED | - |
| OTHER | - |
| UNKNOWN | - |
Facets
Type : enum
| Value | Description |
|---|---|
| OFFERS | - |
| IMAGES | - |
Code
The list of possible error codes which can be returned as part of an error response:
Possible values:
- PRODUCT_NOT_FOUND
- PAGE_NOT_FOUND
- INVALID_REQUEST_PARAMETER
- SERVICE_ERROR
- EMAIL_ID_NOT_FOUND
- UNAUTHORIZED
Type : enum
| Value | Description |
|---|---|
| PRODUCT_NOT_FOUND | - |
| PAGE_NOT_FOUND | - |
| INVALID_REQUEST_PARAMETER | - |
| SERVICE_ERROR | - |
| EMAIL_ID_NOT_FOUND | - |
| UNAUTHORIZED | - |
FulfillmentType
The fulfillment system to use for a product purchase.
Possible values:
- AMAZON
- THIRD_PARTY
- OTHER
Type : enum
| Value | Description |
|---|---|
| AMAZON_FULFILLMENT | - |
| MERCHANT_FULFILLMENT | - |
| OTHER | - |
ProductRegion
Type : enum
For use with the operation(s): searchProductsRequest
The region where you wish to purchase the product.
| Value | Description |
|---|---|
| DE | - |
| FR | - |
| UK | - |
| US | - |
| JP | - |
For use with the operation(s): productsRequest, searchOffersRequest
For use with the definition(s): ProductsByAsinsRequest
The region where you wish to purchase the product.
| Value | Description |
|---|---|
| DE | - |
| FR | - |
| UK | - |
| IT | - |
| ES | - |
| US | - |
| CA | - |
| JP | - |
Updated 4 months ago