CatalogItems

class sp_api.api.CatalogItems(*args, **kwargs)

CatalogItems SP-API Client :link:

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

version: CatalogItemsVersion = '2020-12-01'
search_catalog_items(self, **kwargs) → ApiResponse

Search for and return a list of Amazon catalog items and associated information.

Usage Plans:

Rate (requests per second)

Burst

1

5

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Parameters:

  • keywords (key) – array | * REQUIRED A comma-delimited list of words or item identifiers to search the Amazon catalog for.

  • marketplaceIds (key) – array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers for the request.

  • includedData (key) – array | A comma-delimited string or list of data sets to include in the response. Default: summaries.

  • brandNames (key) – array | A comma-delimited list of brand names to limit the search to.

  • classificationIds (key) – array | A comma-delimited list of classification identifiers to limit the search to.

  • pageSize (key) – integer | Number of results to be returned per page.

  • pageToken (key) – string | A token to fetch a certain page when there are multiple pages worth of results.

  • keywordsLocale (key) – string | The language the keywords are provided in. Defaults to the primary locale of the marketplace.

  • locale (key) – string | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

Return type:

ApiResponse

get_catalog_item(self, asin, **kwargs) → ApiResponse

Retrieves details for an item in the Amazon catalog.

Rate (requests per second)

Burst

5

5

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Parameters:

  • asin – string | * REQUIRED The Amazon Standard Identification Number (ASIN) of the item.

  • marketplaceIds (key) – array | * REQUIRED A comma-delimited list of Amazon marketplace identifiers. Data sets in the response contain data only for the specified marketplaces.

  • includedData (key) – array | A comma-delimited string or list of data sets to include in the response. Default: summaries.

  • locale (key) – string | Locale for retrieving localized summaries. Defaults to the primary locale of the marketplace.

Return type:

ApiResponse