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.

Request

Path Params

productType

string

required

The Amazon product type name.

Example:

LUGGAGE

Query Params

sellerId

string

optional

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

array[string]

required

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

Example:

["{{MARKET_USA}}"]

productTypeVersion

string

optional

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.

Default:

LATEST

Example:

LATEST

requirements

enum<string>

optional

The name of the requirements set to retrieve requirements for.

Allowed values:

LISTINGLISTING_PRODUCT_ONLYLISTING_OFFER_ONLY

Default:

LISTING

Example:

LISTING

requirementsEnforced

enum<string>

optional

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

Allowed values:

ENFORCEDNOT_ENFORCED

Default:

ENFORCED

Example:

ENFORCED

locale

enum<string>

optional

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

Allowed values:

DEFAULTarar_AEdede_DEenen_AEen_AUen_CAen_GBen_INen_SGen_USeses_ESes_MXes_USfrfr_CAfr_FRitit_ITjaja_JPnlnl_NLplpl_PLptpt_BRpt_PTsvsv_SEtrtr_TRzhzh_CNzh_TW

Default:

DEFAULT

Example:

DEFAULT

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Successfully retrieved an Amazon product type definition.

Headers

x-amzn-RateLimit-Limit

string

optional

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

A product type definition represents the attributes and data requirements for a product type in the Amazon catalog. Product type definitions are used interchangeably between the Selling Partner API for Listings Items, Selling Partner API for Catalog Items, and JSON-based listings feeds in the Selling Partner API for Feeds.

metaSchema

object (SchemaLink)

optional

link

object

required

Link to retrieve the schema.

checksum

string

required

Checksum hash of the schema (Base64 MD5). Can be used to verify schema contents, identify changes between schema versions, and for caching.

schema

object (SchemaLink)

required

requirements

enum<string>

required

Name of the requirements set represented in this product type definition.

Allowed values:

LISTINGLISTING_PRODUCT_ONLYLISTING_OFFER_ONLY

requirementsEnforced

enum<string>

required

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 of the required attributes being present (such as for partial updates).

Allowed values:

ENFORCEDNOT_ENFORCED

propertyGroups

object

required

Mapping of property group names to property groups. Property groups represent logical groupings of schema properties that can be used for display or informational purposes.

Additional properties

object (PropertyGroup)

optional

A property group represents a logical grouping of schema properties that can be used for display or informational purposes.

locale

string

required

Locale of the display elements contained in the product type definition.

marketplaceIds

array[string]

required

Amazon marketplace identifiers for which the product type definition is applicable.

productType

string

required

The name of the Amazon product type that this product type definition applies to.

displayName

string

required

Human-readable and localized description of the Amazon product type.

productTypeVersion

object (ProductTypeVersion)

required

The version details for an Amazon product type.

version

string

required

Version identifier.

latest

boolean

required

When true, the version indicated by the version identifier is the latest available for the Amazon product type.

releaseCandidate

boolean

optional

When true, the version indicated by the version identifier is the prerelease (release candidate) for the Amazon product type.

Example

{
    "metaSchema": {
        "link": {
            "resource": "https://meta-schema-url",
            "verb": "GET"
        },
        "checksum": "c7af9479ca7261645cea9db56c5f720d"
    },
    "schema": {
        "link": {
            "resource": "https://schema-url",
            "verb": "GET"
        },
        "checksum": "c7af9479ca7261645cea9db56c5f720d"
    },
    "requirements": "LISTING",
    "requirementsEnforced": "ENFORCED",
    "propertyGroups": {
        "product_identity": {
            "title": "Product Identity",
            "description": "Information to uniquely identify your product (e.g., UPC, EAN, GTIN, Product Type, Brand)",
            "propertyNames": [
                "item_name",
                "brand",
                "external_product_id",
                "gtin_exemption_reason",
                "merchant_suggested_asin",
                "product_type",
                "product_category",
                "product_subcategory",
                "item_type_keyword"
            ]
        }
    },
    "locale": "en_US",
    "marketplaceIds": [
        "ATVPDKIKX0DER"
    ],
    "productType": "LUGGAGE",
    "displayName": "Luggage",
    "productTypeVersion": {
        "version": "UHqSqmb4FNUk=",
        "latest": true,
        "releaseCandidate": false
    }
}

🟠400Bad Request

🟠403Forbidden

🟠404Record Not Found

🟠413413

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable