getDefinitionsProductType

get https://sellingpartnerapi-na.amazon.com/definitions/2020-09-01/productTypes/{productType}

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 Params

productType

string

required

The Amazon product type name.

Query Params

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

array of strings

required

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

marketplaceIds*

productTypeVersion

string

Defaults to 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

Defaults to LISTING

The name of the requirements set to retrieve requirements for.

requirementsEnforced

string

Defaults to 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

Defaults to DEFAULT

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

Responses

Response body

object

metaSchema

object

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

required

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.

requirements

string

required

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

LISTING LISTING_PRODUCT_ONLY LISTING_OFFER_ONLY

Show Details

LISTING	Indicates the schema contains product facts and sales terms.
LISTING_PRODUCT_ONLY	Indicates the schema data contains product facts only.
LISTING_OFFER_ONLY	Indicates the schema data contains sales terms only.

requirementsEnforced

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

ENFORCED NOT_ENFORCED

Show Details

ENFORCED	Schema enforces required and conditionally required attributes (used for full payload validation).
NOT_ENFORCED	Schema does not enforce required and conditionally required attributes (used for partial payload validation, such as for single attributes).

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.

locale

string

required

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

marketplaceIds

array of strings

required

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

marketplaceIds*

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

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

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

Headers

object

x-amzn-RateLimit-Limit

string

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

x-amzn-RequestId

string

Unique request reference identifier.

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://sellingpartnerapi-na.amazon.com/definitions/2020-09-01/productTypes/productType?productTypeVersion=LATEST&requirements=LISTING&requirementsEnforced=ENFORCED&locale=DEFAULT' \
3
     --header 'accept: application/json'


xxxxxxxxxx
46
}
1
{
2
  "metaSchema": {
3
    "link": {
4
      "resource": "https://meta-schema-url",
5
      "verb": "GET"
6
    },
7
    "checksum": "c7af9479ca7261645cea9db56c5f720d"
8
  },
9
  "schema": {
10
    "link": {
11
      "resource": "https://schema-url",
12
      "verb": "GET"
13
    },
14
    "checksum": "c7af9479ca7261645cea9db56c5f720d"
15
  },
16
  "requirements": "LISTING",
17
  "requirementsEnforced": "ENFORCED",
18
  "propertyGroups": {
19
    "product_identity": {
20
      "title": "Product Identity",
21
      "description": "Information to uniquely identify your product (e.g., UPC, EAN, GTIN, Product Type, Brand)",
22
      "propertyNames": [
23
        "item_name",
24
        "brand",
25
        "external_product_id",

200Successfully retrieved an Amazon product type definition.

400Request has missing or invalid parameters and cannot be parsed.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The resource specified does not exist.

413The request size exceeded the maximum accepted size.

415The request payload is in an unsupported format.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.