CatalogItems V2020_12_01

class sp_api.api.CatalogItemsV20201201(marketplace: ~sp_api.base.marketplaces.Marketplaces = Marketplaces.US, *, refresh_token=None, account='default', credentials=None, restricted_data_token=None, proxies=None, verify=True, timeout=None, version=None, credential_providers=None, auth_token_client_class=<class 'sp_api.auth.access_token_client.AccessTokenClient'>)

CatalogItems SP-API Client :link:

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

search_catalog_items(self, **kwargs) → ApiResponse

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

Usage Plan:

Rate (requests per second)

Burst

2

2

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

CatalogItemsV20201201().search_catalog_items()
Parameters:

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

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

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

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

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

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

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

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

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

Returns:

ApiResponse

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

Retrieves details for an item in the Amazon catalog.

Usage Plan:

Rate (requests per second)

Burst

2

2

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

CatalogItemsV20201201().get_catalog_item("value")
Parameters:

  • asin – object | required The Amazon Standard Identification Number (ASIN) of the item.

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

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

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

Returns:

ApiResponse