{ "swagger": "2.0", "info": { "description": "With the A+ Content API, you can build applications that help selling partners add rich marketing content to their Amazon product detail pages. A+ Content helps selling partners share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners assemble content by choosing from content modules and adding images and text.", "version": "2020-11-01", "title": "Selling Partner API for A+ Content Management", "contact": { "name": "Selling Partner API Developer Support", "url": "https://sellercentral.amazon.com/gp/mws/contactus.html" }, "license": { "name": "Apache License 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0" } }, "host": "sellingpartnerapi-na.amazon.com", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/aplus/2020-11-01/contentDocuments": { "get": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Retrieve a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the `getContentDocument` operation to get the actual contents of the A+ Content documents.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchContentDocuments", "parameters": [ { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "name": "pageToken", "in": "query", "description": "A page token from the `nextPageToken` response element returned by your previous call to this operation. `nextPageToken` is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include `pageToken` as the only parameter. Specifying `pageToken` with any other parameter will cause the request to fail. When no `nextPageToken` value is returned there are no more pages to return. A `pageToken` value is not usable across different operations.", "required": false, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/SearchContentDocumentsResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "post": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Create a new A+ Content document.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createContentDocument", "parameters": [ { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "in": "body", "description": "The content document request details.", "name": "postContentDocumentRequest", "required": true, "schema": { "$ref": "#/definitions/PostContentDocumentRequest" } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/PostContentDocumentResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/contentDocuments/{contentReferenceKey}": { "get": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Retrieve an A+ Content document, if available.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getContentDocument", "parameters": [ { "name": "contentReferenceKey", "in": "path", "description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.", "required": true, "type": "string", "minLength": 1 }, { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "name": "includedDataSet", "in": "query", "description": "The set of A+ Content data types to include in the response.", "required": true, "type": "array", "items": { "type": "string", "enum": [ "CONTENTS", "METADATA" ], "x-docgen-enum-table-extension": [ { "value": "CONTENTS", "description": "The contents of the content document." }, { "value": "METADATA", "description": "The metadata of the content document." } ] }, "collectionFormat": "csv", "minItems": 1, "uniqueItems": true } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetContentDocumentResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "post": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Update an existing A+ Content document.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "updateContentDocument", "parameters": [ { "name": "contentReferenceKey", "in": "path", "description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.", "required": true, "type": "string", "minLength": 1 }, { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "in": "body", "name": "postContentDocumentRequest", "description": "The content document request details.", "required": true, "schema": { "$ref": "#/definitions/PostContentDocumentRequest" } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/PostContentDocumentResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins": { "get": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Retrieve a list of ASINs related to the specified A+ Content document, if available. If you do not include the `asinSet` parameter, the operation returns all ASINs related to the content document.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "listContentDocumentAsinRelations", "parameters": [ { "name": "contentReferenceKey", "in": "path", "description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.", "required": true, "type": "string", "minLength": 1 }, { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "name": "includedDataSet", "in": "query", "description": "The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "METADATA" ], "x-docgen-enum-table-extension": [ { "value": "METADATA", "description": "The metadata of the content document." } ] }, "collectionFormat": "csv", "minItems": 0, "uniqueItems": true }, { "name": "asinSet", "in": "query", "description": "The set of ASINs.", "required": false, "type": "array", "items": { "type": "string", "minLength": 10 }, "collectionFormat": "csv", "uniqueItems": true }, { "name": "pageToken", "in": "query", "description": "A page token from the `nextPageToken` response element returned by your previous call to this operation. `nextPageToken` is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include `pageToken` as the only parameter. Specifying `pageToken` with any other parameter will cause the request to fail. When no `nextPageToken` value is returned there are no more pages to return. A `pageToken` value is not usable across different operations.", "required": false, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ListContentDocumentAsinRelationsResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "post": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "postContentDocumentAsinRelations", "parameters": [ { "name": "contentReferenceKey", "in": "path", "description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.", "required": true, "type": "string", "minLength": 1 }, { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "in": "body", "name": "postContentDocumentAsinRelationsRequest", "description": "The content document ASIN relations request details.", "required": true, "schema": { "$ref": "#/definitions/PostContentDocumentAsinRelationsRequest" } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/PostContentDocumentAsinRelationsResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/contentAsinValidations": { "post": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Checks if the A+ Content document is valid for use on a set of ASINs.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "validateContentDocumentAsinRelations", "parameters": [ { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "name": "asinSet", "in": "query", "description": "The set of ASINs.", "required": false, "type": "array", "items": { "type": "string", "minLength": 10 }, "collectionFormat": "csv", "uniqueItems": true }, { "in": "body", "name": "postContentDocumentRequest", "description": "The content document request details.", "required": true, "schema": { "$ref": "#/definitions/PostContentDocumentRequest" } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ValidateContentDocumentAsinRelationsResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/contentPublishRecords": { "get": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Searches for A+ Content publishing records, if available.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "searchContentPublishRecords", "parameters": [ { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, { "name": "asin", "in": "query", "description": "The Amazon Standard Identification Number (ASIN).", "required": true, "type": "string", "minLength": 10 }, { "name": "pageToken", "in": "query", "description": "A page token from the `nextPageToken` response element returned by your previous call to this operation. `nextPageToken` is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include `pageToken` as the only parameter. Specifying `pageToken` with any other parameter will cause the request to fail. When no `nextPageToken` value is returned there are no more pages to return. A `pageToken` value is not usable across different operations.", "required": false, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/SearchContentPublishRecordsResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/approvalSubmissions": { "post": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Submits an A+ Content document for review, approval, and publishing.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "postContentDocumentApprovalSubmission", "parameters": [ { "name": "contentReferenceKey", "in": "path", "description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.", "required": true, "type": "string", "minLength": 1 }, { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/PostContentDocumentApprovalSubmissionResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/contentDocuments/{contentReferenceKey}/suspendSubmissions": { "post": { "x-amzn-api-internal": "INTERNAL_AND_EXTERNAL", "tags": [ "aplusContent" ], "description": "Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "postContentDocumentSuspendSubmission", "parameters": [ { "name": "contentReferenceKey", "in": "path", "description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.", "required": true, "type": "string", "minLength": 1 }, { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/PostContentDocumentSuspendSubmissionResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "401": { "description": "The request's Authorization header is not formatted correctly or does not contain a valid token.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation.\n_Note:_ For this status code, the rate limit header is deprecated and no longer returned." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/media": { "post": { "tags": [ "aplusContent" ], "description": "Create a media asset record. The `mediaType` field determines the type of asset to create.\n\nThis operation is idempotent; if the asset or pairing already exists with identical metadata, this operation returns a `200` response with existing data. Returns `201` when a new asset or pairing is created. Returns `409` if the asset or pairing already exists but the metadata fields differ.\n\nIf an `uploadDestinationId` is provided, it is resolved to its `mediaId` before any further processing. A request that references an asset by `uploadDestinationId` and a subsequent request that uses the resulting `mediaId` are treated as referring to the same identity.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "createMedia", "parameters": [ { "in": "body", "name": "createMediaRequest", "description": "The media creation request details.", "required": true, "schema": { "$ref": "#/definitions/CreateMediaRequest" }, "x-examples": { "application/json": { "mediaType": "VIDEO", "uploadDestinationId": "aplus-media-library-service-media-upload/a1b2c3d4-e5f6-7890-abcd-ef1234567890.mp4", "descriptions": [ { "locale": "en-US", "value": "A demonstration of the product features and benefits." } ], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Demo Video", "media": { "mediaType": "IMAGE", "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123" } } ] } } } ], "responses": { "200": { "description": "Success. The media asset already exists with identical metadata.", "schema": { "$ref": "#/definitions/CreateMediaResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "mediaType": "IMAGE", "uploadDestinationId": "aplus-media-library-service-media-upload/6od4d9b1-20d2-6671-b3r6-1ce02e1ap0a7.jpg", "title": "Product Sideview" } } } }, "response": { "mediaId": "a1d2e6f6-b7b1-4016-aaba-335577192141", "mediaType": "IMAGE", "title": "Product Sideview", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/a1d2e6f6-b7b1-4016-aaba-335577192141.jpg", "issues": [], "relatedMedia": [] } } ] } }, "201": { "description": "Created. A new media asset was successfully created.", "schema": { "$ref": "#/definitions/CreateMediaResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "mediaType": "VIDEO", "uploadDestinationId": "aplus-media-library-service-media-upload/a1b2c3d4-e5f6-7890-abcd-ef1234567890.mp4", "descriptions": [ { "locale": "en-US", "value": "A demonstration of the product features and benefits." } ], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Demo Video", "media": { "mediaType": "IMAGE", "uploadDestinationId": "aplus-media-library-service-media-upload/7ae2d3b1-00d0-4626-a2b6-5de81e1af0d4.jpg" } } ] } } } }, "response": { "mediaId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "mediaType": "VIDEO", "title": "productFeatures.mp4", "descriptions": [ { "locale": "en-US", "value": "A demonstration of the product features and benefits." } ], "status": [ "PENDING_PROCESSING", "PENDING_AMAZON" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b2c3d4e5-f6a7-8901-bcde-f12345678901.mp4", "issues": [], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Demo Video", "status": [ "PENDING_PROCESSING", "PENDING_AMAZON" ], "issues": [], "media": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "thumbnailPhoto.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [] } } ] } }, { "request": { "parameters": { "body": { "value": { "mediaType": "IMAGE", "uploadDestinationId": "aplus-media-library-service-media-upload/e8f9a0b1-c2d3-4567-89ab-cdef01234567.jpg", "title": "Product Lifestyle Image" } } } }, "response": { "mediaId": "d4e5f6a7-b8c9-0123-def0-345678901234", "mediaType": "IMAGE", "title": "Product Lifestyle Image", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/d4e5f6a7-b8c9-0123-def0-345678901234.jpg", "issues": [], "relatedMedia": [] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "body": { "value": { "mediaType": "VIDEO", "uploadDestinationId": "invalid", "descriptions": [], "relatedMedia": [] } } } }, "response": { "errors": [ { "code": "BAD_REQUEST", "message": "Invalid input", "details": "The uploadDestinationId is invalid or no valid media file exists at the specified location." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "409": { "description": "The media combination already exists with different metadata.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [] }, "/aplus/2020-11-01/media/{mediaId}": { "get": { "tags": [ "aplusContent" ], "description": "Retrieve media metadata and related media for a given media ID. The response uses the unified Media shape. Related media associations are also included in the response.\n\nWhen `associatedMediaId` is provided, `relatedMedia` is filtered to the specific pairing. When omitted, all related media are returned.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "getMedia", "parameters": [ { "name": "mediaId", "in": "path", "description": "The unique identifier for the media asset.", "required": true, "type": "string", "x-example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, { "name": "associatedMediaId", "in": "query", "description": "When provided, returns only the specific association. When omitted, returns all associated media.", "required": false, "type": "string", "x-example": "c3d4e5f6-a7b8-9012-cdef-234567890123" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/GetMediaResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "mediaId": { "value": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } } }, "response": { "mediaId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "mediaType": "VIDEO", "title": "productFeatures.mp4", "descriptions": [ { "locale": "en-US", "value": "A demonstration of the product features and benefits." } ], "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b2c3d4e5-f6a7-8901-bcde-f12345678901.mp4", "issues": [], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Demo Video", "status": [ "AVAILABLE" ], "issues": [], "media": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "thumbnailPhoto.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [] } }, { "associationType": "VIDEO_PAIRING", "title": "Product Demo Alternate View", "status": [ "AVAILABLE" ], "issues": [], "media": { "mediaId": "d4e5f6a7-b8c9-0123-def0-345678901234", "mediaType": "IMAGE", "title": "Product Lifestyle Image", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/d4e5f6a7-b8c9-0123-def0-345678901234.jpg", "issues": [] } } ] } }, { "request": { "parameters": { "mediaId": { "value": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "associatedMediaId": { "value": "c3d4e5f6-a7b8-9012-cdef-234567890123" } } }, "response": { "mediaId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "mediaType": "VIDEO", "title": "productFeatures.mp4", "descriptions": [ { "locale": "en-US", "value": "A demonstration of the product features and benefits." } ], "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b2c3d4e5-f6a7-8901-bcde-f12345678901.mp4", "issues": [], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Demo Video", "status": [ "AVAILABLE" ], "issues": [], "media": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "thumbnailPhoto.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [] } } ] } }, { "request": { "parameters": { "mediaId": { "value": "c3d4e5f6-a7b8-9012-cdef-234567890123" } } }, "response": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "thumbnailPhoto.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Demo Video", "status": [ "AVAILABLE" ], "issues": [], "media": { "mediaId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "mediaType": "VIDEO", "title": "productFeatures.mp4", "descriptions": [ { "locale": "en-US", "value": "A demonstration of the product features and benefits." } ], "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b2c3d4e5-f6a7-8901-bcde-f12345678901.mp4", "issues": [] } }, { "associationType": "VIDEO_PAIRING", "title": "Product Unboxing Video", "status": [ "AVAILABLE" ], "issues": [], "media": { "mediaId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "mediaType": "VIDEO", "title": "unboxingVideo.mp4", "descriptions": [ { "locale": "en-US", "value": "An unboxing and first look at the product." } ], "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/a1b2c3d4-e5f6-7890-abcd-ef1234567890.mp4", "issues": [] } } ] } }, { "request": { "parameters": { "mediaId": { "value": "f6a7b8c9-d0e1-2345-f012-567890123456" } } }, "response": { "mediaId": "f6a7b8c9-d0e1-2345-f012-567890123456", "mediaType": "IMAGE", "title": "overviewThumbnail.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/f6a7b8c9-d0e1-2345-f012-567890123456.jpg", "issues": [ { "code": "116123", "message": "Image contains content classified as mature. This media is restricted to eligible product placements.", "severity": "INFO", "propertyNames": [], "categories": [ "CONTENT_POLICY" ] } ], "relatedMedia": [] } }, { "request": { "parameters": { "mediaId": { "value": "e5f6a7b8-c9d0-1234-ef01-456789012345" } } }, "response": { "mediaId": "e5f6a7b8-c9d0-1234-ef01-456789012345", "mediaType": "VIDEO", "title": "productOverview.mp4", "descriptions": [ { "locale": "en-US", "value": "Product overview and key features." } ], "status": [ "UNABLE_TO_PROCESS", "PENDING_SELLING_PARTNER" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/e5f6a7b8-c9d0-1234-ef01-456789012345.mp4", "issues": [ { "code": "116122", "message": "Video could not be processed. Verify the file format and re-upload.", "severity": "ERROR", "propertyNames": [], "categories": [ "PROCESSING_ISSUE" ] } ], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Overview Thumbnail", "status": [ "PENDING_SELLING_PARTNER" ], "issues": [], "media": { "mediaId": "f6a7b8c9-d0e1-2345-f012-567890123456", "mediaType": "IMAGE", "title": "overviewThumbnail.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/f6a7b8c9-d0e1-2345-f012-567890123456.jpg", "issues": [ { "code": "116123", "message": "Image contains content classified as mature. This media is restricted to eligible product placements.", "severity": "INFO", "propertyNames": [], "categories": [ "CONTENT_POLICY" ] } ] } }, { "associationType": "VIDEO_PAIRING", "title": "DEMO", "status": [ "NOT_APPROVED", "PENDING_SELLING_PARTNER" ], "issues": [ { "code": "116150", "message": "Title must not be entirely uppercase.", "severity": "ERROR", "propertyNames": [ "title" ], "categories": [ "METADATA_VALIDATION" ] } ], "media": { "mediaId": "b7c8d9e0-1f2a-4b3c-9d4e-5f6a7b8c9d0e", "mediaType": "IMAGE", "title": "demoThumbnail.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b7c8d9e0-1f2a-4b3c-9d4e-5f6a7b8c9d0e.jpg", "issues": [] } } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "mediaId": { "value": "invalid-id" } } }, "response": { "errors": [ { "code": "BAD_REQUEST", "message": "Invalid input", "details": "The mediaId format is invalid." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } }, "parameters": [], "patch": { "tags": [ "aplusContent" ], "description": "Update metadata on an existing media asset. The `mediaId` path parameter identifies the target asset. For video-image pairing title updates, provide `associatedMediaId` as a query parameter. For video-level description updates or standalone image title updates, omit `associatedMediaId`.\n\nEach request updates either title or descriptions, but not both. Descriptions are upserted by locale; only provided locales are modified, and existing locales not in the request are preserved.\n\nThe response contains the full unified Media shape. When `associatedMediaId` is provided, `relatedMedia` contains only the specified pairing. When `associatedMediaId` is absent, `relatedMedia` contains all affected pairings.\n\n**Usage Plan:**\n\n| Rate (requests per second) | Burst |\n| ---- | ---- |\n| 10 | 10 |\n\nThe `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).", "operationId": "updateMedia", "parameters": [ { "name": "mediaId", "in": "path", "description": "The unique identifier for the media asset to update.", "required": true, "type": "string", "x-example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, { "name": "associatedMediaId", "in": "query", "description": "When provided, identifies the specific video-image pairing for title updates. Required when updating a pairing title.", "required": false, "type": "string", "x-example": "c3d4e5f6-a7b8-9012-cdef-234567890123" }, { "in": "body", "name": "updateMediaRequest", "description": "The media update request details.", "required": true, "schema": { "$ref": "#/definitions/UpdateMediaRequest" }, "x-examples": { "application/json": { "title": "Updated Product Demo Video" } } } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/UpdateMediaResponse" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "mediaId": { "value": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "associatedMediaId": { "value": "c3d4e5f6-a7b8-9012-cdef-234567890123" }, "body": { "value": { "title": "Updated Video Title" } } } }, "response": { "mediaId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "mediaType": "VIDEO", "title": "productFeatures.mp4", "descriptions": [ { "locale": "en-US", "value": "A demonstration of the product features and benefits." } ], "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b2c3d4e5-f6a7-8901-bcde-f12345678901.mp4", "issues": [], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Updated Video Title", "status": [ "PENDING_PROCESSING", "PENDING_AMAZON" ], "issues": [], "media": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "thumbnailPhoto.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [] } } ] } }, { "request": { "parameters": { "mediaId": { "value": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "body": { "value": { "descriptions": [ { "locale": "en-US", "value": "Updated video description for accessibility." } ] } } } }, "response": { "mediaId": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "mediaType": "VIDEO", "title": "productFeatures.mp4", "descriptions": [ { "locale": "en-US", "value": "Updated video description for accessibility." } ], "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b2c3d4e5-f6a7-8901-bcde-f12345678901.mp4", "issues": [], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Updated Video Title", "status": [ "PENDING_PROCESSING", "PENDING_AMAZON" ], "issues": [], "media": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "thumbnailPhoto.jpg", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [] } }, { "associationType": "VIDEO_PAIRING", "title": "Product Demo Alternate View", "status": [ "PENDING_PROCESSING", "PENDING_AMAZON" ], "issues": [], "media": { "mediaId": "d4e5f6a7-b8c9-0123-def0-345678901234", "mediaType": "IMAGE", "title": "Product Lifestyle Image", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/d4e5f6a7-b8c9-0123-def0-345678901234.jpg", "issues": [] } } ] } }, { "request": { "parameters": { "mediaId": { "value": "c3d4e5f6-a7b8-9012-cdef-234567890123" }, "body": { "value": { "title": "Updated Image Title" } } } }, "response": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "Updated Image Title", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [], "relatedMedia": [] } }, { "request": { "parameters": { "mediaId": { "value": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "body": { "value": { "descriptions": [ { "locale": "en-US", "value": "Updated English description." } ] } } } }, "response": { "mediaId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "mediaType": "VIDEO", "title": "unboxingVideo.mp4", "descriptions": [ { "locale": "en-US", "value": "Updated English description." }, { "locale": "de-DE", "value": "Eine Demonstration der Produkteigenschaften und Vorteile." } ], "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/a1b2c3d4-e5f6-7890-abcd-ef1234567890.mp4", "issues": [], "relatedMedia": [ { "associationType": "VIDEO_PAIRING", "title": "Product Unboxing Video", "status": [ "PENDING_PROCESSING", "PENDING_AMAZON" ], "issues": [], "media": { "mediaId": "c3d4e5f6-a7b8-9012-cdef-234567890123", "mediaType": "IMAGE", "title": "Updated Image Title", "status": [ "AVAILABLE" ], "mediaUrl": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/c3d4e5f6-a7b8-9012-cdef-234567890123.jpg", "issues": [] } } ] } } ] } }, "400": { "description": "Request has missing or invalid parameters and cannot be parsed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } }, "x-amzn-api-sandbox": { "static": [ { "request": { "parameters": { "mediaId": { "value": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "body": { "value": {} } } }, "response": { "errors": [ { "code": "BAD_REQUEST", "message": "Invalid input", "details": "Exactly one of title or descriptions must be provided." } ] } } ] } }, "403": { "description": "Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "404": { "description": "The specified resource does not exist.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RateLimit-Limit": { "type": "string", "description": "Your rate limit (requests per second) for this operation." }, "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "410": { "description": "The specified resource no longer exists.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "429": { "description": "The frequency of requests was greater than allowed.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "500": { "description": "An unexpected condition occurred that prevented the server from fulfilling the request.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } }, "503": { "description": "Temporary overloading or maintenance of the server.", "schema": { "$ref": "#/definitions/ErrorList" }, "headers": { "x-amzn-RequestId": { "type": "string", "description": "Unique request reference identifier." } } } } } } }, "definitions": { "AplusResponse": { "type": "object", "properties": { "warnings": { "$ref": "#/definitions/MessageSet" } }, "description": "The base response data for all A+ Content operations when a request is successful or partially successful. Individual operations may extend this with additional data." }, "AplusPaginatedResponse": { "allOf": [ { "$ref": "#/definitions/AplusResponse" }, { "type": "object", "properties": { "nextPageToken": { "$ref": "#/definitions/PageToken" } } } ], "description": "The base response data for paginated A+ Content operations. Individual operations may extend this with additional data. If `nextPageToken` is not returned, there are no more pages to return." }, "ErrorList": { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/definitions/Error" }, "description": "A list of error responses returned when a request is unsuccessful." } }, "description": "The error response for when a request is unsuccessful." }, "MessageSet": { "type": "array", "description": "A set of messages to the user, such as warnings or comments.", "items": { "$ref": "#/definitions/Error" }, "uniqueItems": true }, "Error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "An error code that identifies the type of error that occurred.", "minLength": 1 }, "message": { "type": "string", "description": "A message that describes the error condition.", "minLength": 1 }, "details": { "type": "string", "description": "Additional details that can help the caller understand or fix the issue.", "minLength": 1 } }, "description": "Error response returned when the request is unsuccessful." }, "ContentMetadataRecordList": { "type": "array", "description": "A list of A+ Content metadata records.", "items": { "$ref": "#/definitions/ContentMetadataRecord" }, "uniqueItems": false }, "ContentMetadataRecord": { "type": "object", "required": [ "contentMetadata", "contentReferenceKey" ], "properties": { "contentReferenceKey": { "$ref": "#/definitions/ContentReferenceKey" }, "contentMetadata": { "$ref": "#/definitions/ContentMetadata" } }, "description": "The metadata for an A+ Content document, with additional information for content management." }, "ContentMetadata": { "type": "object", "required": [ "badgeSet", "marketplaceId", "name", "status", "updateTime" ], "properties": { "name": { "type": "string", "description": "The A+ Content document name.", "minLength": 1, "maxLength": 100 }, "marketplaceId": { "$ref": "#/definitions/MarketplaceId" }, "status": { "$ref": "#/definitions/ContentStatus" }, "badgeSet": { "$ref": "#/definitions/ContentBadgeSet" }, "updateTime": { "type": "string", "format": "date-time", "description": "The approximate age of the A+ Content document and metadata." } }, "description": "The metadata of an A+ Content document." }, "ContentType": { "type": "string", "description": "The A+ Content document type.", "enum": [ "EBC", "EMC", "BrandStory" ], "x-docgen-enum-table-extension": [ { "value": "EBC", "description": "A+ Enhanced Product Description content published through the A+ Content Manager in Seller Central." }, { "value": "EMC", "description": "A+ Enhanced Product Description content published through the A+ Content Manager in Vendor Central." }, { "value": "BrandStory", "description": "A+ Brand Story content, which helps customers gain a better understanding of the brand." } ] }, "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 will have a subtype, and subtypes may change at any time." }, "ContentStatus": { "type": "string", "description": "The submission status of the content document.", "enum": [ "APPROVED", "DRAFT", "REJECTED", "SUBMITTED" ], "x-docgen-enum-table-extension": [ { "value": "APPROVED", "description": "The content is approved and will be published to applied ASINs." }, { "value": "DRAFT", "description": "The content has not yet been submitted for approval." }, { "value": "REJECTED", "description": "The content has been rejected in moderation and needs to be revised and resubmitted based on the rejection reasons provided." }, { "value": "SUBMITTED", "description": "The content has been submitted for approval and is currently waiting for moderation." } ] }, "ContentBadgeSet": { "type": "array", "description": "The set of content badges.", "items": { "$ref": "#/definitions/ContentBadge" }, "uniqueItems": true }, "ContentBadge": { "type": "string", "description": "A flag that provides additional information about an A+ Content document.", "enum": [ "BULK", "GENERATED", "LAUNCHPAD", "PREMIUM", "STANDARD" ], "x-docgen-enum-table-extension": [ { "value": "BULK", "description": "This content is applied to ASINs in bulk." }, { "value": "GENERATED", "description": "This content is generated by an automated process. If any user modifies this content, it will lose the `GENERATED` badge." }, { "value": "LAUNCHPAD", "description": "Launchpad content." }, { "value": "PREMIUM", "description": "Premium content." }, { "value": "STANDARD", "description": "Standard content." } ] }, "AsinBadgeSet": { "type": "array", "description": "The set of ASIN badges.", "items": { "$ref": "#/definitions/AsinBadge" }, "uniqueItems": true }, "AsinBadge": { "type": "string", "description": "A flag that provides additional information about an ASIN. This is contextual and may change depending on the request that generated it.", "enum": [ "BRAND_NOT_ELIGIBLE", "CATALOG_NOT_FOUND", "CONTENT_NOT_PUBLISHED", "CONTENT_PUBLISHED" ], "x-docgen-enum-table-extension": [ { "value": "BRAND_NOT_ELIGIBLE", "description": "This ASIN is not part of the current user's brand. If the current user corrects their brand registration to include this ASIN, it will lose the `BRAND_NOT_ELIGIBLE` badge." }, { "value": "CATALOG_NOT_FOUND", "description": "This ASIN was not found in the Amazon catalog. If any user creates or restores this ASIN, it will lose the `CATALOG_NOT_FOUND` badge." }, { "value": "CONTENT_NOT_PUBLISHED", "description": "This ASIN does not have the specified A+ Content published to it. If the current user publishes the specified content for this ASIN, it will lose the `CONTENT_NOT_PUBLISHED` badge." }, { "value": "CONTENT_PUBLISHED", "description": "This ASIN has the specified A+ Content published to it. If the current user suspends the specified content for this ASIN, it will lose the `CONTENT_PUBLISHED` badge." } ] }, "MarketplaceId": { "type": "string", "minLength": 1, "description": "The identifier for the Amazon store where the A+ Content is published." }, "LanguageTag": { "type": "string", "minLength": 5, "description": "The IETF language tag. This only supports the primary language subtag with one secondary language subtag. The secondary language subtag is almost always a regional designation. This does not support additional subtags beyond the primary and secondary subtags.\n**Pattern:** `^[a-z]{2,}-[A-Z0-9]{2,}$`" }, "AsinSet": { "type": "array", "description": "The set of ASINs.", "items": { "$ref": "#/definitions/Asin" }, "uniqueItems": true }, "Asin": { "type": "string", "minLength": 10, "description": "The Amazon Standard Identification Number (ASIN)." }, "AsinMetadataSet": { "type": "array", "description": "The set of ASIN metadata.", "items": { "$ref": "#/definitions/AsinMetadata" }, "uniqueItems": true }, "AsinMetadata": { "type": "object", "required": [ "asin" ], "properties": { "asin": { "$ref": "#/definitions/Asin" }, "badgeSet": { "$ref": "#/definitions/AsinBadgeSet" }, "parent": { "$ref": "#/definitions/Asin" }, "title": { "type": "string", "description": "The title for the ASIN in the Amazon catalog.", "minLength": 1 }, "imageUrl": { "type": "string", "description": "The default image for the ASIN in the Amazon catalog.", "minLength": 1 }, "contentReferenceKeySet": { "$ref": "#/definitions/ContentReferenceKeySet" } }, "description": "The A+ Content ASIN with additional metadata for content management. If you don't include the `includedDataSet` parameter in a call to the `listContentDocumentAsinRelations` operation, the related ASINs are returned without metadata." }, "PublishRecordList": { "type": "array", "description": "A list of A+ Content publishing records.", "items": { "$ref": "#/definitions/PublishRecord" }, "uniqueItems": false }, "PublishRecord": { "type": "object", "required": [ "asin", "contentReferenceKey", "contentType", "locale", "marketplaceId" ], "properties": { "marketplaceId": { "$ref": "#/definitions/MarketplaceId" }, "locale": { "$ref": "#/definitions/LanguageTag" }, "asin": { "$ref": "#/definitions/Asin" }, "contentType": { "$ref": "#/definitions/ContentType" }, "contentSubType": { "$ref": "#/definitions/ContentSubType" }, "contentReferenceKey": { "$ref": "#/definitions/ContentReferenceKey" } }, "description": "The full context for an A+ Content publishing event." }, "ContentReferenceKeySet": { "type": "array", "description": "A set of content reference keys.", "items": { "$ref": "#/definitions/ContentReferenceKey" }, "uniqueItems": true }, "ContentReferenceKey": { "type": "string", "minLength": 1, "description": "A unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier." }, "PageToken": { "type": "string", "minLength": 1, "description": "A page token that is returned when the results of the call exceed the page size. To get another page of results, call the operation again, passing in this value with the `pageToken` parameter." }, "ImageCropSpecification": { "type": "object", "required": [ "size" ], "properties": { "size": { "$ref": "#/definitions/ImageDimensions" }, "offset": { "$ref": "#/definitions/ImageOffsets" } }, "description": "The instructions for optionally cropping an image. If no cropping is desired, set the dimensions to the original image size. If the image is cropped and no offset values are provided, then the coordinates of the top left corner of the cropped image, relative to the original image, are defaulted to (0,0)." }, "ImageDimensions": { "type": "object", "required": [ "height", "width" ], "properties": { "width": { "$ref": "#/definitions/IntegerWithUnits" }, "height": { "$ref": "#/definitions/IntegerWithUnits" } }, "description": "The dimensions extending from the top left corner of the cropped image, or the top left corner of the original image if there is no cropping. Only `pixels` is allowed as the units value for ImageDimensions." }, "ImageOffsets": { "type": "object", "required": [ "x", "y" ], "properties": { "x": { "$ref": "#/definitions/IntegerWithUnits" }, "y": { "$ref": "#/definitions/IntegerWithUnits" } }, "description": "The top left corner of the cropped image, specified in the original image's coordinate space." }, "IntegerWithUnits": { "type": "object", "required": [ "units", "value" ], "properties": { "value": { "type": "integer", "description": "The dimension value." }, "units": { "type": "string", "description": "The unit of measurement." } }, "description": "A whole number dimension and its unit of measurement. For example, this can represent 100 pixels." }, "ContentRecord": { "type": "object", "description": "A content document with additional information for content management.", "required": [ "contentReferenceKey" ], "properties": { "contentReferenceKey": { "$ref": "#/definitions/ContentReferenceKey" }, "contentMetadata": { "$ref": "#/definitions/ContentMetadata" }, "contentDocument": { "$ref": "#/definitions/ContentDocument" } } }, "ContentDocument": { "type": "object", "required": [ "contentModuleList", "contentType", "locale", "name" ], "properties": { "name": { "type": "string", "description": "The A+ Content document name.", "minLength": 1, "maxLength": 100 }, "contentType": { "$ref": "#/definitions/ContentType" }, "contentSubType": { "$ref": "#/definitions/ContentSubType" }, "locale": { "$ref": "#/definitions/LanguageTag" }, "contentModuleList": { "$ref": "#/definitions/ContentModuleList" } }, "description": "The A+ Content document. This is the enhanced content that is published to product detail pages." }, "ContentModuleList": { "type": "array", "description": "A list of A+ Content modules.", "items": { "$ref": "#/definitions/ContentModule" }, "uniqueItems": false, "minItems": 1, "maxItems": 100 }, "ContentModule": { "type": "object", "required": [ "contentModuleType" ], "properties": { "contentModuleType": { "$ref": "#/definitions/ContentModuleType" }, "standardCompanyLogo": { "$ref": "#/definitions/StandardCompanyLogoModule" }, "standardComparisonTable": { "$ref": "#/definitions/StandardComparisonTableModule" }, "standardFourImageText": { "$ref": "#/definitions/StandardFourImageTextModule" }, "standardFourImageTextQuadrant": { "$ref": "#/definitions/StandardFourImageTextQuadrantModule" }, "standardHeaderImageText": { "$ref": "#/definitions/StandardHeaderImageTextModule" }, "standardImageSidebar": { "$ref": "#/definitions/StandardImageSidebarModule" }, "standardImageTextOverlay": { "$ref": "#/definitions/StandardImageTextOverlayModule" }, "standardMultipleImageText": { "$ref": "#/definitions/StandardMultipleImageTextModule" }, "standardProductDescription": { "$ref": "#/definitions/StandardProductDescriptionModule" }, "standardSingleImageHighlights": { "$ref": "#/definitions/StandardSingleImageHighlightsModule" }, "standardSingleImageSpecsDetail": { "$ref": "#/definitions/StandardSingleImageSpecsDetailModule" }, "standardSingleSideImage": { "$ref": "#/definitions/StandardSingleSideImageModule" }, "standardTechSpecs": { "$ref": "#/definitions/StandardTechSpecsModule" }, "standardText": { "$ref": "#/definitions/StandardTextModule" }, "standardThreeImageText": { "$ref": "#/definitions/StandardThreeImageTextModule" }, "premiumImageText": { "$ref": "#/definitions/PremiumImageTextModule" }, "premiumText": { "$ref": "#/definitions/PremiumTextModule" }, "premiumFullBackgroundText": { "$ref": "#/definitions/PremiumFullBackgroundTextModule" }, "premiumFullBackgroundImage": { "$ref": "#/definitions/PremiumFullBackgroundImageModule" }, "premiumFourColumnImages": { "$ref": "#/definitions/PremiumFourColumnImagesModule" }, "premiumDualImageText": { "$ref": "#/definitions/PremiumDualImageTextModule" }, "premiumImageCarousel": { "$ref": "#/definitions/PremiumImageCarouselModule" }, "premiumNavigationCarousel": { "$ref": "#/definitions/PremiumNavigationCarouselModule" }, "premiumRegimenCarousel": { "$ref": "#/definitions/PremiumRegimenCarouselModule" }, "premiumThreeColumnComparison": { "$ref": "#/definitions/PremiumThreeColumnComparisonModule" }, "premiumComparisonCarousel": { "$ref": "#/definitions/PremiumComparisonCarouselModule" }, "premiumComparisonScroller": { "$ref": "#/definitions/PremiumComparisonScrollerModule" }, "premiumHotspotImage": { "$ref": "#/definitions/PremiumHotspotImageModule" }, "premiumHotspotImageText": { "$ref": "#/definitions/PremiumHotspotImageTextModule" }, "premiumFaq": { "$ref": "#/definitions/PremiumFaqModule" }, "premiumTechSpecs": { "$ref": "#/definitions/PremiumTechSpecsModule" }, "premiumVideoText": { "$ref": "#/definitions/PremiumVideoTextModule" }, "premiumHeroVideo": { "$ref": "#/definitions/PremiumHeroVideoModule" }, "premiumVideoImageCarousel": { "$ref": "#/definitions/PremiumVideoImageCarouselModule" }, "brandStoryImageWithLogo": { "$ref": "#/definitions/BrandStoryImageWithLogoModule" }, "brandStoryFourAsin": { "$ref": "#/definitions/BrandStoryFourAsinModule" }, "brandStoryMediaAsset": { "$ref": "#/definitions/BrandStoryMediaAssetModule" }, "brandStoryAbout": { "$ref": "#/definitions/BrandStoryAboutModule" }, "brandStoryQuestions": { "$ref": "#/definitions/BrandStoryQuestionsModule" } }, "description": "An A+ Content module. An A+ Content document is composed of content modules. The contentModuleType property selects which content module types to use." }, "ContentModuleType": { "type": "string", "description": "The type of A+ Content module.", "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", "PREMIUM_IMAGE_TEXT", "PREMIUM_TEXT", "PREMIUM_FULL_BACKGROUND_TEXT", "PREMIUM_FULL_BACKGROUND_IMAGE", "PREMIUM_FOUR_COLUMN_IMAGES", "PREMIUM_DUAL_IMAGE_TEXT", "PREMIUM_IMAGE_CAROUSEL", "PREMIUM_NAVIGATION_CAROUSEL", "PREMIUM_REGIMEN_CAROUSEL", "PREMIUM_THREE_COLUMN_COMPARISON", "PREMIUM_COMPARISON_CAROUSEL", "PREMIUM_COMPARISON_SCROLLER", "PREMIUM_HOTSPOT_IMAGE", "PREMIUM_HOTSPOT_IMAGE_TEXT", "PREMIUM_FAQ", "PREMIUM_TECH_SPECS", "PREMIUM_VIDEO_TEXT", "PREMIUM_HERO_VIDEO", "PREMIUM_VIDEO_IMAGE_CAROUSEL", "BRAND_STORY_IMAGE_WITH_LOGO", "BRAND_STORY_FOUR_ASIN", "BRAND_STORY_MEDIA_ASSET", "BRAND_STORY_ABOUT", "BRAND_STORY_QUESTIONS" ], "x-docgen-enum-table-extension": [ { "value": "STANDARD_COMPANY_LOGO", "description": "The standard company logo image." }, { "value": "STANDARD_COMPARISON_TABLE", "description": "The standard product comparison table or chart." }, { "value": "STANDARD_FOUR_IMAGE_TEXT", "description": "Four standard images with text, presented across a single row." }, { "value": "STANDARD_FOUR_IMAGE_TEXT_QUADRANT", "description": "Four standard images with text, presented on a grid of four quadrants." }, { "value": "STANDARD_HEADER_IMAGE_TEXT", "description": "Standard headline text, an image, and body text." }, { "value": "STANDARD_IMAGE_SIDEBAR", "description": "Two images, two paragraphs, and two bulleted lists. One image is smaller and is displayed in the sidebar." }, { "value": "STANDARD_IMAGE_TEXT_OVERLAY", "description": "A standard background image with a floating text box." }, { "value": "STANDARD_MULTIPLE_IMAGE_TEXT", "description": "Standard images with text, presented one at a time. The user clicks on thumbnails to view each block." }, { "value": "STANDARD_PRODUCT_DESCRIPTION", "description": "Standard product description text." }, { "value": "STANDARD_SINGLE_IMAGE_HIGHLIGHTS", "description": "A standard image with several paragraphs and a bulleted list." }, { "value": "STANDARD_SINGLE_IMAGE_SPECS_DETAIL", "description": "A standard image with paragraphs and a bulleted list, and extra space for technical details." }, { "value": "STANDARD_SINGLE_SIDE_IMAGE", "description": "A standard headline and body text with an image on the side." }, { "value": "STANDARD_TECH_SPECS", "description": "The standard table of technical feature names and definitions." }, { "value": "STANDARD_TEXT", "description": "Standard headline and body text." }, { "value": "STANDARD_THREE_IMAGE_TEXT", "description": "Three standard images with text, presented across one row." }, { "value": "PREMIUM_IMAGE_TEXT", "description": "A single image paired with text, positioned side by side. The image can appear on the left or right of the text block." }, { "value": "PREMIUM_TEXT", "description": "A text-only module with headline and body text, allowing greater character limits than other modules for explaining more details or instructions on your product." }, { "value": "PREMIUM_FULL_BACKGROUND_TEXT", "description": "A full-width background image with a text overlay box containing subheadline, headline, and body text. The text box can be positioned to the left or right, and styled light or dark." }, { "value": "PREMIUM_FULL_BACKGROUND_IMAGE", "description": "A full-width background image that spans the entire module width, with optional headline and body text below." }, { "value": "PREMIUM_FOUR_COLUMN_IMAGES", "description": "Four images displayed in a row with a single headline above. Each image has its own subheadline and body text." }, { "value": "PREMIUM_DUAL_IMAGE_TEXT", "description": "Two images displayed side by side with a single headline above. Each image has its own subheadline and body text." }, { "value": "PREMIUM_IMAGE_CAROUSEL", "description": "A carousel of full-width image panels, each with its own headline and body text. Users swipe or click through panels." }, { "value": "PREMIUM_NAVIGATION_CAROUSEL", "description": "A carousel of full-width image panels with clickable navigation tabs. Each panel has its own navigation text, subheadline, headline, and body text." }, { "value": "PREMIUM_REGIMEN_CAROUSEL", "description": "A carousel with a module headline, full-width image panels, and navigation tabs. Each panel has its own inset headline, inset body text, and navigation text." }, { "value": "PREMIUM_THREE_COLUMN_COMPARISON", "description": "A comparison table displaying products side by side with features, tooltips, and detail rows." }, { "value": "PREMIUM_COMPARISON_CAROUSEL", "description": "A comparison table with product images, headline per product, and feature rows with text." }, { "value": "PREMIUM_COMPARISON_SCROLLER", "description": "A scrollable comparison view with full-height product images, chart headline, and feature rows with text per product." }, { "value": "PREMIUM_HOTSPOT_IMAGE", "description": "A full-width image with clickable hotspot markers that reveal headline and descriptive text for each point of interest." }, { "value": "PREMIUM_HOTSPOT_IMAGE_TEXT", "description": "A full-width image with clickable hotspot markers, plus a module headline and body text above the image." }, { "value": "PREMIUM_FAQ", "description": "A list of question-and-answer pairs with a configurable background color scheme of light or dark." }, { "value": "PREMIUM_TECH_SPECS", "description": "A structured list of specification-definition pairs with a headline, for presenting key technical details of your product." }, { "value": "PREMIUM_VIDEO_TEXT", "description": "A video paired with text containing subheadline, headline, and body text. The video can appear on the left or right of the text block." }, { "value": "PREMIUM_HERO_VIDEO", "description": "A full-width video with optional headline and body text below." }, { "value": "PREMIUM_VIDEO_IMAGE_CAROUSEL", "description": "A carousel of panels, each containing a video or image with its own panel headline, subheadline, and body text. A module headline appears above the carousel." }, { "value": "BRAND_STORY_IMAGE_WITH_LOGO", "description": "The required background card for all Brand Story Content. Provides a full-width background image with a Brand logo overlay, headline, and body text. All other Brand Story modules appear within this carousel." }, { "value": "BRAND_STORY_FOUR_ASIN", "description": "A Brand Story card displaying up to four product ASINs with images, enabling cross-selling to other products in your catalog." }, { "value": "BRAND_STORY_MEDIA_ASSET", "description": "A Brand Story card featuring a single image as the primary visual element." }, { "value": "BRAND_STORY_ABOUT", "description": "A Brand Story card with text-focused content for telling your Brand's story, mission, or values." }, { "value": "BRAND_STORY_QUESTIONS", "description": "A Brand Story card with question-and-answer pairs about your Brand." } ] }, "PremiumImageTextModule": { "description": "A single image paired with text, positioned side by side. The image can appear on the left or right of the text block.", "type": "object", "properties": { "positionType": { "$ref": "#/definitions/PositionType" }, "subheadline": { "$ref": "#/definitions/TextComponent" }, "headline": { "$ref": "#/definitions/TextComponent" }, "bodyText": { "$ref": "#/definitions/ParagraphComponent" }, "image": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "positionType", "headline", "image" ] }, "PremiumTextModule": { "description": "A text-only module with headline and body text, allowing greater character limits than other modules for explaining more details or instructions on your product.", "type": "object", "properties": { "description": { "$ref": "#/definitions/ParagraphComponent" }, "headline": { "$ref": "#/definitions/TextComponent" } }, "required": [ "description" ] }, "PremiumFullBackgroundTextModule": { "description": "A full-width background image with a text overlay box containing subheadline, headline, and body text. The text box can be positioned to the left or right, and styled light or dark.", "type": "object", "properties": { "positionType": { "$ref": "#/definitions/PositionType" }, "colorType": { "$ref": "#/definitions/ColorType" }, "subheadline": { "$ref": "#/definitions/TextComponent" }, "headline": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "positionType", "colorType", "desktopImage", "mobileImage" ] }, "PremiumFullBackgroundImageModule": { "description": "A full-width background image that spans the entire module width, with optional headline and body text below.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "footer": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "desktopImage", "mobileImage" ] }, "PremiumFourColumnImagesModule": { "description": "Four images displayed in a row with a single headline above. Each image has its own subheadline and body text.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "columns": { "description": "The collection of image columns, which must contain between 3 and 4 columns.", "type": "array", "items": { "$ref": "#/definitions/ImageColumns" }, "minItems": 3, "maxItems": 4 } }, "required": [ "columns" ] }, "PremiumDualImageTextModule": { "description": "Two images displayed side by side with a single headline above. Each image has its own subheadline and body text.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "columns": { "description": "The collection of image columns, which must contain exactly 2 columns.", "type": "array", "items": { "$ref": "#/definitions/ImageColumns" }, "minItems": 2, "maxItems": 2 } }, "required": [ "columns" ] }, "PremiumImageCarouselModule": { "description": "A carousel of full-width image panels, each with its own headline and body text. Users swipe or click through panels.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "footer": { "$ref": "#/definitions/ParagraphComponent" }, "carouselCards": { "description": "The collection of image panels, which must contain between 2 and 6 panels.", "type": "array", "items": { "$ref": "#/definitions/ImageCarouselPanels" }, "minItems": 2, "maxItems": 6 } }, "required": [ "carouselCards" ] }, "PremiumNavigationCarouselModule": { "description": "A carousel of full-width image panels with clickable navigation tabs. Each panel has its own navigation text, subheadline, headline, and body text.", "type": "object", "properties": { "carouselCards": { "description": "The collection of navigation panels, which must contain between 2 and 5 panels.", "type": "array", "items": { "$ref": "#/definitions/NavigationCarouselPanels" }, "minItems": 2, "maxItems": 5 } }, "required": [ "carouselCards" ] }, "PremiumRegimenCarouselModule": { "description": "A carousel with a module headline, full-width image panels, and navigation tabs. Each panel has its own inset headline, inset body text, and navigation text.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "carouselCards": { "description": "The collection of regimen panels, which must contain between 2 and 5 panels.", "type": "array", "items": { "$ref": "#/definitions/RegimenCarouselPanels" }, "minItems": 2, "maxItems": 5 } }, "required": [ "carouselCards" ] }, "PremiumThreeColumnComparisonModule": { "description": "A comparison table displaying products side by side with features, tooltips, and detail rows.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "comparisonProducts": { "description": "The three products being compared. Exactly three products are required.", "type": "array", "items": { "$ref": "#/definitions/ThreeColumnComparisonProduct" }, "minItems": 3, "maxItems": 3 }, "comparisonRows": { "description": "The rows of the comparison table. Each row represents a metric compared across all three products.", "type": "array", "items": { "$ref": "#/definitions/ThreeColumnComparisonRow" }, "minItems": 2, "maxItems": 5 } }, "required": [ "headline", "comparisonProducts", "comparisonRows" ] }, "PremiumComparisonCarouselModule": { "description": "A comparison table with product images, headline per product, and feature rows with text.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "comparisonProducts": { "description": "The collection of comparison products, which must contain between 3 and 5 products.", "type": "array", "items": { "$ref": "#/definitions/ComparisonProducts" }, "minItems": 3, "maxItems": 5 }, "comparisonMetrics": { "description": "The collection of comparison metrics, which must contain between 3 and 7 metrics.", "type": "array", "items": { "$ref": "#/definitions/ComparisonMetrics" }, "minItems": 3, "maxItems": 7 } }, "required": [ "headline", "comparisonProducts", "comparisonMetrics" ] }, "PremiumComparisonScrollerModule": { "description": "A scrollable comparison view with full-height product images, chart headline, and feature rows with text per product.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "showATC": { "description": "Whether to show Add to Cart buttons.", "type": "boolean" }, "showPrices": { "description": "Whether to show product prices.", "type": "boolean" }, "showReviews": { "description": "Whether to show product reviews.", "type": "boolean" }, "comparisonProducts": { "description": "The collection of comparison products, which must contain between 3 and 7 products.", "type": "array", "items": { "$ref": "#/definitions/ComparisonProducts" }, "minItems": 3, "maxItems": 7 }, "comparisonRows": { "description": "The collection of comparison rows, which must contain between 5 and 12 rows.", "type": "array", "items": { "$ref": "#/definitions/ComparisonMetrics" }, "minItems": 5, "maxItems": 12 } }, "required": [ "headline", "comparisonProducts", "comparisonRows" ] }, "PremiumHotspotImageModule": { "description": "A full-width image with clickable hotspot markers that reveal headline and descriptive text for each point of interest.", "type": "object", "properties": { "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "hotSpots": { "description": "The collection of hotspots, which must contain between 2 and 6 hotspots.", "type": "array", "items": { "$ref": "#/definitions/ImageHotSpots" }, "minItems": 2, "maxItems": 6 } }, "required": [ "desktopImage", "hotSpots" ] }, "PremiumHotspotImageTextModule": { "description": "A full-width image with clickable hotspot markers, plus a module headline and body text above the image.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "mainDescription": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "hotSpots": { "description": "The collection of hotspots, which must contain between 2 and 6 hotspots.", "type": "array", "items": { "$ref": "#/definitions/ImageTextHotSpots" }, "minItems": 2, "maxItems": 6 } }, "required": [ "headline", "desktopImage", "hotSpots" ] }, "PremiumFaqModule": { "description": "A list of question-and-answer pairs with a configurable background color scheme of light or dark.", "type": "object", "properties": { "colorType": { "$ref": "#/definitions/ColorType" }, "faqs": { "description": "The collection of FAQ entries, which must contain between 2 and 5 FAQs.", "type": "array", "items": { "$ref": "#/definitions/Faqs" }, "minItems": 2, "maxItems": 5 } }, "required": [ "faqs" ] }, "PremiumTechSpecsModule": { "description": "A structured list of specification-definition pairs with a headline, for presenting key technical details of your product.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "columnCount": { "description": "The number of columns to display in the technical specifications table, with options between 1 and 2 columns.", "type": "integer", "minimum": 1, "maximum": 2 }, "techSpecs": { "description": "The collection of technical specifications, which must contain between 4 and 16 technical specifications.", "type": "array", "items": { "$ref": "#/definitions/TechSpecs" }, "minItems": 4, "maxItems": 16 } }, "required": [ "headline", "techSpecs" ] }, "PremiumVideoTextModule": { "description": "A video paired with text containing subheadline, headline, and body text. The video can appear on the left or right of the text block.", "type": "object", "properties": { "positionType": { "$ref": "#/definitions/PositionType" }, "title": { "$ref": "#/definitions/TextComponent" }, "headline": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "video": { "$ref": "#/definitions/VideoComponent" } }, "required": [ "positionType", "headline", "video" ] }, "PremiumHeroVideoModule": { "description": "A full-width video with optional headline and body text below.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "heroVideo": { "$ref": "#/definitions/VideoComponent" }, "footer": { "$ref": "#/definitions/ParagraphComponent" } }, "required": [ "heroVideo" ] }, "PremiumVideoImageCarouselModule": { "description": "A carousel of panels, each containing a video or image with its own panel headline, subheadline, and body text. A module headline appears above the carousel.", "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "carouselCards": { "description": "The list of carousel panels, between 2 and 6 items.", "type": "array", "items": { "$ref": "#/definitions/VideoImageCarouselPanels" }, "minItems": 2, "maxItems": 6 } }, "required": [ "carouselCards" ] }, "BrandStoryImageWithLogoModule": { "description": "The required background card for all Brand Story Content. Provides a full-width background image with a Brand logo overlay, headline, and body text. All other Brand Story modules appear within this carousel.", "type": "object", "properties": { "title": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "desktopImage", "mobileImage" ] }, "BrandStoryFourAsinModule": { "description": "A Brand Story card displaying up to four product ASINs with images, enabling cross-selling to other products in your catalog.", "type": "object", "properties": { "title": { "$ref": "#/definitions/TextComponent" }, "brandStoreId": { "$ref": "#/definitions/TextComponent" }, "asinImages": { "description": "Exactly 4 ASIN image entries.", "type": "array", "items": { "$ref": "#/definitions/AsinImages" }, "minItems": 4, "maxItems": 4 } }, "required": [ "title", "asinImages" ] }, "BrandStoryMediaAssetModule": { "description": "A Brand Story card featuring a single image as the primary visual element.", "type": "object", "properties": { "title": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "image": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "image" ] }, "BrandStoryAboutModule": { "description": "A Brand Story card with text-focused content for telling your Brand's story, mission, or values.", "type": "object", "properties": { "logoImage": { "$ref": "#/definitions/ImageComponent" }, "title": { "$ref": "#/definitions/TextComponent" }, "slogan": { "$ref": "#/definitions/ParagraphComponent" } }, "required": [ "logoImage" ] }, "BrandStoryQuestionsModule": { "description": "A Brand Story card with question-and-answer pairs about your Brand.", "type": "object", "properties": { "questionAnswerPairs": { "description": "Exactly 3 question-answer pairs.", "type": "array", "items": { "$ref": "#/definitions/QuestionAnswerPairs" }, "minItems": 3, "maxItems": 3 } }, "required": [ "questionAnswerPairs" ] }, "VideoComponent": { "description": "A reference to a video asset hosted within A+, including metadata and a preview thumbnail image.", "type": "object", "properties": { "videoMediaId": { "description": "This identifier is provided by the create media response, used to locate an uploaded video file.", "type": "string", "minLength": 1 }, "imageMediaId": { "description": "This identifier is provided by the create media response, used to locate an uploaded image file.", "type": "string", "minLength": 1 }, "imageCropSpecification": { "$ref": "#/definitions/ImageCropSpecification" } }, "required": [ "videoMediaId", "imageMediaId", "imageCropSpecification" ] }, "ImageColumn": { "description": "A single column within a multi-column premium image module, containing an image, an optional headline, and an optional description.", "type": "object", "properties": { "position": { "description": "Location of the column within the module.", "type": "integer", "minimum": 1 }, "image": { "$ref": "#/definitions/ImageComponent" }, "headline": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" } }, "required": [ "image", "position" ] }, "ImageColumns": { "description": "Wrapper for a repeated image column entry in a multi-column premium image module.", "type": "object", "properties": { "imageColumn": { "$ref": "#/definitions/ImageColumn" } }, "required": [ "imageColumn" ] }, "ImageCarouselPanel": { "description": "A single panel within the image carousel that features rich text elements, a direct link to a product ASIN, and an image.", "type": "object", "properties": { "position": { "description": "The position of the panel within the carousel. Must be a value between 1 and 6.", "type": "integer", "minimum": 1, "maximum": 6 }, "title": { "$ref": "#/definitions/TextComponent" }, "buttonText": { "$ref": "#/definitions/TextComponent" }, "asin": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "position", "desktopImage", "mobileImage" ] }, "ImageCarouselPanels": { "description": "A wrapper object for a single image carousel panel.", "type": "object", "properties": { "imagePanel": { "$ref": "#/definitions/ImageCarouselPanel" } }, "required": [ "imagePanel" ] }, "NavigationCarouselPanel": { "description": "A single panel within the navigation carousel that features rich text elements and an image.", "type": "object", "properties": { "position": { "description": "The position of this panel within the carousel. Must be a value between 1 and 5.", "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "$ref": "#/definitions/TextComponent" }, "navText": { "$ref": "#/definitions/TextComponent" }, "subtitle": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "position", "navText", "desktopImage", "mobileImage" ] }, "NavigationCarouselPanels": { "description": "A wrapper object for a single navigation carousel panel.", "type": "object", "properties": { "navigationPanel": { "$ref": "#/definitions/NavigationCarouselPanel" } }, "required": [ "navigationPanel" ] }, "RegimenCarouselPanel": { "description": "A single panel within the regimen carousel that features rich text elements and an image.", "type": "object", "properties": { "position": { "description": "The position of the panel within the carousel. Must be a value between 1 and 5.", "type": "integer", "minimum": 1, "maximum": 5 }, "title": { "$ref": "#/definitions/TextComponent" }, "navText": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "position", "navText", "desktopImage", "mobileImage" ] }, "RegimenCarouselPanels": { "description": "A wrapper object for a single regimen carousel panel.", "type": "object", "properties": { "regimenPanel": { "$ref": "#/definitions/RegimenCarouselPanel" } }, "required": [ "regimenPanel" ] }, "VideoImageCarouselPanel": { "description": "A single panel within the video/image carousel containing a video or image with optional text.", "type": "object", "properties": { "position": { "description": "The position of the panel within the carousel. Must be a value between 1 and 6.", "type": "integer", "minimum": 1, "maximum": 6 }, "title": { "$ref": "#/definitions/TextComponent" }, "positionType": { "$ref": "#/definitions/PositionType" }, "subheadline": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/ParagraphComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" }, "video": { "$ref": "#/definitions/VideoComponent" } }, "required": [ "position" ] }, "VideoImageCarouselPanels": { "description": "A wrapper object for a single video/image carousel panel.", "type": "object", "properties": { "videoCarouselPanel": { "$ref": "#/definitions/VideoImageCarouselPanel" } }, "required": [ "videoCarouselPanel" ] }, "ThreeColumnComparisonProduct": { "description": "A product in the three-column comparison table.", "type": "object", "properties": { "position": { "description": "Location of the product within the comparison table. Must be a value between 1 and 3.", "type": "integer", "minimum": 1, "maximum": 3 }, "productTitle": { "$ref": "#/definitions/TextComponent" }, "productAsin": { "$ref": "#/definitions/TextComponent" }, "image": { "$ref": "#/definitions/ImageComponent" } } }, "ThreeColumnComparisonRow": { "description": "A comparison row with metric values for each product.", "type": "object", "properties": { "position": { "description": "Location of the row within the comparison table. Must be a value between 1 and 5.", "type": "integer", "minimum": 1, "maximum": 5 }, "metricValues": { "description": "The metric values for each of the three products in this row. Exactly three items are required.", "type": "array", "items": { "$ref": "#/definitions/MetricValueItem" }, "minItems": 3, "maxItems": 3 } } }, "MetricValueItem": { "description": "A wrapper to hold the metric name and metric value.", "type": "object", "properties": { "metricName": { "$ref": "#/definitions/TextComponent" }, "metricValue": { "$ref": "#/definitions/ParagraphComponent" } } }, "ComparisonFields": { "description": "A wrapper object for a single comparison field.", "type": "object", "properties": { "comparisonField": { "$ref": "#/definitions/PlainTextItem" } }, "required": [ "comparisonField" ] }, "ComparisonProducts": { "description": "A wrapper object for a single comparison product.", "type": "object", "properties": { "comparisonProduct": { "$ref": "#/definitions/ComparisonProduct" } }, "required": [ "comparisonProduct" ] }, "ComparisonMetrics": { "description": "A wrapper object for a single comparison row.", "type": "object", "properties": { "comparisonRow": { "$ref": "#/definitions/ComparisonRow" } }, "required": [ "comparisonRow" ] }, "ComparisonProduct": { "description": "A product in the comparison table carousel modules.", "type": "object", "properties": { "position": { "description": "The position of the product in comparison display.", "type": "integer", "minimum": 1 }, "productTitle": { "$ref": "#/definitions/TextComponent" }, "productAsin": { "$ref": "#/definitions/TextComponent" }, "desktopImage": { "$ref": "#/definitions/ImageComponent" }, "mobileImage": { "$ref": "#/definitions/ImageComponent" } } }, "ComparisonRow": { "description": "Comparison row for table-based comparison modules.", "type": "object", "properties": { "position": { "description": "The position of the comparison row.", "type": "integer", "minimum": 1 }, "metricName": { "$ref": "#/definitions/TextComponent" }, "comparisonType": { "$ref": "#/definitions/TextComponent" }, "additionalInfo": { "$ref": "#/definitions/TextComponent" }, "comparisonFields": { "type": "array", "items": { "$ref": "#/definitions/ComparisonFields" }, "description": "Collection of comparison field values, one set per product." } } }, "ImageTextHotSpot": { "description": "A hotspot with mobile image, title, and coordinates.", "type": "object", "properties": { "mobileImage": { "$ref": "#/definitions/ImageComponent" }, "title": { "$ref": "#/definitions/TextComponent" }, "xCoordinate": { "$ref": "#/definitions/TextComponent" }, "yCoordinate": { "$ref": "#/definitions/TextComponent" } }, "required": [ "mobileImage", "title", "xCoordinate", "yCoordinate" ] }, "ImageTextHotSpots": { "description": "A wrapper object for a single ImageTextHotSpot.", "type": "object", "properties": { "imageTextHotSpot": { "$ref": "#/definitions/ImageTextHotSpot" } }, "required": [ "imageTextHotSpot" ] }, "ImageHotSpot": { "description": "A hotspot with mobile image, title, description, and coordinates.", "type": "object", "properties": { "mobileImage": { "$ref": "#/definitions/ImageComponent" }, "title": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/TextComponent" }, "xCoordinate": { "$ref": "#/definitions/TextComponent" }, "yCoordinate": { "$ref": "#/definitions/TextComponent" } }, "required": [ "mobileImage", "title", "xCoordinate", "yCoordinate" ] }, "ImageHotSpots": { "description": "A wrapper object for a single ImageHotSpot.", "type": "object", "properties": { "imageHotSpot": { "$ref": "#/definitions/ImageHotSpot" } }, "required": [ "imageHotSpot" ] }, "Faq": { "description": "A single frequently asked question with its corresponding answer.", "type": "object", "properties": { "question": { "$ref": "#/definitions/ParagraphComponent" }, "answer": { "$ref": "#/definitions/ParagraphComponent" } }, "required": [ "question", "answer" ] }, "Faqs": { "description": "A wrapper object for a single FAQ entry.", "type": "object", "properties": { "faq": { "$ref": "#/definitions/Faq" } }, "required": [ "faq" ] }, "TechSpec": { "description": "A single technical specification with a key-value pair.", "type": "object", "properties": { "specKey": { "$ref": "#/definitions/TextComponent" }, "specValue": { "$ref": "#/definitions/TextComponent" } }, "required": [ "specKey", "specValue" ] }, "AsinImage": { "description": "A single ASIN product with its associated image.", "type": "object", "properties": { "productAsin": { "$ref": "#/definitions/TextComponent" }, "productImage": { "$ref": "#/definitions/ImageComponent" } }, "required": [ "productAsin", "productImage" ] }, "AsinImages": { "description": "Wrapper for a single ASIN image entry.", "type": "object", "properties": { "asinImage": { "$ref": "#/definitions/AsinImage" } }, "required": [ "asinImage" ] }, "QuestionAnswerPair": { "description": "A single question and answer pair.", "type": "object", "properties": { "question": { "$ref": "#/definitions/TextComponent" }, "answer": { "$ref": "#/definitions/ParagraphComponent" } }, "required": [ "question", "answer" ] }, "QuestionAnswerPairs": { "description": "Wrapper for a single question-answer pair.", "type": "object", "properties": { "questionAnswerPair": { "$ref": "#/definitions/QuestionAnswerPair" } }, "required": [ "questionAnswerPair" ] }, "TechSpecs": { "description": "A wrapper object for a single technical specification.", "type": "object", "properties": { "techSpec": { "$ref": "#/definitions/TechSpec" } }, "required": [ "techSpec" ] }, "StandardCompanyLogoModule": { "type": "object", "required": [ "companyLogo" ], "properties": { "companyLogo": { "$ref": "#/definitions/ImageComponent" } }, "description": "The standard company logo image." }, "StandardComparisonTableModule": { "type": "object", "properties": { "productColumns": { "type": "array", "items": { "$ref": "#/definitions/StandardComparisonProductBlock" }, "maxItems": 6, "minItems": 0 }, "metricRowLabels": { "type": "array", "items": { "$ref": "#/definitions/PlainTextItem" }, "maxItems": 10, "minItems": 0 } }, "description": "The standard product comparison table." }, "StandardFourImageTextModule": { "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "block1": { "$ref": "#/definitions/StandardImageTextBlock" }, "block2": { "$ref": "#/definitions/StandardImageTextBlock" }, "block3": { "$ref": "#/definitions/StandardImageTextBlock" }, "block4": { "$ref": "#/definitions/StandardImageTextBlock" } }, "description": "Four standard images with text, presented across a single row." }, "StandardFourImageTextQuadrantModule": { "type": "object", "required": [ "block1", "block2", "block3", "block4" ], "properties": { "block1": { "$ref": "#/definitions/StandardImageTextBlock" }, "block2": { "$ref": "#/definitions/StandardImageTextBlock" }, "block3": { "$ref": "#/definitions/StandardImageTextBlock" }, "block4": { "$ref": "#/definitions/StandardImageTextBlock" } }, "description": "Four standard images with text, presented on a grid of four quadrants." }, "StandardHeaderImageTextModule": { "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "block": { "$ref": "#/definitions/StandardImageTextBlock" } }, "description": "Standard headline text, an image, and body text." }, "StandardImageSidebarModule": { "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "imageCaptionBlock": { "$ref": "#/definitions/StandardImageCaptionBlock" }, "descriptionTextBlock": { "$ref": "#/definitions/StandardTextBlock" }, "descriptionListBlock": { "$ref": "#/definitions/StandardTextListBlock" }, "sidebarImageTextBlock": { "$ref": "#/definitions/StandardImageTextBlock" }, "sidebarListBlock": { "$ref": "#/definitions/StandardTextListBlock" } }, "description": "Two images, two paragraphs, and two bulleted lists. One image is smaller and displayed in the sidebar." }, "StandardImageTextOverlayModule": { "type": "object", "required": [ "overlayColorType" ], "properties": { "overlayColorType": { "$ref": "#/definitions/ColorType" }, "block": { "$ref": "#/definitions/StandardImageTextBlock" } }, "description": "A standard background image with a floating text box." }, "StandardMultipleImageTextModule": { "type": "object", "properties": { "blocks": { "type": "array", "items": { "$ref": "#/definitions/StandardImageTextCaptionBlock" } } }, "description": "Standard images with text, presented one at a time. The user clicks on thumbnails to view each block." }, "StandardProductDescriptionModule": { "type": "object", "required": [ "body" ], "properties": { "body": { "$ref": "#/definitions/ParagraphComponent" } }, "description": "Standard product description text." }, "StandardSingleImageHighlightsModule": { "type": "object", "properties": { "image": { "$ref": "#/definitions/ImageComponent" }, "headline": { "$ref": "#/definitions/TextComponent" }, "textBlock1": { "$ref": "#/definitions/StandardTextBlock" }, "textBlock2": { "$ref": "#/definitions/StandardTextBlock" }, "textBlock3": { "$ref": "#/definitions/StandardTextBlock" }, "bulletedListBlock": { "$ref": "#/definitions/StandardHeaderTextListBlock" } }, "description": "A standard image with several paragraphs and a bulleted list." }, "StandardSingleImageSpecsDetailModule": { "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "image": { "$ref": "#/definitions/ImageComponent" }, "descriptionHeadline": { "$ref": "#/definitions/TextComponent" }, "descriptionBlock1": { "$ref": "#/definitions/StandardTextBlock" }, "descriptionBlock2": { "$ref": "#/definitions/StandardTextBlock" }, "specificationHeadline": { "$ref": "#/definitions/TextComponent" }, "specificationListBlock": { "$ref": "#/definitions/StandardHeaderTextListBlock" }, "specificationTextBlock": { "$ref": "#/definitions/StandardTextBlock" } }, "description": "A standard image with paragraphs and a bulleted list, and extra space for technical details." }, "StandardSingleSideImageModule": { "type": "object", "required": [ "imagePositionType" ], "properties": { "imagePositionType": { "$ref": "#/definitions/PositionType" }, "block": { "$ref": "#/definitions/StandardImageTextBlock" } }, "description": "A standard headline and body text with an image on the side." }, "StandardTechSpecsModule": { "type": "object", "required": [ "specificationList" ], "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "specificationList": { "type": "array", "items": { "$ref": "#/definitions/StandardTextPairBlock" }, "description": "The specification list.", "maxItems": 16, "minItems": 4 }, "tableCount": { "type": "integer", "description": "The number of tables to present. Features are evenly divided between the tables.", "minimum": 1, "maximum": 2 } }, "description": "The standard table of technical feature names and definitions." }, "StandardTextModule": { "type": "object", "required": [ "body" ], "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "body": { "$ref": "#/definitions/ParagraphComponent" } }, "description": "A standard headline and body text." }, "StandardThreeImageTextModule": { "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "block1": { "$ref": "#/definitions/StandardImageTextBlock" }, "block2": { "$ref": "#/definitions/StandardImageTextBlock" }, "block3": { "$ref": "#/definitions/StandardImageTextBlock" } }, "description": "Three standard images with text, presented across a single row." }, "StandardComparisonProductBlock": { "type": "object", "required": [ "position" ], "properties": { "position": { "type": "integer", "description": "The rank or index of this comparison product block within the module. Different blocks cannot occupy the same position within a single module.", "minimum": 1, "maximum": 6 }, "image": { "$ref": "#/definitions/ImageComponent" }, "title": { "type": "string", "description": "The comparison product title.", "minLength": 1, "maxLength": 80 }, "asin": { "$ref": "#/definitions/Asin" }, "highlight": { "type": "boolean", "description": "Determines whether this block of content is visually highlighted." }, "metrics": { "type": "array", "description": "Comparison metrics for the product.", "items": { "$ref": "#/definitions/PlainTextItem" }, "maxItems": 10, "minItems": 0 } }, "description": "The A+ Content standard comparison product block." }, "StandardHeaderTextListBlock": { "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "block": { "$ref": "#/definitions/StandardTextListBlock" } }, "description": "The A+ standard fixed-length list of text, with a related headline." }, "StandardTextListBlock": { "type": "object", "required": [ "textList" ], "properties": { "textList": { "type": "array", "items": { "$ref": "#/definitions/TextItem" }, "maxItems": 8, "minItems": 0 } }, "description": "The A+ Content standard fixed length list of text, usually presented as bullet points." }, "StandardImageTextCaptionBlock": { "type": "object", "properties": { "block": { "$ref": "#/definitions/StandardImageTextBlock" }, "caption": { "$ref": "#/definitions/TextComponent" } }, "description": "The A+ Content standard image and text block, with a related caption. The caption may not display on all devices." }, "StandardImageCaptionBlock": { "type": "object", "properties": { "image": { "$ref": "#/definitions/ImageComponent" }, "caption": { "$ref": "#/definitions/TextComponent" } }, "description": "The A+ Content standard image and caption block." }, "StandardImageTextBlock": { "type": "object", "properties": { "image": { "$ref": "#/definitions/ImageComponent" }, "headline": { "$ref": "#/definitions/TextComponent" }, "body": { "$ref": "#/definitions/ParagraphComponent" } }, "description": "The A+ Content standard image and text box block." }, "StandardTextBlock": { "type": "object", "properties": { "headline": { "$ref": "#/definitions/TextComponent" }, "body": { "$ref": "#/definitions/ParagraphComponent" } }, "description": "The A+ Content standard text box block, comprised of a paragraph with a headline." }, "StandardTextPairBlock": { "type": "object", "properties": { "label": { "$ref": "#/definitions/TextComponent" }, "description": { "$ref": "#/definitions/TextComponent" } }, "description": "The A+ Content standard label and description block, comprised of a pair of text components." }, "TextItem": { "type": "object", "required": [ "position", "text" ], "properties": { "position": { "type": "integer", "description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection.", "minimum": 1, "maximum": 100 }, "text": { "$ref": "#/definitions/TextComponent" } }, "description": "Rich positional text, usually presented as a collection of bullet points." }, "PlainTextItem": { "type": "object", "required": [ "position", "value" ], "properties": { "position": { "type": "integer", "description": "The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection.", "minimum": 1, "maximum": 100 }, "value": { "type": "string", "description": "The actual plain text.", "minLength": 1, "maxLength": 250 } }, "description": "Plain positional text, used in collections of brief labels and descriptors." }, "ImageComponent": { "type": "object", "required": [ "altText", "imageCropSpecification", "uploadDestinationId" ], "properties": { "uploadDestinationId": { "type": "string", "description": "This identifier is provided by the Selling Partner API for Uploads.", "minLength": 1 }, "imageCropSpecification": { "$ref": "#/definitions/ImageCropSpecification" }, "altText": { "type": "string", "description": "The alternative text for the image.", "minLength": 1, "maxLength": 100 } }, "description": "A reference to an image, hosted in the A+ Content media library." }, "ParagraphComponent": { "type": "object", "required": [ "textList" ], "properties": { "textList": { "type": "array", "items": { "$ref": "#/definitions/TextComponent" }, "maxItems": 100, "minItems": 1 } }, "description": "A list of rich text content, usually presented in a text box." }, "TextComponent": { "type": "object", "required": [ "value" ], "properties": { "value": { "type": "string", "description": "The actual plain text.", "minLength": 1, "maxLength": 10000 }, "decoratorSet": { "$ref": "#/definitions/DecoratorSet" } }, "description": "Rich text content." }, "ColorType": { "type": "string", "description": "The relative color scheme of content.", "enum": [ "DARK", "LIGHT" ], "x-docgen-enum-table-extension": [ { "value": "DARK", "description": "Dark grey, semi-opaque shaded background for light text overlay box." }, { "value": "LIGHT", "description": "White, semi-opaque shaded background for dark text overlay box." } ] }, "PositionType": { "type": "string", "description": "The relative positioning of content.", "enum": [ "LEFT", "RIGHT" ], "x-docgen-enum-table-extension": [ { "value": "LEFT", "description": "Indicates that the content is to be positioned on the left side of the module." }, { "value": "RIGHT", "description": "Indicates that the content is to be positioned on the right side of the module." } ] }, "DecoratorSet": { "type": "array", "description": "A set of content decorators.", "items": { "$ref": "#/definitions/Decorator" }, "uniqueItems": true }, "Decorator": { "type": "object", "properties": { "type": { "$ref": "#/definitions/DecoratorType" }, "offset": { "type": "integer", "description": "The starting character of this decorator within the content string. Use zero for the first character.", "minimum": 0, "maximum": 10000 }, "length": { "type": "integer", "description": "The number of content characters to alter with this decorator. Decorators such as line breaks can have zero length and fit between characters.", "minimum": 0, "maximum": 10000 }, "depth": { "type": "integer", "description": "The relative intensity or variation of this decorator. Decorators such as bullet-points, for example, can have multiple indentation depths.", "minimum": 0, "maximum": 100 } }, "description": "A decorator applied to a content string value in order to create rich text." }, "DecoratorType": { "type": "string", "description": "The type of rich text decorator.", "enum": [ "LIST_ITEM", "LIST_ORDERED", "LIST_UNORDERED", "STYLE_BOLD", "STYLE_ITALIC", "STYLE_LINEBREAK", "STYLE_PARAGRAPH", "STYLE_UNDERLINE" ], "x-docgen-enum-table-extension": [ { "value": "LIST_ITEM", "description": "Formatted list item, used in either numbered or bulleted lists, inside the list enclosure." }, { "value": "LIST_ORDERED", "description": "Numbered list enclosure." }, { "value": "LIST_UNORDERED", "description": "Bulleted list enclosure." }, { "value": "STYLE_BOLD", "description": "Bold text formatting." }, { "value": "STYLE_ITALIC", "description": "Italic text formatting." }, { "value": "STYLE_LINEBREAK", "description": "New line of text." }, { "value": "STYLE_PARAGRAPH", "description": "Paragraph text formatting." }, { "value": "STYLE_UNDERLINE", "description": "Underline text formatting." } ] }, "SearchContentDocumentsResponse": { "allOf": [ { "$ref": "#/definitions/AplusPaginatedResponse" }, { "type": "object", "required": [ "contentMetadataRecords" ], "properties": { "contentMetadataRecords": { "$ref": "#/definitions/ContentMetadataRecordList", "description": "The content metadata records." } } } ] }, "GetContentDocumentResponse": { "allOf": [ { "$ref": "#/definitions/AplusResponse" }, { "type": "object", "required": [ "contentRecord" ], "properties": { "contentRecord": { "$ref": "#/definitions/ContentRecord" } } } ] }, "PostContentDocumentRequest": { "type": "object", "required": [ "contentDocument" ], "properties": { "contentDocument": { "$ref": "#/definitions/ContentDocument" } } }, "PostContentDocumentResponse": { "allOf": [ { "$ref": "#/definitions/AplusResponse" }, { "type": "object", "required": [ "contentReferenceKey" ], "properties": { "contentReferenceKey": { "$ref": "#/definitions/ContentReferenceKey" } } } ] }, "ListContentDocumentAsinRelationsResponse": { "allOf": [ { "$ref": "#/definitions/AplusPaginatedResponse" }, { "type": "object", "required": [ "asinMetadataSet" ], "properties": { "asinMetadataSet": { "$ref": "#/definitions/AsinMetadataSet" } } } ] }, "PostContentDocumentAsinRelationsRequest": { "type": "object", "required": [ "asinSet" ], "properties": { "asinSet": { "$ref": "#/definitions/AsinSet" } } }, "PostContentDocumentAsinRelationsResponse": { "allOf": [ { "$ref": "#/definitions/AplusResponse" } ] }, "ValidateContentDocumentAsinRelationsResponse": { "allOf": [ { "$ref": "#/definitions/AplusResponse" }, { "$ref": "#/definitions/ErrorList" } ] }, "SearchContentPublishRecordsResponse": { "allOf": [ { "$ref": "#/definitions/AplusPaginatedResponse" }, { "type": "object", "required": [ "publishRecordList" ], "properties": { "publishRecordList": { "$ref": "#/definitions/PublishRecordList" } } } ] }, "PostContentDocumentApprovalSubmissionResponse": { "allOf": [ { "$ref": "#/definitions/AplusResponse" } ] }, "PostContentDocumentSuspendSubmissionResponse": { "allOf": [ { "$ref": "#/definitions/AplusResponse" } ] }, "MediaStatus": { "type": "string", "description": "A status value for a media asset or pairing. Multiple statuses can apply simultaneously to represent both the workflow stage and the responsible actor. Workflow statuses describe the processing stage; actor statuses indicate who must take the next action.", "enum": [ "PENDING_PROCESSING", "PENDING_REVIEW", "UNABLE_TO_PROCESS", "NOT_APPROVED", "AVAILABLE", "PENDING_AMAZON", "PENDING_SELLING_PARTNER" ], "x-docgen-enum-table-extension": [ { "value": "PENDING_PROCESSING", "description": "Media is being processed (transcoding, validation)." }, { "value": "PENDING_REVIEW", "description": "Processing complete, awaiting content compliance review." }, { "value": "UNABLE_TO_PROCESS", "description": "Processing failed. May require re-upload or metadata correction." }, { "value": "NOT_APPROVED", "description": "Failed compliance review. May require re-upload or metadata correction." }, { "value": "AVAILABLE", "description": "Available for display in A+ Content." }, { "value": "PENDING_AMAZON", "description": "Amazon is the next actor. Applies when action is required from Amazon." }, { "value": "PENDING_SELLING_PARTNER", "description": "The selling partner is the next actor. Applies when action is required from the seller." } ] }, "AssociationType": { "type": "string", "description": "The type of relationship between media assets.", "enum": [ "VIDEO_PAIRING" ], "x-docgen-enum-table-extension": [ { "value": "VIDEO_PAIRING", "description": "A video paired with a thumbnail image for display in A+ Content." } ] }, "MediaType": { "type": "string", "description": "The type of media asset.", "enum": [ "VIDEO", "IMAGE" ], "x-docgen-enum-table-extension": [ { "value": "VIDEO", "description": "A video media asset." }, { "value": "IMAGE", "description": "An image media asset." } ] }, "Issue": { "type": "object", "description": "An issue associated with a media asset or pairing.", "required": [ "code", "message", "severity", "categories" ], "properties": { "code": { "type": "string", "description": "An issue code that identifies the type of issue." }, "message": { "type": "string", "description": "A message that describes the issue." }, "severity": { "type": "string", "description": "The severity of the issue.", "enum": [ "ERROR", "WARNING", "INFO" ], "x-docgen-enum-table-extension": [ { "value": "ERROR", "description": "Indicates an issue that prevents the media from being published." }, { "value": "WARNING", "description": "Indicates an issue that should be reviewed but does not prevent publishing." }, { "value": "INFO", "description": "Indicates additional information that should be reviewed." } ] }, "propertyNames": { "type": "array", "description": "Names of the properties associated with the issue, if applicable.", "items": { "type": "string" } }, "categories": { "type": "array", "description": "List of issue categories.\n\n**Possible values:**\n\n* `PROCESSING_ISSUE` - Media file could not be processed (codec, duration, corrupt file).\n\n* `CONTENT_POLICY` - Media asset is subject to content policy restrictions.\n\n* `METADATA_VALIDATION` - Media metadata does not meet requirements (title, descriptions).", "items": { "type": "string" }, "example": [ "PROCESSING_ISSUE" ] } } }, "IssueList": { "type": "array", "description": "A list of issues associated with a media asset or pairing.", "items": { "$ref": "#/definitions/Issue" } }, "Description": { "type": "object", "description": "An accessibility description for a specific locale.", "required": [ "locale", "value" ], "properties": { "locale": { "type": "string", "description": "A locale identifier (for example, `en-US`, `de-DE`).", "example": "en-US" }, "value": { "type": "string", "description": "The accessibility description text for the locale.", "example": "A demonstration of the product features and benefits." } } }, "DescriptionList": { "type": "array", "description": "A list of locale-keyed accessibility descriptions. At least one entry is required for video assets.", "items": { "$ref": "#/definitions/Description" } }, "MediaInfo": { "type": "object", "description": "The core media entity attributes without associations.", "required": [ "mediaId", "mediaType", "title", "status" ], "properties": { "mediaId": { "type": "string", "description": "The unique identifier for the media asset.", "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "mediaType": { "$ref": "#/definitions/MediaType", "description": "The type of media asset." }, "title": { "type": "string", "description": "The title for the media asset. For videos, this is the original filename. For images, this is the user-provided title or filename.", "example": "productDemoVideo.mp4" }, "descriptions": { "$ref": "#/definitions/DescriptionList", "description": "Accessibility descriptions for the media asset. Present for video assets only. Shared across all pairings." }, "status": { "type": "array", "description": "The composite status of the media asset. Multiple statuses can apply simultaneously to represent both the workflow stage and the responsible actor.", "items": { "$ref": "#/definitions/MediaStatus" }, "minItems": 1, "uniqueItems": true }, "mediaUrl": { "type": "string", "description": "The CDN URL for downloading or viewing the media asset. The URL is provisioned at upload time and available in all statuses. The media is non-permanent; you should re-retrieve using `getMedia` rather than caching indefinitely.", "example": "https://m.media-amazon.com/images/S/aplus-media-library-service-media/b2c3d4e5-f6a7-8901-bcde-f12345678901.mp4" }, "issues": { "$ref": "#/definitions/IssueList", "description": "Issues associated with the media asset." } } }, "Media": { "description": "A media entity with its related media associations. This is the unified shape used across all media operations.", "allOf": [ { "$ref": "#/definitions/MediaInfo" }, { "type": "object", "properties": { "relatedMedia": { "$ref": "#/definitions/RelatedMediaList", "description": "Related media associations, one level deep. Empty list when no associations exist." } } } ] }, "RelatedMedia": { "type": "object", "description": "A relationship between media assets, representing a pairing with its own title, status, and lifecycle.", "required": [ "associationType", "title", "status", "media" ], "properties": { "associationType": { "$ref": "#/definitions/AssociationType", "description": "The type of relationship." }, "title": { "type": "string", "description": "The title for this pairing. For `VIDEO_PAIRING`, this is the user-provided pairing title. Minimum three words; must not be all capital letters.", "example": "Product Demo Video" }, "status": { "type": "array", "description": "The composite status of this pairing. Multiple statuses can apply simultaneously to represent both the workflow stage and the responsible actor.", "items": { "$ref": "#/definitions/MediaStatus" }, "minItems": 1, "uniqueItems": true }, "issues": { "$ref": "#/definitions/IssueList", "description": "Issues associated with this pairing." }, "media": { "$ref": "#/definitions/MediaInfo", "description": "The associated media asset, without nested associations." } } }, "RelatedMediaList": { "type": "array", "description": "A list of related media associations.", "items": { "$ref": "#/definitions/RelatedMedia" } }, "RelatedMediaInput": { "type": "object", "description": "Input for creating a media association.", "required": [ "associationType", "title", "media" ], "properties": { "associationType": { "$ref": "#/definitions/AssociationType", "description": "The type of relationship to create." }, "title": { "type": "string", "description": "The title for this pairing. Minimum three words for `VIDEO_PAIRING`; must not be all capital letters.", "example": "Product Demo Video" }, "media": { "$ref": "#/definitions/MediaInput", "description": "The media asset to associate." } } }, "RelatedMediaInputList": { "type": "array", "description": "A list of related media inputs for creation.", "items": { "$ref": "#/definitions/RelatedMediaInput" } }, "MediaInput": { "type": "object", "description": "Input for referencing a media asset during creation. Exactly one of `uploadDestinationId` or `mediaId` must be provided.", "required": [ "mediaType" ], "properties": { "mediaType": { "$ref": "#/definitions/MediaType", "description": "The type of media asset." }, "uploadDestinationId": { "type": "string", "description": "The S3 upload destination identifier from the `createUploadDestination` operation, for a newly uploaded asset. Mutually exclusive with `mediaId`.", "example": "aplus-media-library-service-media-upload/7ae2d3b1-00d0-4626-a2b6-5de81e1af0d4.jpg" }, "mediaId": { "type": "string", "description": "An existing media asset identifier for reuse in a new association. Mutually exclusive with `uploadDestinationId`.", "example": "c3d4e5f6-a7b8-9012-cdef-234567890123" }, "title": { "type": "string", "description": "An optional title for the media asset. Defaults to the filename if not provided.", "example": "Product Thumbnail" } } }, "CreateMediaRequest": { "type": "object", "description": "The request body for creating a media asset. Uses the unified media shape as a subset, omitting system-derived fields.", "required": [ "mediaType" ], "properties": { "mediaType": { "$ref": "#/definitions/MediaType", "description": "The type of media asset to create." }, "uploadDestinationId": { "type": "string", "description": "The S3 upload destination identifier from the `createUploadDestination` operation. Mutually exclusive with `mediaId`.", "example": "aplus-media-library-service-media-upload/a1b2c3d4-e5f6-7890-abcd-ef1234567890.mp4" }, "mediaId": { "type": "string", "description": "An existing media asset identifier for reuse. Mutually exclusive with `uploadDestinationId`.", "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "title": { "type": "string", "description": "An optional title for the media asset. For standalone images, defaults to filename if not provided. Not applicable for videos (video title is derived from the filename).", "example": "Product Thumbnail" }, "descriptions": { "$ref": "#/definitions/DescriptionList", "description": "Accessibility descriptions for video assets. Required when `mediaType` is `VIDEO`. At least one entry required." }, "relatedMedia": { "$ref": "#/definitions/RelatedMediaInputList", "description": "Related media to associate during creation. Required when `mediaType` is `VIDEO` (at least one `VIDEO_PAIRING` entry with an image must be provided). Ignored when `mediaType` is `IMAGE`." } } }, "UpdateMediaRequest": { "type": "object", "description": "The request body for updating media metadata. Exactly one of title or descriptions must be provided.", "properties": { "title": { "type": "string", "description": "The updated title. When `associatedMediaId` query parameter is provided, updates the pairing title (minimum 3 words). When absent and `mediaId` is an image, updates the image title.", "example": "Updated Product Demo Video" }, "descriptions": { "$ref": "#/definitions/DescriptionList", "description": "Updated accessibility descriptions. Upserts provided locale entries; omitted locales are preserved. Only valid when `mediaId` refers to a video and `associatedMediaId` is not provided." } } }, "CreateMediaResponse": { "description": "The response for the `createMedia` operation. Returns the full unified Media shape.", "allOf": [ { "$ref": "#/definitions/AplusResponse" }, { "$ref": "#/definitions/Media" } ] }, "GetMediaResponse": { "description": "The response for the `getMedia` operation. Returns the full unified Media shape.", "allOf": [ { "$ref": "#/definitions/AplusResponse" }, { "$ref": "#/definitions/Media" } ] }, "UpdateMediaResponse": { "description": "The response for the updateMedia operation. Returns the full unified Media shape.", "allOf": [ { "$ref": "#/definitions/AplusResponse" }, { "$ref": "#/definitions/Media" } ] } }, "parameters": { "contentReferenceKey": { "name": "contentReferenceKey", "in": "path", "description": "The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.", "required": true, "type": "string", "minLength": 1 }, "marketplaceId": { "name": "marketplaceId", "in": "query", "description": "The identifier for the Amazon store where the A+ Content is published.", "required": true, "type": "string", "minLength": 1 }, "pageToken": { "name": "pageToken", "in": "query", "description": "A page token from the `nextPageToken` response element returned by your previous call to this operation. `nextPageToken` is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include `pageToken` as the only parameter. Specifying `pageToken` with any other parameter will cause the request to fail. When no `nextPageToken` value is returned there are no more pages to return. A `pageToken` value is not usable across different operations.", "required": false, "type": "string", "minLength": 1 }, "asinSet": { "name": "asinSet", "in": "query", "description": "The set of ASINs.", "required": false, "type": "array", "items": { "type": "string", "minLength": 10 }, "collectionFormat": "csv", "uniqueItems": true }, "asin": { "name": "asin", "in": "query", "description": "The Amazon Standard Identification Number (ASIN).", "required": true, "type": "string", "minLength": 10 }, "getContentDocumentIncludedDataSet": { "name": "includedDataSet", "in": "query", "description": "The set of A+ data types to include in the response.", "required": true, "type": "array", "items": { "type": "string", "enum": [ "CONTENTS", "METADATA" ] }, "collectionFormat": "csv", "minItems": 1, "uniqueItems": true }, "listContentDocumentAsinRelationsIncludedDataSet": { "name": "includedDataSet", "in": "query", "description": "The set of A+ data types to include in the response.", "required": false, "type": "array", "items": { "type": "string", "enum": [ "METADATA" ] }, "collectionFormat": "csv", "minItems": 0, "uniqueItems": true } } }