ProductTypeDefinitions#

class sp_api.api.ProductTypeDefinitions(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'>)#

ProductTypeDefinitions SP-API Client :link:

The Selling Partner API for Product Type Definitions provides programmatic access to attribute and data requirements for product types in the Amazon catalog. Use this API to return the JSON Schema for a product type that you can then use with other Selling Partner APIs, such as the Selling Partner API for Listings Items, the Selling Partner API for Catalog Items, and the Selling Partner API for Feeds (for JSON-based listing feeds).

search_definitions_product_types(self, **kwargs) → ApiResponse#

Search for and return a list of Amazon product types that have definitions available.

Usage Plans:

Plan type | Rate (requests per second) | Burst |
—- | —- | —- |

|Default| 5 | 10 | |Selling partner specific| Variable | Variable |

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Examples

literal blocks:

ProductTypeDefinitions().search_definitions_product_types()
Parameters:

  • keywords (key) – object | A comma-delimited list of keywords to search product types. Note: Cannot be used with itemName.

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

  • itemName (key) – object | The title of the ASIN to get the product type recommendation. Note: Cannot be used with keywords.

  • locale (key) – object | The locale for the display names in the response. Defaults to the primary locale of the marketplace.

  • searchLocale (key) – object | The locale used for the keywords and itemName parameters. Defaults to the primary locale of the marketplace.

Returns:

ApiResponse

get_definitions_product_type(self, productType, **kwargs) → ApiResponse#

Retrieve an Amazon product type definition.

Usage Plans:

Plan type | Rate (requests per second) | Burst |
—- | —- | —- |

|Default| 5 | 10 | |Selling partner specific| Variable | Variable |

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](doc:usage-plans-and-rate-limits-in-the-sp-api).

Examples

literal blocks:

ProductTypeDefinitions().get_definitions_product_type("value")
Parameters:

  • productType – object | required The Amazon product type name.

  • sellerId (key) – object | A selling partner identifier. When provided, seller-specific requirements and values are populated within the product type definition schema, such as brand names associated with the selling partner.

  • marketplaceIds (key) – object | required A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time.

  • productTypeVersion (key) – object | The version of the Amazon product type to retrieve. Defaults to “LATEST”,. Prerelease versions of product type definitions may be retrieved with “RELEASE_CANDIDATE”. If no prerelease version is currently available, the “LATEST” live version will be provided.

  • requirements (key) – object | The name of the requirements set to retrieve requirements for.

  • requirementsEnforced (key) – object | Identifies if the required attributes for a requirements set are enforced by the product type definition schema. Non-enforced requirements enable structural validation of individual attributes without all the required attributes being present (such as for partial updates).

  • locale (key) – object | Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.

Returns:

ApiResponse