Orkas is an open-source (MIT), local-first AI team for your desktop: a Commander turns your goal into to-dos and coordinates 16 built-in specialist agents plus Claude Code, Codex, OpenCode, OpenClaw and Hermes, with projects, scheduled automations and connectors. Free app for macOS & Windows; built-in models or your own keys.
JavaScript agent-collaborationagent-harnessagent-orchestrationagent-teamagent-workflowai-assistantai-automationai-employeeai-productivityai-teamai-workflowautonomous-agentsclaude-code-guiclaude-coworkdesktop-agentlocal-firstmulti-agentmulti-agent-systemself-evolving-agentstask-automation
'use strict';
// Generated offline from pinned official seller-grant models.
module.exports = {
"documentation_snapshot": "2026-09-30",
"source_commit": "713565ff394d136629a342120872e65cb073d162",
"scope": "Current seller-grant SP-API business models and still-supported unique legacy merchant operations. Per-account roles and programs remain provider-authoritative. Excludes vendor, removed, sandbox-only, grantless and host-owned document/carrier/signature/RDT workflows. Existing document/destination identifiers may be used without exposing their grants.",
"methods": {
"POST /awd/2024-05-09/inboundOrders": {
"operation": "createInbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/inboundOrders",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"required": [
"originAddress",
"packagesToInbound"
],
"description": "Payload for creating an inbound order.",
"properties": {
"externalReferenceId": {
"type": "string",
"description": "Reference ID that can be used to correlate the order with partner resources.",
"maxLength": 262144
},
"originAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"description": "Origin address from where the inbound order will be shipped.",
"properties": {
"addressLine1": {
"type": "string",
"description": "First line of the address text.",
"maxLength": 262144
},
"addressLine2": {
"type": "string",
"description": "Optional second line of the address text.",
"maxLength": 262144
},
"addressLine3": {
"type": "string",
"description": "Optional third line of the address text.",
"maxLength": 262144
},
"city": {
"type": "string",
"description": "Optional city where this address is located.",
"maxLength": 262144
},
"countryCode": {
"type": "string",
"description": "Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.",
"maxLength": 262144
},
"county": {
"type": "string",
"description": "Optional county where this address is located.",
"maxLength": 262144
},
"district": {
"type": "string",
"description": "Optional district where this address is located.",
"maxLength": 262144
},
"name": {
"type": "string",
"description": "Name of the person, business, or institution at this address.",
"maxLength": 262144
},
"phoneNumber": {
"type": "string",
"description": "Optional E.164-formatted phone number for an available contact at this address.",
"maxLength": 262144
},
"postalCode": {
"type": "string",
"description": "Optional postal code where this address is located.",
"maxLength": 262144
},
"stateOrRegion": {
"type": "string",
"description": "State or region where this address is located. Note that this is contextual to the specified country code.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"packagesToInbound": {
"type": "array",
"minItems": 1,
"description": "List of packages to be inbounded.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"preferences": {
"type": "object",
"description": "Preferences that can be passed in context of an inbound order",
"properties": {
"destinationRegion": {
"type": "string",
"description": "Pass a preferred region so that the inbound order can be shipped to an AWD warehouse located in that region. This doesn't guarantee the order to be assigned in the specified destination region as it depends on warehouse capacity availability. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast]",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"additionalProperties": false,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"wire": [],
"responses": {
"201": {
"type": "object",
"required": [
"orderId"
],
"properties": {
"orderId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Creates a draft AWD inbound order with a list of packages for inbound shipment. The operation creates one shipment per order. Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/inboundOrders/{orderId}": {
"operation": "getInbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/inboundOrders/{orderId}",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "The ID of the inbound order that you want to retrieve.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"createdAt",
"orderId",
"orderStatus",
"originAddress",
"packagesToInbound"
],
"properties": {
"createdAt": {
"type": "string"
},
"destinationDetails": {
"type": "object",
"properties": {
"destinationAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"destinationRegion": {
"type": "string"
},
"shipmentId": {
"type": "string"
}
},
"additionalProperties": true
},
"externalReferenceId": {
"type": "string"
},
"orderId": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"originAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"packagesToInbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"preferences": {
"type": "object",
"properties": {
"destinationRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves an AWD inbound order. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"PUT /awd/2024-05-09/inboundOrders/{orderId}": {
"operation": "updateInbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "PUT",
"path": "/awd/2024-05-09/inboundOrders/{orderId}",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "The ID of the inbound order that you want to update.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"createdAt",
"orderId",
"orderStatus",
"originAddress",
"packagesToInbound"
],
"description": "Represents an AWD inbound order.",
"properties": {
"createdAt": {
"type": "string",
"description": "Date when this order was created.",
"format": "date-time",
"maxLength": 262144
},
"destinationDetails": {
"type": "object",
"description": "Destination details of an inbound order based on the assigned region and DC for the order.",
"properties": {
"destinationAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"description": "Destination address of the AWD facility where the shipment will be shipped to",
"properties": {
"addressLine1": {
"type": "string",
"description": "First line of the address text.",
"maxLength": 262144
},
"addressLine2": {
"type": "string",
"description": "Optional second line of the address text.",
"maxLength": 262144
},
"addressLine3": {
"type": "string",
"description": "Optional third line of the address text.",
"maxLength": 262144
},
"city": {
"type": "string",
"description": "Optional city where this address is located.",
"maxLength": 262144
},
"countryCode": {
"type": "string",
"description": "Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.",
"maxLength": 262144
},
"county": {
"type": "string",
"description": "Optional county where this address is located.",
"maxLength": 262144
},
"district": {
"type": "string",
"description": "Optional district where this address is located.",
"maxLength": 262144
},
"name": {
"type": "string",
"description": "Name of the person, business, or institution at this address.",
"maxLength": 262144
},
"phoneNumber": {
"type": "string",
"description": "Optional E.164-formatted phone number for an available contact at this address.",
"maxLength": 262144
},
"postalCode": {
"type": "string",
"description": "Optional postal code where this address is located.",
"maxLength": 262144
},
"stateOrRegion": {
"type": "string",
"description": "State or region where this address is located. Note that this is contextual to the specified country code.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"destinationRegion": {
"type": "string",
"description": "Assigned region where the order will be shipped. This can differ from what was passed as preference. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast]",
"maxLength": 262144
},
"shipmentId": {
"type": "string",
"minLength": 1,
"description": "Unique ID of the confirmed shipment being shipped to the assigned destination. This will be available only after an inbound order is confirmed and can be used to track the shipment.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"externalReferenceId": {
"type": "string",
"description": "Reference ID that can be used to correlate the order with partner resources.",
"maxLength": 262144
},
"orderId": {
"type": "string",
"description": "Inbound order ID.",
"maxLength": 262144
},
"orderStatus": {
"type": "string",
"enum": [
"DRAFT",
"VALIDATING",
"CONFIRMED",
"CLOSED",
"EXPIRED",
"CANCELLED"
],
"description": "Inbound order status.",
"maxLength": 262144
},
"originAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"description": "Origin address from where the inbound order will be shipped.",
"properties": {
"addressLine1": {
"type": "string",
"description": "First line of the address text.",
"maxLength": 262144
},
"addressLine2": {
"type": "string",
"description": "Optional second line of the address text.",
"maxLength": 262144
},
"addressLine3": {
"type": "string",
"description": "Optional third line of the address text.",
"maxLength": 262144
},
"city": {
"type": "string",
"description": "Optional city where this address is located.",
"maxLength": 262144
},
"countryCode": {
"type": "string",
"description": "Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.",
"maxLength": 262144
},
"county": {
"type": "string",
"description": "Optional county where this address is located.",
"maxLength": 262144
},
"district": {
"type": "string",
"description": "Optional district where this address is located.",
"maxLength": 262144
},
"name": {
"type": "string",
"description": "Name of the person, business, or institution at this address.",
"maxLength": 262144
},
"phoneNumber": {
"type": "string",
"description": "Optional E.164-formatted phone number for an available contact at this address.",
"maxLength": 262144
},
"postalCode": {
"type": "string",
"description": "Optional postal code where this address is located.",
"maxLength": 262144
},
"stateOrRegion": {
"type": "string",
"description": "State or region where this address is located. Note that this is contextual to the specified country code.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"packagesToInbound": {
"type": "array",
"minItems": 1,
"description": "List of packages to be inbounded.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"preferences": {
"type": "object",
"description": "Preferences that can be passed in context of an inbound order",
"properties": {
"destinationRegion": {
"type": "string",
"description": "Pass a preferred region so that the inbound order can be shipped to an AWD warehouse located in that region. This doesn't guarantee the order to be assigned in the specified destination region as it depends on warehouse capacity availability. AWD currently supports following region IDs: [us-west, us-east, us-southcentral, us-southeast]",
"maxLength": 262144
}
},
"additionalProperties": false
},
"updatedAt": {
"type": "string",
"description": "Date when this order was last updated.",
"format": "date-time",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path",
"body"
],
"additionalProperties": false,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"204": null
},
"outcomes": [],
"error_prose_paths": [],
"description": "Updates an AWD inbound order that is in `DRAFT` status and not yet confirmed. Use this operation to update the `packagesToInbound`, `originAddress` and `preferences` attributes. Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"POST /awd/2024-05-09/inboundOrders/{orderId}/cancellation": {
"operation": "cancelInbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/inboundOrders/{orderId}/cancellation",
"risk": "D",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "The ID of the inbound order you want to cancel.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"204": null
},
"outcomes": [],
"error_prose_paths": [],
"description": "Cancels an AWD Inbound order and its associated shipment. Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"POST /awd/2024-05-09/inboundOrders/{orderId}/confirmation": {
"operation": "confirmInbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/inboundOrders/{orderId}/confirmation",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "The ID of the inbound order that you want to confirm.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"204": null
},
"outcomes": [],
"error_prose_paths": [],
"description": "Confirms an AWD inbound order in `DRAFT` status. Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/inboundShipments/{shipmentId}": {
"operation": "getInboundShipment",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/inboundShipments/{shipmentId}",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"description": "ID for the shipment. A shipment contains the cases being inbounded.",
"maxLength": 262144
}
},
"required": [
"shipmentId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"skuQuantities": {
"type": "string",
"enum": [
"SHOW",
"HIDE"
],
"description": "If equal to `SHOW`, the response includes the shipment SKU quantity details.\n\nDefaults to `HIDE`, in which case the response does not contain SKU quantities",
"maxLength": 262144
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "shipmentId",
"collection": "csv"
},
{
"location": "query",
"name": "skuQuantities",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"destinationAddress",
"orderId",
"originAddress",
"shipmentContainerQuantities",
"shipmentId",
"shipmentStatus"
],
"properties": {
"carrierCode": {
"type": "object",
"properties": {
"carrierCodeType": {
"type": "string"
},
"carrierCodeValue": {
"type": "string"
}
},
"additionalProperties": true
},
"createdAt": {
"type": "string"
},
"destinationAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"externalReferenceId": {
"type": "string"
},
"orderId": {
"type": "string"
},
"originAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"receivedQuantity": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"unitOfMeasurement"
],
"properties": {
"quantity": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
}
},
"additionalProperties": true
}
},
"shipBy": {
"type": "string"
},
"shipmentContainerQuantities": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shipmentId": {
"type": "string"
},
"shipmentSkuQuantities": {
"type": "array",
"items": {
"type": "object",
"required": [
"expectedQuantity",
"sku"
],
"properties": {
"expectedQuantity": {
"type": "object",
"required": [
"quantity",
"unitOfMeasurement"
],
"properties": {
"quantity": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
}
},
"additionalProperties": true
},
"receivedQuantity": {
"type": "object",
"required": [
"quantity",
"unitOfMeasurement"
],
"properties": {
"quantity": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
}
},
"additionalProperties": true
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"destinationRegion": {
"type": "string"
},
"shipmentStatus": {
"type": "string"
},
"trackingId": {
"type": "string"
},
"updatedAt": {
"type": "string"
},
"warehouseReferenceId": {
"type": "string"
}
},
"additionalProperties": true,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves an AWD inbound shipment. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/inboundShipments/{shipmentId}/labels": {
"operation": "getInboundShipmentLabels",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/inboundShipments/{shipmentId}/labels",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"description": "ID for the shipment.",
"maxLength": 262144
}
},
"required": [
"shipmentId"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"pageType": {
"type": "string",
"enum": [
"PLAIN_PAPER"
],
"description": "Page type for the generated labels. The default is `PLAIN_PAPER`.",
"maxLength": 262144
},
"formatType": {
"type": "string",
"enum": [
"PDF"
],
"description": "The format type of the output file that contains your labels. The default format type is `PDF`.",
"maxLength": 262144
}
},
"required": [],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "shipmentId",
"collection": "csv"
},
{
"location": "query",
"name": "pageType",
"collection": "csv"
},
{
"location": "query",
"name": "formatType",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"labelStatus"
],
"properties": {
"labelDownloadURL": {
"type": "string"
},
"labelStatus": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves the box labels for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the label URL is available. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/inboundShipments/{shipmentId}/labelPageTypes": {
"operation": "getLabelPageTypes",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/inboundShipments/{shipmentId}/labelPageTypes",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"description": "ID for the shipment.",
"maxLength": 262144
}
},
"required": [
"shipmentId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "shipmentId",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"labelStatus"
],
"properties": {
"labelStatus": {
"type": "string"
},
"pageTypes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves the available label page types for a shipment ID that you specify. This is an asynchronous operation. If the label status is `GENERATED`, then the pageTypes are available. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"PUT /awd/2024-05-09/inboundShipments/{shipmentId}/transport": {
"operation": "updateInboundShipmentTransportDetails",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "PUT",
"path": "/awd/2024-05-09/inboundShipments/{shipmentId}/transport",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"shipmentId": {
"type": "string",
"minLength": 1,
"description": "The shipment ID.",
"maxLength": 262144
}
},
"required": [
"shipmentId"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"trackingDetails"
],
"description": "Transportation details for the shipment.",
"properties": {
"trackingDetails": {
"type": "array",
"description": "Tracking details for the shipment. If using SPD transportation, this can be for each case. If not using SPD transportation, this is a single tracking entry for the entire shipment.",
"items": {
"type": "object",
"required": [
"bookingId"
],
"description": "Tracking details for the shipment. If using SPD transportation, this can be for each case. If not using SPD transportation, this is a single tracking entry for the entire shipment.",
"properties": {
"carrierCode": {
"type": "object",
"description": "Unique or identifying code for the carrier.",
"properties": {
"carrierCodeType": {
"type": "string",
"enum": [
"SCAC"
],
"description": "Denotes the carrier type.",
"maxLength": 262144
},
"carrierCodeValue": {
"type": "string",
"description": "Value of the carrier code.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"bookingId": {
"type": "string",
"minLength": 1,
"description": "The identifier that is received from transportation to uniquely identify a booking.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
}
},
"required": [
"path",
"body"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "shipmentId",
"collection": "csv"
}
],
"responses": {
"204": null
},
"outcomes": [],
"error_prose_paths": [],
"description": "Updates transport details for an AWD shipment. Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"POST /awd/2024-05-09/inboundEligibility": {
"operation": "checkInboundEligibility",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/inboundEligibility",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"required": [
"packagesToInbound"
],
"description": "Represents the packages to inbound.",
"properties": {
"packagesToInbound": {
"type": "array",
"minItems": 1,
"description": "List of packages to be inbounded.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 100
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 100
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 100
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"additionalProperties": false,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 100
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 100
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 100
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 100
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"wire": [],
"responses": {
"200": {
"type": "object",
"required": [
"packagesToInbound",
"previewedAt",
"status"
],
"properties": {
"ineligibilityReasons": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"description"
],
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": true
}
},
"packagesToInbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"packageQuantity",
"status"
],
"properties": {
"ineligibilityReasons": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"description"
],
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
},
"additionalProperties": true
}
},
"packageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"status": {
"type": "string"
}
},
"additionalProperties": true
}
},
"previewedAt": {
"type": "string"
},
"status": {
"type": "string"
}
},
"additionalProperties": true,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Determines if the packages you specify are eligible for an AWD inbound order and contains error details for ineligible packages. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/inboundShipments": {
"operation": "listInboundShipments",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/inboundShipments",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"sortBy": {
"type": "string",
"enum": [
"UPDATED_AT",
"CREATED_AT"
],
"description": "Field to sort results by. By default, the response will be sorted by UPDATED_AT.",
"maxLength": 262144
},
"sortOrder": {
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Sort the response in ASCENDING or DESCENDING order. By default, the response will be sorted in DESCENDING order.",
"maxLength": 262144
},
"shipmentStatus": {
"type": "string",
"enum": [
"CREATED",
"SHIPPED",
"IN_TRANSIT",
"RECEIVING",
"DELIVERED",
"CLOSED",
"CANCELLED"
],
"description": "Filter by inbound shipment status.",
"maxLength": 262144
},
"updatedAfter": {
"type": "string",
"description": "List the inbound shipments that were updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format": "date-time",
"maxLength": 262144
},
"updatedBefore": {
"type": "string",
"description": "List the inbound shipments that were updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format": "date-time",
"maxLength": 262144
},
"maxResults": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"description": "Maximum number of results to return."
},
"nextToken": {
"type": "string",
"description": "A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.",
"maxLength": 262144
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"wire": [
{
"location": "query",
"name": "sortBy",
"collection": "csv"
},
{
"location": "query",
"name": "sortOrder",
"collection": "csv"
},
{
"location": "query",
"name": "shipmentStatus",
"collection": "csv"
},
{
"location": "query",
"name": "updatedAfter",
"collection": "csv"
},
{
"location": "query",
"name": "updatedBefore",
"collection": "csv"
},
{
"location": "query",
"name": "maxResults",
"collection": "csv"
},
{
"location": "query",
"name": "nextToken",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"properties": {
"nextToken": {
"type": "string"
},
"shipments": {
"type": "array",
"items": {
"type": "object",
"required": [
"orderId",
"shipmentId",
"shipmentStatus"
],
"properties": {
"createdAt": {
"type": "string"
},
"externalReferenceId": {
"type": "string"
},
"orderId": {
"type": "string"
},
"shipmentId": {
"type": "string"
},
"shipmentStatus": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves a summary of all the inbound AWD shipments associated with a merchant, with the ability to apply optional filters. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/inventory": {
"operation": "listInventory",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/inventory",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "Filter by seller or merchant SKU for the item.",
"maxLength": 262144
},
"sortOrder": {
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Sort the response in `ASCENDING` or `DESCENDING` order.",
"maxLength": 262144
},
"details": {
"type": "string",
"enum": [
"SHOW",
"HIDE"
],
"description": "Set to `SHOW` to return summaries with additional inventory details. Defaults to `HIDE,` which returns only inventory summary totals.",
"maxLength": 262144
},
"nextToken": {
"type": "string",
"description": "A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.",
"maxLength": 262144
},
"maxResults": {
"type": "integer",
"minimum": 1,
"maximum": 200,
"description": "Maximum number of results to return."
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"wire": [
{
"location": "query",
"name": "sku",
"collection": "csv"
},
{
"location": "query",
"name": "sortOrder",
"collection": "csv"
},
{
"location": "query",
"name": "details",
"collection": "csv"
},
{
"location": "query",
"name": "nextToken",
"collection": "csv"
},
{
"location": "query",
"name": "maxResults",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"inventory"
],
"properties": {
"inventory": {
"type": "array",
"items": {
"type": "object",
"required": [
"sku"
],
"properties": {
"expirationDetails": {
"type": "array",
"items": {
"type": "object",
"properties": {
"expiration": {
"type": "string"
},
"onhandQuantity": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"inventoryDetails": {
"type": "object",
"properties": {
"availableDistributableQuantity": {
"type": "integer"
},
"replenishmentQuantity": {
"type": "integer"
},
"reservedDistributableQuantity": {
"type": "integer"
}
},
"additionalProperties": true
},
"sku": {
"type": "string"
},
"totalInboundQuantity": {
"type": "integer"
},
"totalOnhandQuantity": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"nextToken": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Lists AWD inventory associated with a merchant with the ability to apply optional filters. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/outboundOrders": {
"operation": "listOutbounds",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/outboundOrders",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"updatedAfter": {
"type": "string",
"description": "Get the outbound orders updated after a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format": "date-time",
"maxLength": 262144
},
"updatedBefore": {
"type": "string",
"description": "Get the outbound orders updated before a certain time (inclusive). The date must be in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> format.",
"format": "date-time",
"maxLength": 262144
},
"sortOrder": {
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Sort the response in `ASCENDING` or `DESCENDING` order.",
"maxLength": 262144
},
"maxResults": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum number of results to return."
},
"nextToken": {
"type": "string",
"description": "A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.",
"maxLength": 262144
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"wire": [
{
"location": "query",
"name": "updatedAfter",
"collection": "csv"
},
{
"location": "query",
"name": "updatedBefore",
"collection": "csv"
},
{
"location": "query",
"name": "sortOrder",
"collection": "csv"
},
{
"location": "query",
"name": "maxResults",
"collection": "csv"
},
{
"location": "query",
"name": "nextToken",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"properties": {
"nextToken": {
"type": "string"
},
"outboundOrders": {
"type": "array",
"items": {
"type": "object",
"required": [
"orderId",
"orderStatus",
"outboundShipments"
],
"properties": {
"confirmedOn": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"eligiblePackagesToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"eligibleProductsToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"executionErrors": {
"type": "array",
"items": {
"type": "object",
"required": [
"failureCode",
"failureReasons"
],
"properties": {
"failureCode": {
"type": "string"
},
"failureReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"orderId": {
"type": "string"
},
"orderPreferences": {
"type": "array",
"items": {
"type": "object",
"required": [
"orderPreference",
"orderPreferenceValue"
],
"properties": {
"orderPreference": {
"type": "string"
},
"orderPreferenceValue": {
"type": "string"
}
},
"additionalProperties": true
}
},
"orderStatus": {
"type": "string"
},
"outboundShipments": {
"type": "array",
"items": {
"type": "object",
"required": [
"destinationAddress",
"orderId",
"originAddress",
"shipmentId",
"shipmentStatus"
],
"properties": {
"createdAt": {
"type": "string"
},
"destinationAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"orderId": {
"type": "string"
},
"originAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"shipmentPackageQuantities": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shipmentId": {
"type": "string"
},
"shipmentProductQuantities": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shipmentStatus": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
},
"packagesToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"productsToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shippedOutboundPackages": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shippedOutboundProducts": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves all outbound AWD orders (with optional filters) that pertain to a merchant. By default, orders are sorted by the `updatedAt` attribute in descending order. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"POST /awd/2024-05-09/outboundOrders": {
"operation": "createOutbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/outboundOrders",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"description": "Payload for creating an outbound order.",
"properties": {
"orderPreferences": {
"type": "array",
"description": "Order preferences for the outbound order.",
"items": {
"type": "object",
"required": [
"orderPreference",
"orderPreferenceValue"
],
"description": "Consists of the order preference and corresponding preference value.",
"properties": {
"orderPreference": {
"type": "string",
"enum": [
"PARTIAL_ORDER"
],
"description": "Preference for the distribution order.",
"maxLength": 262144
},
"orderPreferenceValue": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"description": "Value for the order preference.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"packagesToOutbound": {
"type": "array",
"description": "List of packages to be outbound.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"productsToOutbound": {
"type": "array",
"description": "List of product units to be outbound.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"additionalProperties": false,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"wire": [],
"responses": {
"201": {
"type": "object",
"required": [
"orderId"
],
"properties": {
"orderId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Creates a draft AWD outbound order with the specified products. The API returns the order ID for the newly created order and starts an async validation check on the outbound products. After Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/outboundOrders/{orderId}": {
"operation": "getOutbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/outboundOrders/{orderId}",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "ID for the outbound order to be retrieved.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"orderId",
"orderStatus",
"outboundShipments"
],
"properties": {
"confirmedOn": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"eligiblePackagesToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"eligibleProductsToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"executionErrors": {
"type": "array",
"items": {
"type": "object",
"required": [
"failureCode",
"failureReasons"
],
"properties": {
"failureCode": {
"type": "string"
},
"failureReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"orderId": {
"type": "string"
},
"orderPreferences": {
"type": "array",
"items": {
"type": "object",
"required": [
"orderPreference",
"orderPreferenceValue"
],
"properties": {
"orderPreference": {
"type": "string"
},
"orderPreferenceValue": {
"type": "string"
}
},
"additionalProperties": true
}
},
"orderStatus": {
"type": "string"
},
"outboundShipments": {
"type": "array",
"items": {
"type": "object",
"required": [
"destinationAddress",
"orderId",
"originAddress",
"shipmentId",
"shipmentStatus"
],
"properties": {
"createdAt": {
"type": "string"
},
"destinationAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"orderId": {
"type": "string"
},
"originAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"properties": {
"addressLine1": {
"type": "string"
},
"addressLine2": {
"type": "string"
},
"addressLine3": {
"type": "string"
},
"city": {
"type": "string"
},
"countryCode": {
"type": "string"
},
"county": {
"type": "string"
},
"district": {
"type": "string"
},
"name": {
"type": "string"
},
"phoneNumber": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"stateOrRegion": {
"type": "string"
}
},
"additionalProperties": true
},
"shipmentPackageQuantities": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shipmentId": {
"type": "string"
},
"shipmentProductQuantities": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shipmentStatus": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
},
"packagesToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"productsToOutbound": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shippedOutboundPackages": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"shippedOutboundProducts": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"properties": {
"count": {
"type": "integer"
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"properties": {
"contents": {
"type": "object",
"properties": {
"packages": {
"type": "array",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"expiration": {
"type": "string"
},
"prepDetails": {
"type": "object",
"properties": {
"labelOwner": {
"type": "string"
},
"prepCategory": {
"type": "string"
},
"prepInstructions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"prepOwner": {
"type": "string"
},
"prepType": {
"type": "string"
}
},
"additionalProperties": true
}
},
"prepOwner": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"properties": {
"height": {
"type": "number"
},
"length": {
"type": "number"
},
"unitOfMeasurement": {
"type": "string"
},
"width": {
"type": "number"
}
},
"additionalProperties": true
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"volume": {
"type": "number"
}
},
"additionalProperties": true
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"properties": {
"unitOfMeasurement": {
"type": "string"
},
"weight": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"type": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves an AWD outbound order with a set of shipments that contain items that are outbound into a destination channel. If the order is not eligible, the validation errors field is included One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"PUT /awd/2024-05-09/outboundOrders/{orderId}": {
"operation": "updateOutbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "PUT",
"path": "/awd/2024-05-09/outboundOrders/{orderId}",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "ID for the outbound order to be updated.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"orderId",
"orderStatus",
"outboundShipments"
],
"description": "Represents an AWD outbound order.",
"properties": {
"confirmedOn": {
"type": "string",
"description": "Date on which this outbound order was confirmed.",
"format": "date-time",
"maxLength": 262144
},
"createdAt": {
"type": "string",
"description": "Date on which this outbound order was created.",
"format": "date-time",
"maxLength": 262144
},
"eligiblePackagesToOutbound": {
"type": "array",
"description": "List of packages that are eligible for outbound.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"eligibleProductsToOutbound": {
"type": "array",
"description": "List of product units that are eligible for outbound.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"executionErrors": {
"type": "array",
"description": "Execution errors associated with the outbound order. This field will be populated if the order failed validation.",
"items": {
"type": "object",
"required": [
"failureCode",
"failureReasons"
],
"description": "Execution errors associated with the outbound order. This field will be populated if the order failed validation.",
"properties": {
"failureCode": {
"type": "string",
"description": "Failure code details for the error.",
"maxLength": 262144
},
"failureReasons": {
"type": "array",
"description": "Failure reasons for the error.",
"items": {
"type": "string",
"maxLength": 262144
},
"maxItems": 10
},
"sku": {
"type": "string",
"description": "MSKU associated with the error.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"orderId": {
"type": "string",
"description": "Order ID for the outbound order.",
"maxLength": 262144
},
"orderPreferences": {
"type": "array",
"description": "Order preferences for this outbound order.",
"items": {
"type": "object",
"required": [
"orderPreference",
"orderPreferenceValue"
],
"description": "Consists of the order preference and corresponding preference value.",
"properties": {
"orderPreference": {
"type": "string",
"enum": [
"PARTIAL_ORDER"
],
"description": "Preference for the distribution order.",
"maxLength": 262144
},
"orderPreferenceValue": {
"type": "string",
"enum": [
"SET",
"UNSET"
],
"description": "Value for the order preference.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"orderStatus": {
"type": "string",
"enum": [
"CONFIRMED",
"DRAFT",
"ELIGIBLE",
"EXECUTING",
"FAILURE",
"INELIGIBLE",
"INVENTORY_OUTBOUND",
"SUCCESS",
"VALIDATING"
],
"description": "Status for the outbound order.",
"maxLength": 262144
},
"outboundShipments": {
"type": "array",
"description": "List of outbound shipments that are part of this order.",
"items": {
"type": "object",
"required": [
"destinationAddress",
"orderId",
"originAddress",
"shipmentId",
"shipmentStatus"
],
"description": "Represents an AWD outbound shipment.",
"properties": {
"createdAt": {
"type": "string",
"description": "Timestamp when the shipment was created.",
"format": "date-time",
"maxLength": 262144
},
"destinationAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"description": "Destination address for this shipment.",
"properties": {
"addressLine1": {
"type": "string",
"description": "First line of the address text.",
"maxLength": 262144
},
"addressLine2": {
"type": "string",
"description": "Optional second line of the address text.",
"maxLength": 262144
},
"addressLine3": {
"type": "string",
"description": "Optional third line of the address text.",
"maxLength": 262144
},
"city": {
"type": "string",
"description": "Optional city where this address is located.",
"maxLength": 262144
},
"countryCode": {
"type": "string",
"description": "Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.",
"maxLength": 262144
},
"county": {
"type": "string",
"description": "Optional county where this address is located.",
"maxLength": 262144
},
"district": {
"type": "string",
"description": "Optional district where this address is located.",
"maxLength": 262144
},
"name": {
"type": "string",
"description": "Name of the person, business, or institution at this address.",
"maxLength": 262144
},
"phoneNumber": {
"type": "string",
"description": "Optional E.164-formatted phone number for an available contact at this address.",
"maxLength": 262144
},
"postalCode": {
"type": "string",
"description": "Optional postal code where this address is located.",
"maxLength": 262144
},
"stateOrRegion": {
"type": "string",
"description": "State or region where this address is located. Note that this is contextual to the specified country code.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"orderId": {
"type": "string",
"description": "Outbound order ID this outbound shipment belongs to.",
"maxLength": 262144
},
"originAddress": {
"type": "object",
"required": [
"addressLine1",
"countryCode",
"name",
"stateOrRegion"
],
"description": "Origin address for this shipment.",
"properties": {
"addressLine1": {
"type": "string",
"description": "First line of the address text.",
"maxLength": 262144
},
"addressLine2": {
"type": "string",
"description": "Optional second line of the address text.",
"maxLength": 262144
},
"addressLine3": {
"type": "string",
"description": "Optional third line of the address text.",
"maxLength": 262144
},
"city": {
"type": "string",
"description": "Optional city where this address is located.",
"maxLength": 262144
},
"countryCode": {
"type": "string",
"description": "Two-digit, ISO 3166-1 alpha-2 formatted country code where this address is located.",
"maxLength": 262144
},
"county": {
"type": "string",
"description": "Optional county where this address is located.",
"maxLength": 262144
},
"district": {
"type": "string",
"description": "Optional district where this address is located.",
"maxLength": 262144
},
"name": {
"type": "string",
"description": "Name of the person, business, or institution at this address.",
"maxLength": 262144
},
"phoneNumber": {
"type": "string",
"description": "Optional E.164-formatted phone number for an available contact at this address.",
"maxLength": 262144
},
"postalCode": {
"type": "string",
"description": "Optional postal code where this address is located.",
"maxLength": 262144
},
"stateOrRegion": {
"type": "string",
"description": "State or region where this address is located. Note that this is contextual to the specified country code.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"shipmentPackageQuantities": {
"type": "array",
"description": "Specific distribution packages that are included in the context of this shipment.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"shipmentId": {
"type": "string",
"description": "Unique shipment ID.",
"maxLength": 262144
},
"shipmentProductQuantities": {
"type": "array",
"description": "Specific product units that are included in the context of this shipment.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"shipmentStatus": {
"type": "string",
"enum": [
"CREATED",
"IN_TRANSIT",
"DELIVERED",
"RECEIVING",
"RECEIVED",
"CLOSED",
"CANCELLED",
"FAILED"
],
"description": "Current status of this shipment.",
"maxLength": 262144
},
"updatedAt": {
"type": "string",
"description": "Timestamp when the shipment was updated.",
"format": "date-time",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"packagesToOutbound": {
"type": "array",
"description": "List of packages to be outbound.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"productsToOutbound": {
"type": "array",
"description": "List of product units to be outbound.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"shippedOutboundPackages": {
"type": "array",
"description": "Outbound packages that are shipped after the execution has completed post confirmation.",
"items": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"shippedOutboundProducts": {
"type": "array",
"description": "Outbound product units that are shipped after the execution has completed post confirmation.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
},
"updatedAt": {
"type": "string",
"description": "Date on which this outbound order was last updated.",
"format": "date-time",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"required": [
"path",
"body"
],
"additionalProperties": false,
"$defs": {
"DistributionPackageQuantity": {
"type": "object",
"required": [
"count",
"distributionPackage"
],
"description": "Represents a distribution package with its respective quantity.",
"properties": {
"count": {
"type": "integer",
"description": "Number of cases or pallets with the same package configuration.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"distributionPackage": {
"type": "object",
"required": [
"contents",
"measurements",
"type"
],
"description": "Represents an AWD distribution package.",
"properties": {
"contents": {
"type": "object",
"description": "The contents appropriate for the type.",
"properties": {
"packages": {
"type": "array",
"description": "This is required only when `DistributionPackageType=PALLET`.",
"items": {
"$ref": "#/$defs/DistributionPackageQuantity"
},
"maxItems": 10
},
"products": {
"type": "array",
"description": "This is required only when `DistributionPackageType=CASE`.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with the SKU details and the corresponding quantity.",
"properties": {
"attributes": {
"type": "array",
"description": "Contains attributes for this instance of the product. For example, item color, or other attributes that distinguish the product beyond the SKU. This is metadata for the product and Amazon does not process this data.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Product quantity.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller or merchant SKU.",
"maxLength": 262144
},
"expiration": {
"type": "string",
"description": "The expiration date for the SKU. Values are in [ISO 8601](https://developer-docs.amazon.com/sp-api/docs/iso-8601) date-time format.",
"format": "date-time",
"maxLength": 262144
},
"prepDetails": {
"type": "object",
"description": "Preparation details of a product which contains the prep category, prep owner and the label owner.\nIf not passed while creating an inbound order, NO_PREP will be used on the product by-default.\nPrep instructions will be generated based on the category passed",
"properties": {
"labelOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The entity that labels the products. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepCategory": {
"type": "string",
"enum": [
"ADULT",
"BABY",
"FC_PROVIDED",
"FRAGILE",
"GRANULAR",
"HANGER",
"LIQUID",
"PERFORATED",
"SET",
"SHARP",
"SMALL",
"TEXTILE",
"NO_PREP",
"UNKNOWN"
],
"description": "The preparation category for shipping an item to Amazon's fulfillment network.",
"maxLength": 262144
},
"prepInstructions": {
"type": "array",
"description": "Contains information about the preparation of the inbound products. The system auto-generates this field with the use of the `prepCategory`, and if you attempt to pass a value for this field, the system will ignore it.",
"items": {
"type": "object",
"description": "Information pertaining to the preparation of inbound products.",
"properties": {
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
},
"prepType": {
"type": "string",
"description": "The type of preparation to be done. For more information about preparing items, refer to [Prep guidance](https://sellercentral.amazon.com/help/hub/reference/external/GF4G7547KSLDX2KC) on Seller Central.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"prepOwner": {
"type": "string",
"enum": [
"AMAZON",
"SELF"
],
"description": "The owner of the preparations, if special preparations are required. `AMAZON` is not an accepted value in the US marketplace.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
},
"measurements": {
"type": "object",
"required": [
"weight"
],
"description": "Measurements of a package, including weight, volume, and dimensions.",
"properties": {
"dimensions": {
"type": "object",
"required": [
"height",
"length",
"unitOfMeasurement",
"width"
],
"description": "Dimensions of the package. Dimensions are required when creating an inbound or outbound order.",
"properties": {
"height": {
"type": "number",
"description": "Height of the package."
},
"length": {
"type": "number",
"description": "Length of the package."
},
"unitOfMeasurement": {
"type": "string",
"enum": [
"INCHES",
"CENTIMETERS"
],
"description": "Unit of measurement for package dimensions.",
"maxLength": 262144
},
"width": {
"type": "number",
"description": "Width of the package."
}
},
"additionalProperties": false
},
"volume": {
"type": "object",
"required": [
"unitOfMeasurement",
"volume"
],
"description": "Volume of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"CU_IN",
"CBM",
"CC"
],
"description": "Unit of measurement for the package volume.",
"maxLength": 262144
},
"volume": {
"type": "number",
"description": "The package volume value."
}
},
"additionalProperties": false
},
"weight": {
"type": "object",
"required": [
"unitOfMeasurement",
"weight"
],
"description": "Weight of the package.",
"properties": {
"unitOfMeasurement": {
"type": "string",
"enum": [
"POUNDS",
"KILOGRAMS"
],
"description": "Unit of measurement for the package weight.",
"maxLength": 262144
},
"weight": {
"type": "number",
"description": "The package weight value."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"type": {
"type": "string",
"enum": [
"CASE",
"PALLET"
],
"description": "Type of distribution package.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"orderId"
],
"properties": {
"orderId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Updates an AWD outbound order that is in `DRAFT`, `ELIGIBLE`, or `INELIGIBLE` status. This API allows updates on `productsToOutbound` and `orderPreferences` attributes only. Any updates will Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"POST /awd/2024-05-09/outboundOrders/{orderId}/confirmation": {
"operation": "confirmOutbound",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/outboundOrders/{orderId}/confirmation",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "ID for the outbound order you want to confirm.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"204": null
},
"outcomes": [],
"error_prose_paths": [],
"description": "Confirms an AWD outbound order for a set of shipments that contain items that must be outbound to a destination node. You can confirm the order only if it's in an`ELIGIBLE` state. Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/replenishmentOrders": {
"operation": "listReplenishmentOrders",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/replenishmentOrders",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"updatedAfter": {
"type": "string",
"description": "Get the replenishment orders updated after certain time (Inclusive)\nDate should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.",
"format": "date-time",
"maxLength": 262144
},
"updatedBefore": {
"type": "string",
"description": "Get the replenishment orders updated before certain time (Inclusive)\nDate should be in ISO 8601 format as defined by date-time in - https://www.rfc-editor.org/rfc/rfc3339.",
"format": "date-time",
"maxLength": 262144
},
"sortOrder": {
"type": "string",
"enum": [
"ASCENDING",
"DESCENDING"
],
"description": "Sort the response in ASCENDING or DESCENDING order. The default sort order is DESCENDING.",
"maxLength": 262144
},
"maxResults": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum results to be returned in a single response."
},
"nextToken": {
"type": "string",
"description": "A token that is used to retrieve the next page of results. The response includes `nextToken` when the number of results exceeds the specified `maxResults` value. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until `nextToken` is null. Note that this operation can return empty pages.",
"maxLength": 262144
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"wire": [
{
"location": "query",
"name": "updatedAfter",
"collection": "csv"
},
{
"location": "query",
"name": "updatedBefore",
"collection": "csv"
},
{
"location": "query",
"name": "sortOrder",
"collection": "csv"
},
{
"location": "query",
"name": "maxResults",
"collection": "csv"
},
{
"location": "query",
"name": "nextToken",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"properties": {
"nextToken": {
"type": "string"
},
"orders": {
"type": "array",
"items": {
"type": "object",
"required": [
"orderId",
"status",
"outboundShipments"
],
"properties": {
"confirmedOn": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"distributionIneligibleReasons": {
"type": "array",
"items": {
"type": "object",
"required": [
"failureCode",
"failureReasons"
],
"properties": {
"failureCode": {
"type": "string"
},
"failureReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"eligibleProducts": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"orderId": {
"type": "string"
},
"status": {
"type": "string"
},
"outboundShipments": {
"type": "array",
"items": {
"type": "object",
"required": [
"orderId",
"shipmentId",
"shipmentStatus"
],
"properties": {
"createdAt": {
"type": "string"
},
"orderId": {
"type": "string"
},
"shipmentId": {
"type": "string"
},
"shipmentStatus": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"shippedProducts": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves all the AWD replenishment orders pertaining to a merchant with optional filters. API by default will sort orders by updatedAt attribute in descending order. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"POST /awd/2024-05-09/replenishmentOrders": {
"operation": "createReplenishmentOrder",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/replenishmentOrders",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"body": {
"type": "object",
"description": "This structure represents the payload for creating an AFN Replenishment Order.\nBy default, all replenishment orders created support Partial order preferences.",
"properties": {
"preferences": {
"type": "object",
"description": "Preferences that can be passed in context of a replenishment order",
"properties": {
"confirmation": {
"type": "string",
"enum": [
"AUTO",
"MANUAL"
],
"description": "Confirmation Mode to use for the created Replenishment order.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"products": {
"type": "array",
"description": "Requested amount of single product units to be replenished.",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"description": "Represents a product with sku details and corresponding quantity",
"properties": {
"attributes": {
"type": "array",
"description": "Attributes for this instance of the product, i.e. already-prepped, or other\nattributes that distinguish the product beyond the SKU.",
"items": {
"type": "object",
"description": "Product instance attribute that is not described at the SKU level in the catalog.",
"properties": {
"name": {
"type": "string",
"description": "Product attribute name.",
"maxLength": 262144
},
"value": {
"type": "string",
"description": "Product attribute value.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
},
"quantity": {
"type": "integer",
"description": "Quantity of the product",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"sku": {
"type": "string",
"description": "The seller/merchant stock keeping unit (SKU).",
"maxLength": 262144
}
},
"additionalProperties": false
},
"maxItems": 10
}
},
"additionalProperties": false
}
},
"required": [
"body"
],
"additionalProperties": false
},
"wire": [],
"responses": {
"201": {
"type": "object",
"required": [
"orderId"
],
"properties": {
"orderId": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Creates an AWD replenishment order with given products to replenish. The API will return the order ID of the newly created order and also start an async validation check on the products to e Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /awd/2024-05-09/replenishmentOrders/{orderId}": {
"operation": "getReplenishmentOrder",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "GET",
"path": "/awd/2024-05-09/replenishmentOrders/{orderId}",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "ID of the replenishment order to be retrieved.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"required": [
"orderId",
"status",
"outboundShipments"
],
"properties": {
"confirmedOn": {
"type": "string"
},
"createdAt": {
"type": "string"
},
"distributionIneligibleReasons": {
"type": "array",
"items": {
"type": "object",
"required": [
"failureCode",
"failureReasons"
],
"properties": {
"failureCode": {
"type": "string"
},
"failureReasons": {
"type": "array",
"items": {
"type": "string"
}
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"eligibleProducts": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"orderId": {
"type": "string"
},
"status": {
"type": "string"
},
"outboundShipments": {
"type": "array",
"items": {
"type": "object",
"required": [
"orderId",
"shipmentId",
"shipmentStatus"
],
"properties": {
"createdAt": {
"type": "string"
},
"orderId": {
"type": "string"
},
"shipmentId": {
"type": "string"
},
"shipmentStatus": {
"type": "string"
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
},
"products": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"shippedProducts": {
"type": "array",
"items": {
"type": "object",
"required": [
"quantity",
"sku"
],
"properties": {
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"additionalProperties": true
}
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"additionalProperties": true
}
},
"updatedAt": {
"type": "string"
}
},
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [],
"description": "Retrieves an AWD Replenishment order with a set of shipments containing items that is/was planned to be replenished into an FBA node. One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"POST /awd/2024-05-09/replenishmentOrders/{orderId}/confirmation": {
"operation": "confirmReplenishmentOrder",
"model": "models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json",
"method": "POST",
"path": "/awd/2024-05-09/replenishmentOrders/{orderId}/confirmation",
"risk": "H",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"orderId": {
"type": "string",
"description": "ID of the replenishment order to be confirmed.",
"maxLength": 262144
}
},
"required": [
"orderId"
],
"additionalProperties": false
}
},
"required": [
"path"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "orderId",
"collection": "csv"
}
],
"responses": {
"204": null
},
"outcomes": [],
"error_prose_paths": [],
"description": "Confirms an AWD replenishment order in ELIGIBLE state with a set of shipments containing items that are needed to be replenished to an FBA node. Order can only be confirmed in ELIGIBLE state Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/amazon-warehousing-and-distribution-model/awd_2024-05-09.json"
},
"GET /aplus/2020-11-01/contentDocuments": {
"operation": "searchContentDocuments",
"model": "models/aplus-content-api-model/aplusContent_2020-11-01.json",
"method": "GET",
"path": "/aplus/2020-11-01/contentDocuments",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"marketplaceId": {
"type": "string",
"minLength": 1,
"description": "The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
"maxLength": 262144
},
"pageToken": {
"type": "string",
"minLength": 1,
"description": "A token that you use to fetch a specific page when there are multiple pages of results.",
"maxLength": 262144
}
},
"required": [
"marketplaceId"
],
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
},
"wire": [
{
"location": "query",
"name": "marketplaceId",
"collection": "csv"
},
{
"location": "query",
"name": "pageToken",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"details": {
"type": "string"
}
},
"additionalProperties": true
}
},
"nextPageToken": {
"type": "string"
},
"contentMetadataRecords": {
"type": "array",
"items": {
"type": "object",
"required": [
"contentMetadata",
"contentReferenceKey"
],
"properties": {
"contentReferenceKey": {
"type": "string"
},
"contentMetadata": {
"type": "object",
"required": [
"badgeSet",
"marketplaceId",
"name",
"status",
"updateTime"
],
"properties": {
"name": {
"type": "string"
},
"marketplaceId": {
"type": "string"
},
"status": {
"type": "string"
},
"badgeSet": {
"type": "array",
"items": {
"type": "string"
}
},
"updateTime": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
}
},
"required": [
"contentMetadataRecords"
],
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [
[
"warnings",
"*",
"message"
],
[
"warnings",
"*",
"details"
]
],
"description": "Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the `getContentDocument` One explicit page; authorized business fields may include fulfillment contacts and amounts. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/aplus-content-api-model/aplusContent_2020-11-01.json"
},
"POST /aplus/2020-11-01/contentDocuments": {
"operation": "createContentDocument",
"model": "models/aplus-content-api-model/aplusContent_2020-11-01.json",
"method": "POST",
"path": "/aplus/2020-11-01/contentDocuments",
"risk": "W",
"input_schema": {
"type": "object",
"properties": {
"query": {
"type": "object",
"properties": {
"marketplaceId": {
"type": "string",
"minLength": 1,
"description": "The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
"maxLength": 262144
}
},
"required": [
"marketplaceId"
],
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"contentDocument"
],
"properties": {
"contentDocument": {
"type": "object",
"required": [
"contentModuleList",
"contentType",
"locale",
"name"
],
"description": "The A+ Content document. This is the enhanced content that is published to product detail pages.",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The A+ Content document name."
},
"contentType": {
"type": "string",
"enum": [
"EBC",
"EMC"
],
"description": "The A+ Content document type.",
"maxLength": 262144
},
"contentSubType": {
"type": "string",
"minLength": 1,
"description": "The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type has a subtype, and subtypes can change at any time.",
"maxLength": 262144
},
"locale": {
"type": "string",
"minLength": 5,
"description": "The IETF language tag, which supports the primary language subtag and one secondary language subtag. The secondary language subtag is usually a regional designation. This doesn't support subtags other than the primary and secondary subtags.\n**Pattern:** ^[a-z]{2,}-[A-Z0-9]{2,}$",
"maxLength": 262144
},
"contentModuleList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"uniqueItems": false,
"description": "A list of A+ Content modules.",
"items": {
"type": "object",
"required": [
"contentModuleType"
],
"description": "An A+ Content module. An A+ Content document is composed of content modules. The `contentModuleType` property selects which content module types to use.",
"properties": {
"contentModuleType": {
"type": "string",
"enum": [
"STANDARD_COMPANY_LOGO",
"STANDARD_COMPARISON_TABLE",
"STANDARD_FOUR_IMAGE_TEXT",
"STANDARD_FOUR_IMAGE_TEXT_QUADRANT",
"STANDARD_HEADER_IMAGE_TEXT",
"STANDARD_IMAGE_SIDEBAR",
"STANDARD_IMAGE_TEXT_OVERLAY",
"STANDARD_MULTIPLE_IMAGE_TEXT",
"STANDARD_PRODUCT_DESCRIPTION",
"STANDARD_SINGLE_IMAGE_HIGHLIGHTS",
"STANDARD_SINGLE_IMAGE_SPECS_DETAIL",
"STANDARD_SINGLE_SIDE_IMAGE",
"STANDARD_TECH_SPECS",
"STANDARD_TEXT",
"STANDARD_THREE_IMAGE_TEXT"
],
"description": "The type of A+ Content module.",
"maxLength": 262144
},
"standardCompanyLogo": {
"type": "object",
"required": [
"companyLogo"
],
"description": "The standard company logo image.",
"properties": {
"companyLogo": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardComparisonTable": {
"type": "object",
"description": "The standard product comparison table.",
"properties": {
"productColumns": {
"type": "array",
"minItems": 0,
"maxItems": 6,
"items": {
"type": "object",
"required": [
"position"
],
"description": "The A+ Content standard comparison product block.",
"properties": {
"position": {
"type": "integer",
"minimum": 1,
"maximum": 6,
"description": "The rank or index of this comparison product block within the module. Different blocks cannot occupy the same position within a single module."
},
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"title": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "The comparison product title."
},
"asin": {
"type": "string",
"minLength": 10,
"description": "The Amazon Standard Identification Number (ASIN).",
"maxLength": 262144
},
"highlight": {
"type": "boolean",
"description": "When true, indicates that this content block is visually highlighted."
},
"metrics": {
"type": "array",
"minItems": 0,
"maxItems": 10,
"description": "Comparison metrics for the product.",
"items": {
"type": "object",
"required": [
"position",
"value"
],
"description": "Plain positional text that is used in collections of brief labels and descriptors.",
"properties": {
"position": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection."
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"description": "The actual plain text."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"metricRowLabels": {
"type": "array",
"minItems": 0,
"maxItems": 10,
"items": {
"type": "object",
"required": [
"position",
"value"
],
"description": "Plain positional text that is used in collections of brief labels and descriptors.",
"properties": {
"position": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection."
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 250,
"description": "The actual plain text."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"standardFourImageText": {
"type": "object",
"description": "Four standard images with text, presented across a single row.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"block1": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block2": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block3": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block4": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardFourImageTextQuadrant": {
"type": "object",
"required": [
"block1",
"block2",
"block3",
"block4"
],
"description": "Four standard images with text, presented on a grid of four quadrants.",
"properties": {
"block1": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block2": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block3": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block4": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardHeaderImageText": {
"type": "object",
"description": "Standard headline text, an image, and body text.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"block": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardImageSidebar": {
"type": "object",
"description": "Two images, two paragraphs, and two bulleted lists. One image is smaller and displayed in the sidebar.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"imageCaptionBlock": {
"type": "object",
"description": "The A+ Content standard image and caption block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"caption": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"descriptionTextBlock": {
"type": "object",
"description": "The A+ Content standard text box block, which contains a paragraph and a headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"descriptionListBlock": {
"type": "object",
"required": [
"textList"
],
"description": "The A+ Content standard fixed-length list of text, usually presented as bullet points.",
"properties": {
"textList": {
"type": "array",
"minItems": 0,
"maxItems": 8,
"items": {
"type": "object",
"required": [
"position",
"text"
],
"description": "Rich positional text that is usually presented as a collection of bullet points.",
"properties": {
"position": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection."
},
"text": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"sidebarImageTextBlock": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"sidebarListBlock": {
"type": "object",
"required": [
"textList"
],
"description": "The A+ Content standard fixed-length list of text, usually presented as bullet points.",
"properties": {
"textList": {
"type": "array",
"minItems": 0,
"maxItems": 8,
"items": {
"type": "object",
"required": [
"position",
"text"
],
"description": "Rich positional text that is usually presented as a collection of bullet points.",
"properties": {
"position": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection."
},
"text": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardImageTextOverlay": {
"type": "object",
"required": [
"overlayColorType"
],
"description": "A standard background image with a floating text box.",
"properties": {
"overlayColorType": {
"type": "string",
"enum": [
"DARK",
"LIGHT"
],
"description": "The relative color scheme of your content.",
"maxLength": 262144
},
"block": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardMultipleImageText": {
"type": "object",
"description": "Standard images with text, presented one at a time. The user clicks on thumbnails to view each block.",
"properties": {
"blocks": {
"type": "array",
"items": {
"type": "object",
"description": "The A+ Content standard image and text block, with a related caption. The caption might not display on all devices.",
"properties": {
"block": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"caption": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"standardProductDescription": {
"type": "object",
"required": [
"body"
],
"description": "Standard product description text.",
"properties": {
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardSingleImageHighlights": {
"type": "object",
"description": "A standard image with several paragraphs and a bulleted list.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"textBlock1": {
"type": "object",
"description": "The A+ Content standard text box block, which contains a paragraph and a headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"textBlock2": {
"type": "object",
"description": "The A+ Content standard text box block, which contains a paragraph and a headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"textBlock3": {
"type": "object",
"description": "The A+ Content standard text box block, which contains a paragraph and a headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"bulletedListBlock": {
"type": "object",
"description": "The A+ standard fixed-length list of text and a related headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"block": {
"type": "object",
"required": [
"textList"
],
"description": "The A+ Content standard fixed-length list of text, usually presented as bullet points.",
"properties": {
"textList": {
"type": "array",
"minItems": 0,
"maxItems": 8,
"items": {
"type": "object",
"required": [
"position",
"text"
],
"description": "Rich positional text that is usually presented as a collection of bullet points.",
"properties": {
"position": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection."
},
"text": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardSingleImageSpecsDetail": {
"type": "object",
"description": "A standard image with paragraphs, a bulleted list, and extra space for technical details.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"descriptionHeadline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"descriptionBlock1": {
"type": "object",
"description": "The A+ Content standard text box block, which contains a paragraph and a headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"descriptionBlock2": {
"type": "object",
"description": "The A+ Content standard text box block, which contains a paragraph and a headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"specificationHeadline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"specificationListBlock": {
"type": "object",
"description": "The A+ standard fixed-length list of text and a related headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"block": {
"type": "object",
"required": [
"textList"
],
"description": "The A+ Content standard fixed-length list of text, usually presented as bullet points.",
"properties": {
"textList": {
"type": "array",
"minItems": 0,
"maxItems": 8,
"items": {
"type": "object",
"required": [
"position",
"text"
],
"description": "Rich positional text that is usually presented as a collection of bullet points.",
"properties": {
"position": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection."
},
"text": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"specificationTextBlock": {
"type": "object",
"description": "The A+ Content standard text box block, which contains a paragraph and a headline.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardSingleSideImage": {
"type": "object",
"required": [
"imagePositionType"
],
"description": "A standard headline and body text with an image on the side.",
"properties": {
"imagePositionType": {
"type": "string",
"enum": [
"LEFT",
"RIGHT"
],
"description": "The content's relative positioning.",
"maxLength": 262144
},
"block": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardTechSpecs": {
"type": "object",
"required": [
"specificationList"
],
"description": "The standard table of technical feature names and definitions.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"specificationList": {
"type": "array",
"minItems": 4,
"maxItems": 16,
"description": "The specification list.",
"items": {
"type": "object",
"description": "The A+ Content standard label and description block, which contains a pair of text components.",
"properties": {
"label": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"description": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"tableCount": {
"type": "integer",
"minimum": 1,
"maximum": 2,
"description": "The number of tables you want present. Features are evenly divided between the tables."
}
},
"additionalProperties": false
},
"standardText": {
"type": "object",
"required": [
"body"
],
"description": "A standard headline and body text.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"standardThreeImageText": {
"type": "object",
"description": "Three standard images with text, presented across a single row.",
"properties": {
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"block1": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block2": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"block3": {
"type": "object",
"description": "The A+ Content standard image and text box block.",
"properties": {
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"description": "A reference to an image, hosted in the A+ Content media library.",
"properties": {
"uploadDestinationId": {
"type": "string",
"minLength": 1,
"description": "This identifier is provided by the [Uploads API](https://developer-docs.amazon.com/sp-api/reference/welcome-to-api-references).",
"maxLength": 262144
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"description": "The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.",
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"description": "The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). `ImageDimensions` units must be in pixels.",
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"description": "The top left corner of the cropped image, specified in the original image's coordinate space.",
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.",
"properties": {
"value": {
"type": "integer",
"description": "The dimension value.",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"units": {
"type": "string",
"description": "The unit of measurement.",
"maxLength": 262144
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"altText": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "The alternative text for the image."
}
},
"additionalProperties": false
},
"headline": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
},
"body": {
"type": "object",
"required": [
"textList"
],
"description": "A list of rich text content that is typically presented in a text box.",
"properties": {
"textList": {
"type": "array",
"minItems": 1,
"maxItems": 25,
"items": {
"type": "object",
"required": [
"value"
],
"description": "Rich text content.",
"properties": {
"value": {
"type": "string",
"minLength": 1,
"maxLength": 10000,
"description": "The actual plain text."
},
"decoratorSet": {
"type": "array",
"uniqueItems": true,
"description": "A set of content decorators.",
"items": {
"type": "object",
"description": "A decorator that is applied to a content string value in order to create rich text.",
"properties": {
"type": {
"type": "string",
"enum": [
"LIST_ITEM",
"LIST_ORDERED",
"LIST_UNORDERED",
"STYLE_BOLD",
"STYLE_ITALIC",
"STYLE_LINEBREAK",
"STYLE_PARAGRAPH",
"STYLE_UNDERLINE"
],
"description": "The type of rich text decorator.",
"maxLength": 262144
},
"offset": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The starting value of this decorator within the content string. Use zero (`0`) for the first value."
},
"length": {
"type": "integer",
"minimum": 0,
"maximum": 10000,
"description": "The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters."
},
"depth": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths."
}
},
"additionalProperties": false
},
"maxItems": 25
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"required": [
"query",
"body"
],
"additionalProperties": false
},
"wire": [
{
"location": "query",
"name": "marketplaceId",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"details": {
"type": "string"
}
},
"additionalProperties": true
}
},
"contentReferenceKey": {
"type": "string"
}
},
"required": [
"contentReferenceKey"
],
"additionalProperties": true
}
},
"outcomes": [],
"error_prose_paths": [
[
"warnings",
"*",
"message"
],
[
"warnings",
"*",
"details"
]
],
"description": "Creates a new A+ Content document. Accepted submission is acknowledged; inspect state before retrying an uncertain write. https://github.com/amzn/selling-partner-api-models/blob/713565ff394d136629a342120872e65cb073d162/models/aplus-content-api-model/aplusContent_2020-11-01.json"
},
"GET /aplus/2020-11-01/contentDocuments/{contentReferenceKey}": {
"operation": "getContentDocument",
"model": "models/aplus-content-api-model/aplusContent_2020-11-01.json",
"method": "GET",
"path": "/aplus/2020-11-01/contentDocuments/{contentReferenceKey}",
"risk": "R",
"input_schema": {
"type": "object",
"properties": {
"path": {
"type": "object",
"properties": {
"contentReferenceKey": {
"type": "string",
"minLength": 1,
"description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier.",
"maxLength": 262144
}
},
"required": [
"contentReferenceKey"
],
"additionalProperties": false
},
"query": {
"type": "object",
"properties": {
"marketplaceId": {
"type": "string",
"minLength": 1,
"description": "The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).",
"maxLength": 262144
},
"includedDataSet": {
"type": "array",
"minItems": 1,
"uniqueItems": true,
"description": "The set of A+ Content data types to include in the response.",
"items": {
"type": "string",
"enum": [
"CONTENTS",
"METADATA"
],
"maxLength": 262144
},
"maxItems": 100
}
},
"required": [
"marketplaceId",
"includedDataSet"
],
"additionalProperties": false
}
},
"required": [
"path",
"query"
],
"additionalProperties": false
},
"wire": [
{
"location": "path",
"name": "contentReferenceKey",
"collection": "csv"
},
{
"location": "query",
"name": "marketplaceId",
"collection": "csv"
},
{
"location": "query",
"name": "includedDataSet",
"collection": "csv"
}
],
"responses": {
"200": {
"type": "object",
"properties": {
"warnings": {
"type": "array",
"items": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"details": {
"type": "string"
}
},
"additionalProperties": true
}
},
"contentRecord": {
"type": "object",
"required": [
"contentReferenceKey"
],
"properties": {
"contentReferenceKey": {
"type": "string"
},
"contentMetadata": {
"type": "object",
"required": [
"badgeSet",
"marketplaceId",
"name",
"status",
"updateTime"
],
"properties": {
"name": {
"type": "string"
},
"marketplaceId": {
"type": "string"
},
"status": {
"type": "string"
},
"badgeSet": {
"type": "array",
"items": {
"type": "string"
}
},
"updateTime": {
"type": "string"
}
},
"additionalProperties": true
},
"contentDocument": {
"type": "object",
"required": [
"contentModuleList",
"contentType",
"locale",
"name"
],
"properties": {
"name": {
"type": "string"
},
"contentType": {
"type": "string"
},
"contentSubType": {
"type": "string"
},
"locale": {
"type": "string"
},
"contentModuleList": {
"type": "array",
"items": {
"type": "object",
"required": [
"contentModuleType"
],
"properties": {
"contentModuleType": {
"type": "string"
},
"standardCompanyLogo": {
"type": "object",
"required": [
"companyLogo"
],
"properties": {
"companyLogo": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"properties": {
"uploadDestinationId": {
"type": "string"
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"altText": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"standardComparisonTable": {
"type": "object",
"properties": {
"productColumns": {
"type": "array",
"items": {
"type": "object",
"required": [
"position"
],
"properties": {
"position": {
"type": "integer"
},
"image": {
"type": "object",
"required": [
"altText",
"imageCropSpecification",
"uploadDestinationId"
],
"properties": {
"uploadDestinationId": {
"type": "string"
},
"imageCropSpecification": {
"type": "object",
"required": [
"size"
],
"properties": {
"size": {
"type": "object",
"required": [
"height",
"width"
],
"properties": {
"width": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
},
"height": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"offset": {
"type": "object",
"required": [
"x",
"y"
],
"properties": {
"x": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
},
"y": {
"type": "object",
"required": [
"units",
"value"
],
"properties": {
"value": {
"type": "integer"
},
"units": {
"type": "string"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}
},
"additionalProperties": true
},
"altText": {
"type": "string"
}
},
"additionalProperties": true
File truncated at 1 MB.