Selling Partner API for Catalog Items (2022-04-01)

Download OpenAPI specification:Download

The Selling Partner API for Catalog Items provides programmatic access to information about items in the Amazon catalog.

For more information, refer to the Catalog Items API Use Case Guide.

catalog

searchCatalogItems

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

Usage Plans:

Rate (requests per second) Burst
2 2

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the Usage Plans and Rate Limits in the Selling Partner API.

query Parameters
identifiers
Array of strings <= 20 items

A comma-delimited list of product identifiers to search the Amazon catalog for. Note: Cannot be used with keywords.

identifiersType
string
Enum: "ASIN" "EAN" "GTIN" "ISBN" "JAN" "MINSAN" "SKU" "UPC"

Type of product identifiers to search the Amazon catalog for. Note: Required when identifiers are provided.

marketplaceIds
required
Array of strings <= 1 items

A comma-delimited list of Amazon marketplace identifiers for the request.

includedData
Array of strings
Items Enum: "attributes" "dimensions" "identifiers" "images" "productTypes" "relationships" "salesRanks" "summaries" "vendorDetails"

A comma-delimited list of data sets to include in the response. Default: summaries.

locale
string

Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

sellerId
string

A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.

keywords
Array of strings <= 20 items

A comma-delimited list of words to search the Amazon catalog for. Note: Cannot be used with identifiers.

brandNames
Array of strings

A comma-delimited list of brand names to limit the search for keywords-based queries. Note: Cannot be used with identifiers.

classificationIds
Array of strings

A comma-delimited list of classification identifiers to limit the search for keywords-based queries. Note: Cannot be used with identifiers.

pageSize
integer <int32> <= 20
Default: 10

Number of results to be returned per page.

pageToken
string

A token to fetch a certain page when there are multiple pages worth of results.

keywordsLocale
string

The language of the keywords provided for keywords-based queries. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.

header Parameters
Content-Type
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "numberOfResults": 0,
  • "pagination": {
    },
  • "refinements": {
    },
  • "items": [
    ]
}

getCatalogItem

Retrieves details for an item in the Amazon catalog.

Usage Plan:

Rate (requests per second) Burst
2 2

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may observe higher rate and burst values than those shown here. For more information, refer to the Usage Plans and Rate Limits in the Selling Partner API.

path Parameters
asin
required
string

The Amazon Standard Identification Number (ASIN) of the item.

query Parameters
marketplaceIds
required
Array of strings

A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.

includedData
Array of strings
Items Enum: "attributes" "dimensions" "identifiers" "images" "productTypes" "relationships" "salesRanks" "summaries" "vendorDetails"

A comma-delimited list of data sets to include in the response. Default: summaries.

locale
string

Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

header Parameters
Content-Type
string
Value: "application/json"

Responses

Response samples

Content type
application/json
{
  • "asin": "string",
  • "attributes": { },
  • "dimensions": [
    ],
  • "identifiers": [
    ],
  • "images": [
    ],
  • "productTypes": [
    ],
  • "relationships": [
    ],
  • "salesRanks": [
    ],
  • "summaries": [
    ],
  • "vendorDetails": [
    ]
}