CatalogItems V2022_04_01

class sp_api.api.CatalogItemsV20220401(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 a list of Amazon catalog items and item-related information. You can search by identifier or by keywords.

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:

CatalogItemsV20220401().search_catalog_items()
Parameters:

  • identifiers (key) – object | A comma-delimited list of product identifiers that you can use to search the Amazon catalog. Note: You cannot include identifiers and keywords in the same request.

  • identifiersType (key) – object | The type of product identifiers that you can use to search the Amazon catalog. Note: identifiersType is required when identifiers is in the request.

  • marketplaceIds (key) – object | required A comma-delimited list of Amazon marketplace identifiers. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

  • includedData (key) – object | A comma-delimited list of datasets to include in the response.

  • locale (key) – object | The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.

  • sellerId (key) – object | A selling partner identifier, such as a seller account or vendor code. Note: Required when identifiersType is SKU.

  • keywords (key) – object | A comma-delimited list of keywords that you can use to search the Amazon catalog. Note: You cannot include keywords and identifiers in the same request.

  • brandNames (key) – object | A comma-delimited list of brand names that you can use to limit the search in queries based on keywords. Note: Cannot be used with identifiers.

  • classificationIds (key) – object | A comma-delimited list of classification identifiers that you can use to limit the search in queries based on keywords. Note: Cannot be used with identifiers.

  • pageSize (key) – object | The number of results to include on each page.

  • pageToken (key) – object | A token that you can use to fetch a specific page when there are multiple pages of results.

  • keywordsLocale (key) – object | The language of the keywords that are included in queries based on keywords. Defaults to the primary locale of the marketplace. Note: Cannot be used with identifiers.

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:

CatalogItemsV20220401().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. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).

  • includedData (key) – object | A comma-delimited list of datasets to include in the response.

  • locale (key) – object | The locale for which you want to retrieve localized summaries. Defaults to the primary locale of the marketplace.

Returns:

ApiResponse