Catalog Items API v2022-04-01 Use Case Guide

API Version: 2022-04-01

What is the Catalog Items API?

Using the Selling Partner API for Catalog Items (Catalog Items API), you can retrieve information about items in the Amazon catalog. Refer to the Catalog Items API Reference for details about API operations and associated data types and schemas.

Key Features

• Retrieve detailed item information: The Catalog Items API provides details about items in the Amazon catalog, such as:

  • Summarized item details
  • Attributes
  • Browse classifications
  • Dimensions
  • Product identifiers
  • Images
  • Sales rankings
  • Relationships

Vendors can retrieve additional vendor-specific details.

• Search by identifiers or keywords. The Catalog Items API allows you to search for Amazon catalog items and associated information either by identifiers (such as UPC or EAN identifiers, up-to 20 per request) or by keywords. The same item details are available when performing a search query or when retrieving items explicitly by ASIN.

To learn more about the terms that are used on this page, refer to Terminology.

🚧

Handling generic JSON schemas in client libraries

If you have generated a client library, it is important to note that Swagger Codegen generates types based on properties defined in the Swagger models, and that Swagger Codegen will produce empty or incomplete types when an object is defined with additionalProperties: true. To handle such objects, use the --import-mappings command-line parameter to map these objects to a generic JSON object type or a custom object type of your choosing.

Example Swagger Codegen input parameters:

C#: --import-mappings ItemAttributes=Newtonsoft.Json.Linq.JObject
Java: --import-mappings ItemAttributes=com.google.gson.JsonObject

Tutorial: Retrieve details for an individual item in the Amazon catalog by its identifier (ASIN)

Use this tutorial to retrieve information about an item in the Amazon catalog for the given ASIN and marketplaces.

Prerequisites

To complete this tutorial, you need:

• Authorization from the Selling Partner for whom you are making calls. Go to Authorizing Selling Partner API applications for more information.

• Approval for the Product Listing role in your developer profile.

• The Product Listing role selected in the App registration page for your application.

Get information about a catalog item

Call the getCatalogItem operation.

Tutorial: Search for one or more items by ASINs or product identifiers

Use this tutorial to retrieve information about multiple items in the Amazon catalog for the supplied ASINs or product identifiers.

Prerequisites

To complete this tutorial, you need:

• Authorization from the Selling Partner for whom you are making calls. Go to Authorizing Selling Partner API applications for more information.

• Approval for the Product Listing role in your developer profile.

• The Product Listing role selected in the App registration page for your application.

Search for items

Call the searchCatalogItems operation.

Tutorial: Search for items by keywords

Search for and return a list of Amazon catalog items and associated information either by identifier or by keywords.

Prerequisites

To successfully complete this tutorial, you must have:

• Authorization from the Selling Partner for whom you are making calls. Go to Authorizing Selling Partner API applications for more information.

• Approval for the Product Listing role in your developer profile.

• The Product Listing role selected in the App registration page for your application.

Search for items

Call the searchCatalogItems operation.

Paging in the response to a search for items in the Amazon catalog

When a call to the searchCatalogItems operation produces a response that exceeds the pageSize, pagination occurs. This means the response is divided into individual pages, where each page is returned in successive calls. To retrieve the next page or the previous page, you must pass the nextToken value or the previousToken value as the pageToken parameter in the next request.

You get the first page of results when you call the searchCatalogItems operation and provide no page token. You then iterate through the rest of the pages using the nextToken page token provided in successive responses.

Page tokens are special values that are decoded to determine which page is requested and how many pages are before or after.

If the next or previous page is not available, the corresponding page token attribute (nextToken or previousToken respectively) will not be present in the pagination object.

Examples

When the response does not exceed the pageSize, there is no pagination, so there is no nextToken or previousToken:

"pagination": {
},

When the response exceeds the pageSize and pagination occurs:

For the first page, there is no previous page, so there is no previousToken:

"pagination": {
  "nextToken": "XXXXXX"
},

For the last page, there is no next page, so there is no nextToken:

"pagination": {
  "previousToken": "XXXXXX"
},

For all other pages:

"pagination": {
  "nextToken": "XXXXXX",
  "previousToken": "XXXXXX"
},

📘

Note

Page tokens are specific to the request. You cannot change the page size on the next request when using a page token.

Even though there can be more than 1,000 ASINs that match the search criteria, the maximum number of results that can be returned and paged through is limited to 1,000. For example, if the caller sets the pageSize to 10, the maximum number of possible pages is 100.