A+ Content Management API v2020-11-01 Reference
Add rich marketing content to Amazon product detail pages.
Use the A+ Content API to build applications that help selling partners add rich marketing content to their Amazon product detail pages. Selling partners can use A+ content to share their brand and product story, which helps buyers make informed purchasing decisions. Selling partners use content modules to add images and text.
Version information
Version : 2020-11-01
Contact information
Contact : Selling Partner API Developer Support
Contact URL : https://sellercentral.amazon.com/gp/mws/contactus.html
License information
License : Apache License 2.0
License URL : http://www.apache.org/licenses/LICENSE-2.0
URI scheme
Host : sellingpartnerapi-na.amazon.com
Schemes : HTTPS
Consumes
application/json
Produces
application/json
Operations
searchContentDocuments
createContentDocument
getContentDocument
updateContentDocument
listContentDocumentAsinRelations
postContentDocumentAsinRelations
validateContentDocumentAsinRelations
searchContentPublishRecords
postContentDocumentApprovalSubmission
postContentDocumentSuspendSubmission
Paths
GET /aplus/2020-11-01/contentDocuments
Operation: searchContentDocuments
Description
Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the getContentDocument operation.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Query | pageToken optional | A token that you use to fetch a specific page when there are multiple pages of results. minLength : 1 | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SearchContentDocumentsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
POST /aplus/2020-11-01/contentDocuments
Operation: createContentDocument
Description
Creates a new A+ Content document.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Body | postContentDocumentRequest required | The content document request details. | PostContentDocumentRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | PostContentDocumentResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /aplus/2020-11-01/contentDocuments/{contentReferenceKey}
Operation: getContentDocument
Description
Returns an A+ Content document, if available.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | contentReferenceKey required | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier. minLength : 1 | string |
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Query | includedDataSet required | The set of A+ Content data types to include in the response. Min count : 1 | < enum (IncludedDataSet) > array(csv) |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | GetContentDocumentResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}
Operation: updateContentDocument
Description
Updates an existing A+ Content document.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | contentReferenceKey required | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier. minLength : 1 | string |
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Body | postContentDocumentRequest required | The content document request details. | PostContentDocumentRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | PostContentDocumentResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins
Operation: listContentDocumentAsinRelations
Description
Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don't include the asinSet parameter, this operation returns all ASINs related to the content document.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | contentReferenceKey required | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ Content identifier. minLength : 1 | string |
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Query | includedDataSet optional | The set of A+ Content data types to include in the response. If you don't include this parameter, the operation returns the related ASINs without metadata. Min count : 0 | < enum (IncludedDataSet) > array(csv) |
| Query | asinSet optional | The set of ASINs. | < string > array(csv) |
| Query | pageToken optional | A token that you use to fetch a specific page when there are multiple pages of results. minLength : 1 | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | ListContentDocumentAsinRelationsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/asins
Operation: postContentDocumentAsinRelations
Description
Replaces all ASINs related to the specified A+ Content document, if available. This operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | contentReferenceKey required | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier. minLength : 1 | string |
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Body | postContentDocumentAsinRelationsRequest required | The request details for the content document ASIN relations. | PostContentDocumentAsinRelationsRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | PostContentDocumentAsinRelationsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
POST /aplus/2020-11-01/contentAsinValidations
Operation: validateContentDocumentAsinRelations
Description
Checks if the A+ Content document is valid for use on a set of ASINs.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Query | asinSet optional | The set of ASINs. | < string > array(csv) |
| Body | postContentDocumentRequest required | The content document request details. | PostContentDocumentRequest |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | ValidateContentDocumentAsinRelationsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
GET /aplus/2020-11-01/contentPublishRecords
Operation: searchContentPublishRecords
Description
Searches for A+ Content publishing records, if available.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
| Query | asin required | The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace. minLength : 10 | string |
| Query | pageToken optional | A token that you use to fetch a specific page when there are multiple pages of results. minLength : 1 | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | SearchContentPublishRecordsResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/approvalSubmissions
Operation: postContentDocumentApprovalSubmission
Description
Submits an A+ Content document for review, approval, and publishing.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | contentReferenceKey required | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier. minLength : 1 | string |
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | PostContentDocumentApprovalSubmissionResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
POST /aplus/2020-11-01/contentDocuments/{contentReferenceKey}/suspendSubmissions
Operation: postContentDocumentSuspendSubmission
Description
Submits a request to suspend visible A+ Content. This doesn't delete the content document or the ASIN relations.
Usage Plan:
| Rate (requests per second) | Burst |
|---|---|
| 10 | 10 |
The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | contentReferenceKey required | The unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier. minLength : 1 | string |
| Query | marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. minLength : 1 | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Success. Headers : x-amzn-RateLimit-Limit (string) : Your rate limit (requests per second) for this operation. x-amzn-RequestId (string) : Unique request reference identifier. | PostContentDocumentSuspendSubmissionResponse |
For error status codes, descriptions and schemas, see Error responses and schemas.
Error Responses and Schemas
This table contains HTTP status codes and associated information for error responses.
| HTTP Code | Description | Schema |
|---|---|---|
| 400 | Request has missing or invalid parameters and cannot be parsed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 401 | The request's Authorization header is not formatted correctly or does not contain a valid token. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 403 | Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. Headers: x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 404 | The specified resource does not exist. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 410 | The specified resource no longer exists. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 429 | The frequency of requests was greater than allowed. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 500 | An unexpected condition occurred that prevented the server from fulfilling the request. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
| 503 | Temporary overloading or maintenance of the server. Headers: x-amzn-RateLimit-Limit (string):Your rate limit (requests per second) for this operation.Note: For this status code, the rate limit header is deprecated and no longer returned. x-amzn-RequestId (string):Unique request reference identifier. | ErrorList |
Definitions
AplusResponse
The base response data for all A+ Content operations when a request is successful or partially successful. Individual operations can extend this with additional data.
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
AplusPaginatedResponse
A token that you use to retrieve the next page of results. To get the next page of results, call the operation with this token and include the same arguments as the call that produced the token. To get a complete list, call this operation until nextPageToken is null. Note that this operation can return empty pages.
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
| nextPageToken optional | A token that you use to fetch a specific page when there are multiple pages of results. | PageToken |
ErrorList
The error response that is returned when a request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| errors required | A list of error responses that are returned when a request is unsuccessful. | < Error > array |
MessageSet
A set of messages to the user, such as warnings or comments.
Type : < Error > array
Unique items : true
Error
The error response that is returned when the request is unsuccessful.
| Name | Description | Schema |
|---|---|---|
| code required | An error code that identifies the type of error that occurred. minLength : 1 | string |
| message required | A message that describes the error condition. minLength : 1 | string |
| details optional | Additional details that can help the caller understand or fix the issue. minLength : 1 | string |
ContentMetadataRecordList
A list of A+ Content metadata records.
Type : < ContentMetadataRecord > array
Unique items : false
ContentMetadataRecord
The metadata for an A+ Content document, with additional information for content management.
| Name | Description | Schema |
|---|---|---|
| contentReferenceKey required | A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier. | ContentReferenceKey |
| contentMetadata required | The A+ Content document's metadata. | ContentMetadata |
ContentMetadata
The A+ Content document's metadata.
| Name | Description | Schema |
|---|---|---|
| name required | The A+ Content document's name. minLength : 1 maxLength : 100 | string |
| marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. | MarketplaceId |
| status required | The submission status of the content document. | ContentStatus |
| badgeSet required | The set of content badges. | ContentBadgeSet |
| updateTime required | The approximate age of the A+ Content document and metadata. | string (date-time) |
ContentType
The A+ Content document type.
Type : enum
| Value | Description |
|---|---|
| EBC | A+ Content published through the A+ Content Manager in Seller Central. |
| EMC | A+ Content published through the A+ Content Manager in Vendor Central. |
ContentSubType
The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type has a subtype, and subtypes can change at any time.
Type : string
minLength : 1
ContentStatus
The submission status of the content document.
Type : enum
| Value | Description |
|---|---|
| APPROVED | The content is approved and will be published to the applied ASINs. |
| DRAFT | The content has not been submitted for approval. |
| REJECTED | The content is rejected in review and must be revised and resubmitted based on the rejection reasons provided. |
| SUBMITTED | The content is submitted for approval and is waiting for review. |
ContentBadgeSet
The set of content badges.
Type : < ContentBadge > array
Unique items : true
ContentBadge
A flag that provides additional information about an A+ Content document.
Type : enum
| Value | Description |
|---|---|
| BULK | This content is applied to ASINs in bulk. |
| GENERATED | This content is generated by an automated process. If any user modifies this content, it will lose the GENERATED badge. |
| LAUNCHPAD | Launchpad content. |
| PREMIUM | Premium content |
| STANDARD | Standard content. |
AsinBadgeSet
The set of ASIN badges.
Type : < AsinBadge > array
Unique items : true
AsinBadge
A flag that provides additional information about an ASIN. This is contextual and can change depending on the request that generated it.
Type : enum
| Value | Description |
|---|---|
| BRAND_NOT_ELIGIBLE | This ASIN is not part of the current user's brand. If the current user corrects their brand registration to include this ASIN, it loses the BrandNotEligible badge. |
| CATALOG_NOT_FOUND | This ASIN is not found in the Amazon catalog. If any user creates or restores this ASIN, it loses the CatalogNotFound badge. |
| CONTENT_NOT_PUBLISHED | This ASIN doesn't have the specified A+ Content published to it. If the current user publishes the specified content for this ASIN, it loses the ContentNotPublished badge. |
| CONTENT_PUBLISHED | This ASIN has the specified A+ Content published to it. If the current user suspends the specified content for this ASIN, it loses the ContentPublished badge. |
MarketplaceId
The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
Type : string
minLength : 1
LanguageTag
The IETF language tag, which supports the primary language subtag and one secondary language subtag. The secondary language subtag is usually a regional designation. This doesn't support subtags other than the primary and secondary subtags.
Pattern: ^[a-z]{2,}-[A-Z0-9]{2,}$
Type : string
minLength : 5
AsinSet
The set of ASINs.
Type : < Asin > array
Unique items : true
Asin
The Amazon Standard Identification Number (ASIN).
Type : string
minLength : 10
AsinMetadataSet
The set of ASIN metadata.
Type : < AsinMetadata > array
Unique items : true
AsinMetadata
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.
| Name | Description | Schema |
|---|---|---|
| asin required | The Amazon Standard Identification Number (ASIN). | Asin |
| badgeSet optional | The set of ASIN badges. | AsinBadgeSet |
| parent optional | The Amazon Standard Identification Number (ASIN). | Asin |
| title optional | The title for the ASIN in the Amazon catalog. minLength : 1 | string |
| imageUrl optional | The default image for the ASIN in the Amazon catalog. minLength : 1 | string |
| contentReferenceKeySet optional | A set of content reference keys. | ContentReferenceKeySet |
PublishRecordList
A list of A+ Content publishing records.
Type : < PublishRecord > array
Unique items : false
PublishRecord
The full context for an A+ Content publishing event.
| Name | Description | Schema |
|---|---|---|
| marketplaceId required | The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs. | MarketplaceId |
| locale required | The IETF language tag, which supports the primary language subtag and one secondary language subtag. The secondary language subtag is usually a regional designation. This doesn't support subtags other than the primary and secondary subtags. Pattern: ^[a-z]{2,}-[A-Z0-9]{2,}$ | LanguageTag |
| asin required | The Amazon Standard Identification Number (ASIN). | Asin |
| contentType required | The A+ Content document type. | ContentType |
| contentSubType optional | The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type has a subtype, and subtypes can change at any time. | ContentSubType |
| contentReferenceKey required | A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier. | ContentReferenceKey |
ContentReferenceKeySet
A set of content reference keys.
Type : < ContentReferenceKey > array
Unique items : true
ContentReferenceKey
A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier.
Type : string
minLength : 1
PageToken
A token that you use to fetch a specific page when there are multiple pages of results.
Type : string
minLength : 1
ImageCropSpecification
The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default.
| Name | Description | Schema |
|---|---|---|
| size required | The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). ImageDimensions units must be in pixels. | ImageDimensions |
| offset optional | The top left corner of the cropped image, specified in the original image's coordinate space. | ImageOffsets |
ImageDimensions
The dimensions that extend from the top left corner of the image (this applies to cropped and uncropped images). ImageDimensions units must be in pixels.
| Name | Description | Schema |
|---|---|---|
| width required | A whole number dimension and its unit of measurement. For example, this can represent 100 pixels. | IntegerWithUnits |
| height required | A whole number dimension and its unit of measurement. For example, this can represent 100 pixels. | IntegerWithUnits |
ImageOffsets
The top left corner of the cropped image, specified in the original image's coordinate space.
| Name | Description | Schema |
|---|---|---|
| x required | A whole number dimension and its unit of measurement. For example, this can represent 100 pixels. | IntegerWithUnits |
| y required | A whole number dimension and its unit of measurement. For example, this can represent 100 pixels. | IntegerWithUnits |
IntegerWithUnits
A whole number dimension and its unit of measurement. For example, this can represent 100 pixels.
| Name | Description | Schema |
|---|---|---|
| value required | The dimension value. | integer |
| units required | The unit of measurement. | string |
ContentRecord
A content document with additional information for content management.
| Name | Description | Schema |
|---|---|---|
| contentReferenceKey required | A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier. | ContentReferenceKey |
| contentMetadata optional | The A+ Content document's metadata. | ContentMetadata |
| contentDocument optional | The A+ Content document. This is the enhanced content that is published to product detail pages. | ContentDocument |
ContentDocument
The A+ Content document. This is the enhanced content that is published to product detail pages.
| Name | Description | Schema |
|---|---|---|
| name required | The A+ Content document name. minLength : 1 maxLength : 100 | string |
| contentType required | The A+ Content document type. | ContentType |
| contentSubType optional | The A+ Content document subtype. This represents a special-purpose type of an A+ Content document. Not every A+ Content document type has a subtype, and subtypes can change at any time. | ContentSubType |
| locale required | The IETF language tag, which supports the primary language subtag and one secondary language subtag. The secondary language subtag is usually a regional designation. This doesn't support subtags other than the primary and secondary subtags. Pattern: ^[a-z]{2,}-[A-Z0-9]{2,}$ | LanguageTag |
| contentModuleList required | A list of A+ Content modules. | ContentModuleList |
ContentModuleList
A list of A+ Content modules.
Type : < ContentModule > array
Min items : 1
Max items : 100
Unique items : false
ContentModule
An A+ Content module. An A+ Content document is composed of content modules. The contentModuleType property selects which content module types to use.
| Name | Description | Schema |
|---|---|---|
| contentModuleType required | The type of A+ Content module. | ContentModuleType |
| standardCompanyLogo optional | The standard company logo image. | StandardCompanyLogoModule |
| standardComparisonTable optional | The standard product comparison table. | StandardComparisonTableModule |
| standardFourImageText optional | Four standard images with text, presented across a single row. | StandardFourImageTextModule |
| standardFourImageTextQuadrant optional | Four standard images with text, presented on a grid of four quadrants. | StandardFourImageTextQuadrantModule |
| standardHeaderImageText optional | Standard headline text, an image, and body text. | StandardHeaderImageTextModule |
| standardImageSidebar optional | Two images, two paragraphs, and two bulleted lists. One image is smaller and displayed in the sidebar. | StandardImageSidebarModule |
| standardImageTextOverlay optional | A standard background image with a floating text box. | StandardImageTextOverlayModule |
| standardMultipleImageText optional | Standard images with text, presented one at a time. The user clicks on thumbnails to view each block. | StandardMultipleImageTextModule |
| standardProductDescription optional | Standard product description text. | StandardProductDescriptionModule |
| standardSingleImageHighlights optional | A standard image with several paragraphs and a bulleted list. | StandardSingleImageHighlightsModule |
| standardSingleImageSpecsDetail optional | A standard image with paragraphs, a bulleted list, and extra space for technical details. | StandardSingleImageSpecsDetailModule |
| standardSingleSideImage optional | A standard headline and body text with an image on the side. | StandardSingleSideImageModule |
| standardTechSpecs optional | The standard table of technical feature names and definitions. | StandardTechSpecsModule |
| standardText optional | A standard headline and body text. | StandardTextModule |
| standardThreeImageText optional | Three standard images with text, presented across a single row. | StandardThreeImageTextModule |
ContentModuleType
The type of A+ Content module.
Type : enum
| Value | Description |
|---|---|
| STANDARD_COMPANY_LOGO | The standard company logo image. |
| STANDARD_COMPARISON_TABLE | The standard product comparison table or chart. |
| STANDARD_FOUR_IMAGE_TEXT | Four standard images with text, presented across a single row. |
| STANDARD_FOUR_IMAGE_TEXT_QUADRANT | Four standard images with text, presented on a grid of four quadrants. |
| STANDARD_HEADER_IMAGE_TEXT | Standard headline text, an image, and body text. |
| STANDARD_IMAGE_SIDEBAR | Two images, two paragraphs, and two bulleted lists. One image is smaller and is displayed in the sidebar. |
| STANDARD_IMAGE_TEXT_OVERLAY | A standard background image with a floating text box. |
| STANDARD_MULTIPLE_IMAGE_TEXT | Standard images with text, presented one at a time. The user clicks on thumbnails to view each block. |
| STANDARD_PRODUCT_DESCRIPTION | Standard product description text. |
| STANDARD_SINGLE_IMAGE_HIGHLIGHTS | A standard image with several paragraphs and a bulleted list. |
| STANDARD_SINGLE_IMAGE_SPECS_DETAIL | A standard image with paragraphs, a bulleted list, and extra space for technical details. |
| STANDARD_SINGLE_SIDE_IMAGE | A standard headline with body text and an image to the side. |
| STANDARD_TECH_SPECS | The standard table of technical feature names and definitions. |
| STANDARD_TEXT | Standard headline and body text. |
| STANDARD_THREE_IMAGE_TEXT | Three standard images with text, presented across one row. |
StandardCompanyLogoModule
The standard company logo image.
| Name | Description | Schema |
|---|---|---|
| companyLogo required | A reference to an image, hosted in the A+ Content media library. | ImageComponent |
StandardComparisonTableModule
The standard product comparison table.
| Name | Schema |
|---|---|
| productColumns optional | < StandardComparisonProductBlock > array |
| metricRowLabels optional | < PlainTextItem > array |
StandardFourImageTextModule
Four standard images with text, presented across a single row.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| block1 optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block2 optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block3 optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block4 optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
StandardFourImageTextQuadrantModule
Four standard images with text, presented on a grid of four quadrants.
| Name | Description | Schema |
|---|---|---|
| block1 required | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block2 required | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block3 required | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block4 required | The A+ Content standard image and text box block. | StandardImageTextBlock |
StandardHeaderImageTextModule
Standard headline text, an image, and body text.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| block optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
StandardImageSidebarModule
Two images, two paragraphs, and two bulleted lists. One image is smaller and displayed in the sidebar.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| imageCaptionBlock optional | The A+ Content standard image and caption block. | StandardImageCaptionBlock |
| descriptionTextBlock optional | The A+ Content standard text box block, which contains a paragraph and a headline. | StandardTextBlock |
| descriptionListBlock optional | The A+ Content standard fixed-length list of text, usually presented as bullet points. | StandardTextListBlock |
| sidebarImageTextBlock optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
| sidebarListBlock optional | The A+ Content standard fixed-length list of text, usually presented as bullet points. | StandardTextListBlock |
StandardImageTextOverlayModule
A standard background image with a floating text box.
| Name | Description | Schema |
|---|---|---|
| overlayColorType required | The relative color scheme of your content. | ColorType |
| block optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
StandardMultipleImageTextModule
Standard images with text, presented one at a time. The user clicks on thumbnails to view each block.
| Name | Schema |
|---|---|
| blocks optional | < StandardImageTextCaptionBlock > array |
StandardProductDescriptionModule
Standard product description text.
| Name | Description | Schema |
|---|---|---|
| body required | A list of rich text content that is typically presented in a text box. | ParagraphComponent |
StandardSingleImageHighlightsModule
A standard image with several paragraphs and a bulleted list.
| Name | Description | Schema |
|---|---|---|
| image optional | A reference to an image, hosted in the A+ Content media library. | ImageComponent |
| headline optional | Rich text content. | TextComponent |
| textBlock1 optional | The A+ Content standard text box block, which contains a paragraph and a headline. | StandardTextBlock |
| textBlock2 optional | The A+ Content standard text box block, which contains a paragraph and a headline. | StandardTextBlock |
| textBlock3 optional | The A+ Content standard text box block, which contains a paragraph and a headline. | StandardTextBlock |
| bulletedListBlock optional | The A+ standard fixed-length list of text and a related headline. | StandardHeaderTextListBlock |
StandardSingleImageSpecsDetailModule
A standard image with paragraphs, a bulleted list, and extra space for technical details.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| image optional | A reference to an image, hosted in the A+ Content media library. | ImageComponent |
| descriptionHeadline optional | Rich text content. | TextComponent |
| descriptionBlock1 optional | The A+ Content standard text box block, which contains a paragraph and a headline. | StandardTextBlock |
| descriptionBlock2 optional | The A+ Content standard text box block, which contains a paragraph and a headline. | StandardTextBlock |
| specificationHeadline optional | Rich text content. | TextComponent |
| specificationListBlock optional | The A+ standard fixed-length list of text and a related headline. | StandardHeaderTextListBlock |
| specificationTextBlock optional | The A+ Content standard text box block, which contains a paragraph and a headline. | StandardTextBlock |
StandardSingleSideImageModule
A standard headline and body text with an image on the side.
| Name | Description | Schema |
|---|---|---|
| imagePositionType required | The content's relative positioning. | PositionType |
| block optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
StandardTechSpecsModule
The standard table of technical feature names and definitions.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| specificationList required | The specification list. | < StandardTextPairBlock > array |
| tableCount optional | The number of tables you want present. Features are evenly divided between the tables. Minimum value : 1 Maximum value : 2 | integer |
StandardTextModule
A standard headline and body text.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| body required | A list of rich text content that is typically presented in a text box. | ParagraphComponent |
StandardThreeImageTextModule
Three standard images with text, presented across a single row.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| block1 optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block2 optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
| block3 optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
StandardComparisonProductBlock
The A+ Content standard comparison product block.
| Name | Description | Schema |
|---|---|---|
| position required | The rank or index of this comparison product block within the module. Different blocks cannot occupy the same position within a single module. Minimum value : 1 Maximum value : 6 | integer |
| image optional | A reference to an image, hosted in the A+ Content media library. | ImageComponent |
| title optional | The comparison product title. minLength : 1 maxLength : 80 | string |
| asin optional | The Amazon Standard Identification Number (ASIN). | Asin |
| highlight optional | When true, indicates that this content block is visually highlighted. | boolean |
| metrics optional | Comparison metrics for the product. | < PlainTextItem > array |
StandardHeaderTextListBlock
The A+ standard fixed-length list of text and a related headline.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| block optional | The A+ Content standard fixed-length list of text, usually presented as bullet points. | StandardTextListBlock |
StandardTextListBlock
The A+ Content standard fixed-length list of text, usually presented as bullet points.
| Name | Schema |
|---|---|
| textList required | < TextItem > array |
StandardImageTextCaptionBlock
The A+ Content standard image and text block, with a related caption. The caption might not display on all devices.
| Name | Description | Schema |
|---|---|---|
| block optional | The A+ Content standard image and text box block. | StandardImageTextBlock |
| caption optional | Rich text content. | TextComponent |
StandardImageCaptionBlock
The A+ Content standard image and caption block.
| Name | Description | Schema |
|---|---|---|
| image optional | A reference to an image, hosted in the A+ Content media library. | ImageComponent |
| caption optional | Rich text content. | TextComponent |
StandardImageTextBlock
The A+ Content standard image and text box block.
| Name | Description | Schema |
|---|---|---|
| image optional | A reference to an image, hosted in the A+ Content media library. | ImageComponent |
| headline optional | Rich text content. | TextComponent |
| body optional | A list of rich text content that is typically presented in a text box. | ParagraphComponent |
StandardTextBlock
The A+ Content standard text box block, which contains a paragraph and a headline.
| Name | Description | Schema |
|---|---|---|
| headline optional | Rich text content. | TextComponent |
| body optional | A list of rich text content that is typically presented in a text box. | ParagraphComponent |
StandardTextPairBlock
The A+ Content standard label and description block, which contains a pair of text components.
| Name | Description | Schema |
|---|---|---|
| label optional | Rich text content. | TextComponent |
| description optional | Rich text content. | TextComponent |
TextItem
Rich positional text that is usually presented as a collection of bullet points.
| Name | Description | Schema |
|---|---|---|
| position required | The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection. Minimum value : 1 Maximum value : 100 | integer |
| text required | Rich text content. | TextComponent |
PlainTextItem
Plain positional text that is used in collections of brief labels and descriptors.
| Name | Description | Schema |
|---|---|---|
| position required | The rank or index of this text item within the collection. Different items cannot occupy the same position within a single collection. Minimum value : 1 Maximum value : 100 | integer |
| value required | The actual plain text. minLength : 1 maxLength : 250 | string |
ImageComponent
A reference to an image, hosted in the A+ Content media library.
| Name | Description | Schema |
|---|---|---|
| uploadDestinationId required | This identifier is provided by the Uploads API. minLength : 1 | string |
| imageCropSpecification required | The instructions for optionally cropping an image. If you don't want to crop the image, set the dimensions to the original image size. If the image is cropped and you don't include offset values, the coordinates of the top left corner of the cropped image are set to (0,0) by default. | ImageCropSpecification |
| altText required | The alternative text for the image. minLength : 1 maxLength : 100 | string |
ParagraphComponent
A list of rich text content that is typically presented in a text box.
| Name | Schema |
|---|---|
| textList required | < TextComponent > array |
TextComponent
Rich text content.
| Name | Description | Schema |
|---|---|---|
| value required | The actual plain text. minLength : 1 maxLength : 10000 | string |
| decoratorSet optional | A set of content decorators. | DecoratorSet |
ColorType
The relative color scheme of your content.
Type : enum
| Value | Description |
|---|---|
| DARK | A dark grey, semi-opaque shaded background for the light text overlay box. |
| LIGHT | A white, semi-opaque shaded background for the dark text overlay box. |
PositionType
The content's relative positioning.
Type : enum
| Value | Description |
|---|---|
| LEFT | Indicates that the content is positioned on the left side of the module. |
| RIGHT | Indicates that the content is positioned on the right side of the module. |
DecoratorSet
A set of content decorators.
Type : < Decorator > array
Unique items : true
Decorator
A decorator that is applied to a content string value in order to create rich text.
| Name | Description | Schema |
|---|---|---|
| type optional | The type of rich text decorator. | DecoratorType |
| offset optional | The starting value of this decorator within the content string. Use zero (0) for the first value. Minimum value : 0 Maximum value : 10000 | integer |
| length optional | The number of content characters to alter with this decorator. Decorators, such as line breaks, can have zero length and fit between characters. Minimum value : 0 Maximum value : 10000 | integer |
| depth optional | The relative intensity or variation of this decorator. Decorators, such as bullet-points, can have multiple indentation depths. Minimum value : 0 Maximum value : 100 | integer |
DecoratorType
The type of rich text decorator.
Type : enum
| Value | Description |
|---|---|
| LIST_ITEM | Formatted list item, used in either numbered or bulleted lists, inside the list enclosure. |
| LIST_ORDERED | Numbered list enclosure. |
| LIST_UNORDERED | Bulleted list enclosure. |
| STYLE_BOLD | Bold text formatting. |
| STYLE_ITALIC | Italic text formatting. |
| STYLE_LINEBREAK | New line of text. |
| STYLE_PARAGRAPH | Paragraph text formatting. |
| STYLE_UNDERLINE | Underline text formatting. |
SearchContentDocumentsResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
| nextPageToken optional | A token that you use to fetch a specific page when there are multiple pages of results. | PageToken |
| contentMetadataRecords required | The content metadata records. | ContentMetadataRecordList |
GetContentDocumentResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
| contentRecord required | A content document with additional information for content management. | ContentRecord |
PostContentDocumentRequest
| Name | Description | Schema |
|---|---|---|
| contentDocument required | The A+ Content document. This is the enhanced content that is published to product detail pages. | ContentDocument |
PostContentDocumentResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
| contentReferenceKey required | A unique reference key for the A+ Content document. A content reference key cannot form a permalink and might change in the future. A content reference key is not guaranteed to match any A+ content identifier. | ContentReferenceKey |
ListContentDocumentAsinRelationsResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
| nextPageToken optional | A token that you use to fetch a specific page when there are multiple pages of results. | PageToken |
| asinMetadataSet required | The set of ASIN metadata. | AsinMetadataSet |
PostContentDocumentAsinRelationsRequest
| Name | Description | Schema |
|---|---|---|
| asinSet required | The set of ASINs. | AsinSet |
PostContentDocumentAsinRelationsResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
ValidateContentDocumentAsinRelationsResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
| errors required | A list of error responses that are returned when a request is unsuccessful. | < Error > array |
SearchContentPublishRecordsResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
| nextPageToken optional | A token that you use to fetch a specific page when there are multiple pages of results. | PageToken |
| publishRecordList required | A list of A+ Content publishing records. | PublishRecordList |
PostContentDocumentApprovalSubmissionResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
PostContentDocumentSuspendSubmissionResponse
Polymorphism : Composition
| Name | Description | Schema |
|---|---|---|
| warnings optional | A set of messages to the user, such as warnings or comments. | MessageSet |
IncludedDataSet
Type : enum
For use with the operation(s): listContentDocumentAsinRelations
| Value | Description |
|---|---|
| METADATA | The content document's metadata. |
For use with the operation(s): getContentDocument
| Value | Description |
|---|---|
| CONTENTS | The contents of the content document. |
| METADATA | The content document's metadata. |
Updated 7 days ago