Product Search API privileged fields
Certain Product Search API fields are privileged. By default, the Product Search API response does not include privileged fields. If you would like to receive privileged fields, you need to request access to these fields from Amazon Business.
Privileged fields are enabled at the application ID level.
Privileged fields
The following Product Search API fields are privileged:
Taxonomies
Use taxonomy fields to display classification codes in your application, such as UNSPSC and ECLASS codes for EU:
Name | Description |
---|---|
taxonomies | A list of taxonomy classifications for the product. |
Merchant ID
Use merchant IDs to filter which merchants are displayed in your application based on their ID.
Name | Description |
---|---|
merchantId | The unique ID of the merchant selling the product. |
Media-related fields
If you are creating a marketplace or storefront for media products such as books, you can implement the following fields to display additional information:
Name | Description | |
---|---|---|
editorialReviews | A list of editorial reviews for the product. | |
bookInformation | Book details for a product, if applicable. | |
byline | A product's by-line contributor information such as brand, author, and editor. | |
mediaInformation | If applicable, media type information of the product. | |
format | The type of product on the Amazon Business website. For books, this is the binding. |
Feedback-related fields
Use feedback fields to display aggregate customer ratings of a product, or to access merchant feedback ratings to determine which merchants are displayed in your application.
Name | Description |
---|---|
customerReviewsSummary | Information on the product's rating count and star rating. Note: This field can only be displayed in e-Procurement system use cases. This field is not approved for any other use cases. |
meanFeedbackRating | The mean of the total ratings given to the merchant selling the product. |
totalFeedbackCount | The total number of reviews for the merchant selling the product. |
Requesting access to privileged fields
To receive privileged fields in the API response, follow these steps:
- Review the tables of privileged fields to identify fields that align with your desired use case.
- Contact your Amazon Business Account Executive or technical contact to request access to these fields. When discussing with your Amazon Business contact, provide context on why these fields are required for your use case.
After receiving your request, your Amazon Business contact will review your request to determine your eligibility for receiving your requested fields. Your contact will notify you once the fields are enabled for your application ID and ready to test.
Updated 1 day ago