Selling Partner API for A+ Content Management (2020-11-01)

Download OpenAPI specification:Download

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.

aplusContent

searchContentDocuments

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

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

pageToken
string non-empty

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.

Responses

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "nextPageToken": "string",
  • "contentMetadataRecords": [
    ]
}

createContentDocument

Creates a new A+ Content document.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

Request Body schema: application/json

The content document request details.

required
object (ContentDocument)

The A+ Content document. This is the enhanced content that is published to product detail pages.

Responses

Request samples

Content type
application/json
{
  • "contentDocument": {
    }
}

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "contentReferenceKey": "string"
}

getContentDocument

Returns an A+ Content document, if available.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
contentReferenceKey
required
string non-empty

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.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

includedDataSet
required
Array of strings non-empty unique
Items Enum: "CONTENTS" "METADATA"

The set of A+ Content data types to include in the response.

Responses

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "contentRecord": {
    }
}

updateContentDocument

Updates an existing A+ Content document.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
contentReferenceKey
required
string non-empty

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.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

Request Body schema: application/json

The content document request details.

required
object (ContentDocument)

The A+ Content document. This is the enhanced content that is published to product detail pages.

Responses

Request samples

Content type
application/json
{
  • "contentDocument": {
    }
}

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "contentReferenceKey": "string"
}

listContentDocumentAsinRelations

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

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
contentReferenceKey
required
string non-empty

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.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

includedDataSet
Array of strings >= 0 items unique
Items Value: "METADATA"

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.

asinSet
Array of strings unique [ items >= 10 characters ]

The set of ASINs.

pageToken
string non-empty

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.

Responses

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "nextPageToken": "string",
  • "asinMetadataSet": [
    ]
}

postContentDocumentAsinRelations

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.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
contentReferenceKey
required
string non-empty

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.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

Request Body schema: application/json

The content document ASIN relations request details.

asinSet
required
Array of strings >= 10 characters unique [ items >= 10 characters ]

The set of ASINs.

Responses

Request samples

Content type
application/json
{
  • "asinSet": [
    ]
}

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

validateContentDocumentAsinRelations

Checks if the A+ Content document is valid for use on a set of ASINs.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

asinSet
Array of strings unique [ items >= 10 characters ]

The set of ASINs.

Request Body schema: application/json

The content document request details.

required
object (ContentDocument)

The A+ Content document. This is the enhanced content that is published to product detail pages.

Responses

Request samples

Content type
application/json
{
  • "contentDocument": {
    }
}

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "errors": [
    ]
}

searchContentPublishRecords

Searches for A+ Content publishing records, if available.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

asin
required
string >= 10 characters

The Amazon Standard Identification Number (ASIN).

pageToken
string non-empty

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.

Responses

Response samples

Content type
application/json
{
  • "warnings": [
    ],
  • "nextPageToken": "string",
  • "publishRecordList": [
    ]
}

postContentDocumentApprovalSubmission

Submits an A+ Content document for review, approval, and publishing.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
contentReferenceKey
required
string non-empty

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.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

Responses

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}

postContentDocumentSuspendSubmission

Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations.

Usage Plans:

Plan type Rate (requests per second) Burst
Default 10 10
Selling partner specific Variable Variable

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

path Parameters
contentReferenceKey
required
string non-empty

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.

query Parameters
marketplaceId
required
string non-empty

The identifier for the marketplace where the A+ Content is published.

Responses

Response samples

Content type
application/json
{
  • "warnings": [
    ]
}