API docs by Redocly

Selling Partner API for Product Type Definitions (2020-09-01)

Download OpenAPI specification:Download

URL: https://sellercentral.amazon.com/gp/mws/contactus.html

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).

For more information, see the Product Type Definitions API Use Case Guide.

definitions

searchDefinitionsProductTypes

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.

query Parameters
keywords
Array of strings

A comma-delimited list of keywords to search product types by.

marketplaceIds
required
Array of strings

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

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

Responses

Response samples

Content type
application/json
{
  • "productTypes": [
    ]
}

getDefinitionsProductType

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.

path Parameters
productType
required
string

The Amazon product type name.

query Parameters
sellerId
string

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
required
Array of strings

A comma-delimited list of Amazon marketplace identifiers for the request. Note: This parameter is limited to one marketplaceId at this time.

productTypeVersion
string
Default: "LATEST"

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
string
Default: "LISTING"
Enum: "LISTING" "LISTING_PRODUCT_ONLY" "LISTING_OFFER_ONLY"

The name of the requirements set to retrieve requirements for.

requirementsEnforced
string
Default: "ENFORCED"
Enum: "ENFORCED" "NOT_ENFORCED"

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
string
Default: "DEFAULT"
Enum: "DEFAULT" "ar" "ar_AE" "de" "de_DE" "en" "en_AE" "en_AU" "en_CA" "en_GB" "en_IN" "en_SG" "en_US" "es" "es_ES" "es_MX" "es_US" "fr" "fr_CA" "fr_FR" "it" "it_IT" "ja" "ja_JP" "nl" "nl_NL" "pl" "pl_PL" "pt" "pt_BR" "pt_PT" "sv" "sv_SE" "tr" "tr_TR" "zh" "zh_CN" "zh_TW"

Locale for retrieving display labels and other presentation details. Defaults to the default language of the first marketplace in the request.

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

Responses

Response samples

Content type
application/json
{
  • "metaSchema": {},
  • "schema": {
    },
  • "requirements": "LISTING",
  • "requirementsEnforced": "ENFORCED",
  • "propertyGroups": {
    },
  • "locale": "en_US",
  • "marketplaceIds": [
    ],
  • "productType": "LUGGAGE",
  • "productTypeVersion": {
    }
}