Amazon Product Type Definitions Meta-Schema (v1)

The Amazon Product Type Definition Meta-Schema is an extension of the JSON Schema Draft 2019-09, which describes the properties and requirements for an Amazon Product Type.

Instances of the Amazon Product Type Definition Meta Schema can utilize any of the keywords and vocabularies supported by JSON Schema Draft 2019-09. Refer to the JSON Schema Specification for more details.

Schema URI: https://schemas.amazon.com/selling-partners/definitions/product-types/meta-schema/v1

Vocabulary URI: https://schemas.amazon.com/selling-partners/definitions/product-types/vocabulary/v1

📘

Note

The schema and vocabulary URIs are identifiers; they are not network addressable.

In addition to standard JSON Schema Draft 2019-09 vocabularies, instances of the Amazon Product Type Definition Meta-Schema utilize keywords that are defined by a custom vocabulary in the meta-schema. This documentation outlines the custom vocabulary for https://schemas.amazon.com/selling-partners/definitions/product-types/vocabulary/v1.

If you choose to ignore this custom vocabulary and use only the standard JSON Schema Draft 2019-09 vocabularies, you may get validation errors.

Vocabulary

editable

• Type: Boolean
• Purpose: Informational
• Description: Indicates whether or not a property value can be modified for an existing item. Properties that can't be modified may still be required for a valid submission.

enumNames

• Type: array
• Purpose: Informational
• Description: Contains an array of display labels for a corresponding array of enum values. The display labels in the enumNames array are in the same order as the values in the enum array.

hidden

• Type: Boolean
• Purpose: Informational
• Description: Determines if a property should be hidden in Amazon user interfaces. Hiding or displaying these properties is at the discretion of the application consuming the Amazon Product Type Definition Meta-Schema.

maxUniqueItems

• Type: integer
• Purpose: Validation
• Description: Defines the maximum number of unique items in an array. Use in conjunction with selectors.

minUniqueItems

• Type: integer
• Purpose: Validation
• Description: Defines the minimum number of unique items in an array. Use in conjunction with selectors.

maxUtf8ByteLength

• Type: integer
• Purpose: Validation
• Description: Defines the maximum length of a string, measured in UTF-8 bytes.

minUtf8ByteLength

• Type: integer
• Purpose: Validation
• Description: Defines the minimum length of a string, measured in UTF-8 bytes.

selectors

• Type: array
• Purpose: Validation
• Description: Contains an array of property names that define the combination of properties that make an object unique. By default, the JSON Schema determines the uniqueness of objects in an array, based an all the properties of the object. When selectors are defined, only the specified properties are used to determine uniqueness.

$lifecycle

• Type: object
• Purpose: Informational
• Description: Provides details for property and constraint changes, such as replacement properties and enum value deprecations.

replacedBy

• Type: array
• Purpose: Informational
• Description: Contains an array of Relative JSON Pointers according to the 2019-09 JSON schema specification.

replaces

• Type: array
• Purpose: Informational
• Description: Contains an array of Relative JSON Pointers according to the 2019-09 JSON schema specification.

enumDeprecated

• Type: array
• Purpose: Informational
• Description: Contains an array of deprecated enum values. Instances of deprecated enum values must be replaced with valid values before the deprecated values are removed.

enumReplacement

• Type: array
• Purpose: Informational
• Description: Contains an array of objects that represent deprecated enum values and their suggested replacement values. Instances of deprecated enum values must be replaced with valid values before the deprecated values are removed.

Example validator implementations

JSON Schema is a vocabulary that allows you to annotate and validate JSON documents. There are multiple paid and open-source applications and libraries that support JSON Schema, refer to JSON Schema Tooling for a list of known implementations.

The following reference validator implementations provide examples of how you can validate a custom vocabulary for instances of Amazon Product Type Definition Meta-Schema using language-specific open-source libraries. Amazon does not provide technical support for third-party JSON Schema libraries and these are provided as examples only.