@sp-api-sdk/aplus-content-api-2020-11-01 3.0.1 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/cjs/api-model/api/aplus-content-api.js +85 -85
- package/dist/cjs/api-model/api.js +1 -1
- package/dist/cjs/api-model/base.js +1 -1
- package/dist/cjs/api-model/common.js +1 -1
- package/dist/cjs/api-model/configuration.js +2 -3
- package/dist/cjs/api-model/index.js +1 -1
- package/dist/cjs/api-model/models/aplus-paginated-response-all-of.js +1 -1
- package/dist/cjs/api-model/models/aplus-paginated-response.js +1 -1
- package/dist/cjs/api-model/models/aplus-response.js +1 -1
- package/dist/cjs/api-model/models/asin-badge.js +2 -2
- package/dist/cjs/api-model/models/asin-metadata.js +1 -1
- package/dist/cjs/api-model/models/color-type.js +2 -2
- package/dist/cjs/api-model/models/content-badge.js +1 -1
- package/dist/cjs/api-model/models/content-document.js +1 -1
- package/dist/cjs/api-model/models/content-metadata-record.js +1 -1
- package/dist/cjs/api-model/models/content-metadata.js +1 -1
- package/dist/cjs/api-model/models/content-module-type.js +1 -1
- package/dist/cjs/api-model/models/content-module.js +1 -1
- package/dist/cjs/api-model/models/content-record.js +1 -1
- package/dist/cjs/api-model/models/content-status.js +1 -1
- package/dist/cjs/api-model/models/content-type.js +1 -1
- package/dist/cjs/api-model/models/decorator-type.js +1 -1
- package/dist/cjs/api-model/models/decorator.js +1 -1
- package/dist/cjs/api-model/models/error-list.js +1 -1
- package/dist/cjs/api-model/models/get-content-document-response-all-of.js +1 -1
- package/dist/cjs/api-model/models/get-content-document-response.js +1 -1
- package/dist/cjs/api-model/models/image-component.js +1 -1
- package/dist/cjs/api-model/models/image-crop-specification.js +1 -1
- package/dist/cjs/api-model/models/image-dimensions.js +1 -1
- package/dist/cjs/api-model/models/image-offsets.js +1 -1
- package/dist/cjs/api-model/models/integer-with-units.js +1 -1
- package/dist/cjs/api-model/models/list-content-document-asin-relations-response-all-of.js +1 -1
- package/dist/cjs/api-model/models/list-content-document-asin-relations-response.js +1 -1
- package/dist/cjs/api-model/models/model-error.js +1 -1
- package/dist/cjs/api-model/models/paragraph-component.js +1 -1
- package/dist/cjs/api-model/models/plain-text-item.js +1 -1
- package/dist/cjs/api-model/models/position-type.js +2 -2
- package/dist/cjs/api-model/models/post-content-document-approval-submission-response.js +1 -1
- package/dist/cjs/api-model/models/post-content-document-asin-relations-request.js +1 -1
- package/dist/cjs/api-model/models/post-content-document-asin-relations-response.js +1 -1
- package/dist/cjs/api-model/models/post-content-document-request.js +1 -1
- package/dist/cjs/api-model/models/post-content-document-response-all-of.js +1 -1
- package/dist/cjs/api-model/models/post-content-document-response.js +1 -1
- package/dist/cjs/api-model/models/post-content-document-suspend-submission-response.js +1 -1
- package/dist/cjs/api-model/models/publish-record.js +1 -1
- package/dist/cjs/api-model/models/search-content-documents-response-all-of.js +1 -1
- package/dist/cjs/api-model/models/search-content-documents-response.js +1 -1
- package/dist/cjs/api-model/models/search-content-publish-records-response-all-of.js +1 -1
- package/dist/cjs/api-model/models/search-content-publish-records-response.js +1 -1
- package/dist/cjs/api-model/models/standard-company-logo-module.js +1 -1
- package/dist/cjs/api-model/models/standard-comparison-product-block.js +1 -1
- package/dist/cjs/api-model/models/standard-comparison-table-module.js +1 -1
- package/dist/cjs/api-model/models/standard-four-image-text-module.js +1 -1
- package/dist/cjs/api-model/models/standard-four-image-text-quadrant-module.js +1 -1
- package/dist/cjs/api-model/models/standard-header-image-text-module.js +1 -1
- package/dist/cjs/api-model/models/standard-header-text-list-block.js +1 -1
- package/dist/cjs/api-model/models/standard-image-caption-block.js +1 -1
- package/dist/cjs/api-model/models/standard-image-sidebar-module.js +1 -1
- package/dist/cjs/api-model/models/standard-image-text-block.js +1 -1
- package/dist/cjs/api-model/models/standard-image-text-caption-block.js +1 -1
- package/dist/cjs/api-model/models/standard-image-text-overlay-module.js +1 -1
- package/dist/cjs/api-model/models/standard-multiple-image-text-module.js +1 -1
- package/dist/cjs/api-model/models/standard-product-description-module.js +1 -1
- package/dist/cjs/api-model/models/standard-single-image-highlights-module.js +1 -1
- package/dist/cjs/api-model/models/standard-single-image-specs-detail-module.js +1 -1
- package/dist/cjs/api-model/models/standard-single-side-image-module.js +1 -1
- package/dist/cjs/api-model/models/standard-tech-specs-module.js +1 -1
- package/dist/cjs/api-model/models/standard-text-block.js +1 -1
- package/dist/cjs/api-model/models/standard-text-list-block.js +1 -1
- package/dist/cjs/api-model/models/standard-text-module.js +1 -1
- package/dist/cjs/api-model/models/standard-text-pair-block.js +1 -1
- package/dist/cjs/api-model/models/standard-three-image-text-module.js +1 -1
- package/dist/cjs/api-model/models/text-component.js +1 -1
- package/dist/cjs/api-model/models/text-item.js +1 -1
- package/dist/cjs/api-model/models/validate-content-document-asin-relations-response.js +1 -1
- package/dist/es/api-model/api/aplus-content-api.js +85 -85
- package/dist/es/api-model/api.js +1 -1
- package/dist/es/api-model/base.js +1 -1
- package/dist/es/api-model/common.js +1 -1
- package/dist/es/api-model/configuration.js +2 -3
- package/dist/es/api-model/index.js +1 -1
- package/dist/es/api-model/models/aplus-paginated-response-all-of.js +1 -1
- package/dist/es/api-model/models/aplus-paginated-response.js +1 -1
- package/dist/es/api-model/models/aplus-response.js +1 -1
- package/dist/es/api-model/models/asin-badge.js +2 -2
- package/dist/es/api-model/models/asin-metadata.js +1 -1
- package/dist/es/api-model/models/color-type.js +2 -2
- package/dist/es/api-model/models/content-badge.js +1 -1
- package/dist/es/api-model/models/content-document.js +1 -1
- package/dist/es/api-model/models/content-metadata-record.js +1 -1
- package/dist/es/api-model/models/content-metadata.js +1 -1
- package/dist/es/api-model/models/content-module-type.js +1 -1
- package/dist/es/api-model/models/content-module.js +1 -1
- package/dist/es/api-model/models/content-record.js +1 -1
- package/dist/es/api-model/models/content-status.js +1 -1
- package/dist/es/api-model/models/content-type.js +1 -1
- package/dist/es/api-model/models/decorator-type.js +1 -1
- package/dist/es/api-model/models/decorator.js +1 -1
- package/dist/es/api-model/models/error-list.js +1 -1
- package/dist/es/api-model/models/get-content-document-response-all-of.js +1 -1
- package/dist/es/api-model/models/get-content-document-response.js +1 -1
- package/dist/es/api-model/models/image-component.js +1 -1
- package/dist/es/api-model/models/image-crop-specification.js +1 -1
- package/dist/es/api-model/models/image-dimensions.js +1 -1
- package/dist/es/api-model/models/image-offsets.js +1 -1
- package/dist/es/api-model/models/integer-with-units.js +1 -1
- package/dist/es/api-model/models/list-content-document-asin-relations-response-all-of.js +1 -1
- package/dist/es/api-model/models/list-content-document-asin-relations-response.js +1 -1
- package/dist/es/api-model/models/model-error.js +1 -1
- package/dist/es/api-model/models/paragraph-component.js +1 -1
- package/dist/es/api-model/models/plain-text-item.js +1 -1
- package/dist/es/api-model/models/position-type.js +2 -2
- package/dist/es/api-model/models/post-content-document-approval-submission-response.js +1 -1
- package/dist/es/api-model/models/post-content-document-asin-relations-request.js +1 -1
- package/dist/es/api-model/models/post-content-document-asin-relations-response.js +1 -1
- package/dist/es/api-model/models/post-content-document-request.js +1 -1
- package/dist/es/api-model/models/post-content-document-response-all-of.js +1 -1
- package/dist/es/api-model/models/post-content-document-response.js +1 -1
- package/dist/es/api-model/models/post-content-document-suspend-submission-response.js +1 -1
- package/dist/es/api-model/models/publish-record.js +1 -1
- package/dist/es/api-model/models/search-content-documents-response-all-of.js +1 -1
- package/dist/es/api-model/models/search-content-documents-response.js +1 -1
- package/dist/es/api-model/models/search-content-publish-records-response-all-of.js +1 -1
- package/dist/es/api-model/models/search-content-publish-records-response.js +1 -1
- package/dist/es/api-model/models/standard-company-logo-module.js +1 -1
- package/dist/es/api-model/models/standard-comparison-product-block.js +1 -1
- package/dist/es/api-model/models/standard-comparison-table-module.js +1 -1
- package/dist/es/api-model/models/standard-four-image-text-module.js +1 -1
- package/dist/es/api-model/models/standard-four-image-text-quadrant-module.js +1 -1
- package/dist/es/api-model/models/standard-header-image-text-module.js +1 -1
- package/dist/es/api-model/models/standard-header-text-list-block.js +1 -1
- package/dist/es/api-model/models/standard-image-caption-block.js +1 -1
- package/dist/es/api-model/models/standard-image-sidebar-module.js +1 -1
- package/dist/es/api-model/models/standard-image-text-block.js +1 -1
- package/dist/es/api-model/models/standard-image-text-caption-block.js +1 -1
- package/dist/es/api-model/models/standard-image-text-overlay-module.js +1 -1
- package/dist/es/api-model/models/standard-multiple-image-text-module.js +1 -1
- package/dist/es/api-model/models/standard-product-description-module.js +1 -1
- package/dist/es/api-model/models/standard-single-image-highlights-module.js +1 -1
- package/dist/es/api-model/models/standard-single-image-specs-detail-module.js +1 -1
- package/dist/es/api-model/models/standard-single-side-image-module.js +1 -1
- package/dist/es/api-model/models/standard-tech-specs-module.js +1 -1
- package/dist/es/api-model/models/standard-text-block.js +1 -1
- package/dist/es/api-model/models/standard-text-list-block.js +1 -1
- package/dist/es/api-model/models/standard-text-module.js +1 -1
- package/dist/es/api-model/models/standard-text-pair-block.js +1 -1
- package/dist/es/api-model/models/standard-three-image-text-module.js +1 -1
- package/dist/es/api-model/models/text-component.js +1 -1
- package/dist/es/api-model/models/text-item.js +1 -1
- package/dist/es/api-model/models/validate-content-document-asin-relations-response.js +1 -1
- package/dist/types/api-model/api/aplus-content-api.d.ts +107 -107
- package/dist/types/api-model/api.d.ts +1 -1
- package/dist/types/api-model/base.d.ts +1 -1
- package/dist/types/api-model/common.d.ts +2 -2
- package/dist/types/api-model/configuration.d.ts +1 -1
- package/dist/types/api-model/index.d.ts +1 -1
- package/dist/types/api-model/models/aplus-paginated-response-all-of.d.ts +2 -2
- package/dist/types/api-model/models/aplus-paginated-response.d.ts +2 -2
- package/dist/types/api-model/models/aplus-response.d.ts +2 -2
- package/dist/types/api-model/models/asin-badge.d.ts +2 -2
- package/dist/types/api-model/models/asin-metadata.d.ts +2 -2
- package/dist/types/api-model/models/color-type.d.ts +2 -2
- package/dist/types/api-model/models/content-badge.d.ts +1 -1
- package/dist/types/api-model/models/content-document.d.ts +3 -3
- package/dist/types/api-model/models/content-metadata-record.d.ts +2 -2
- package/dist/types/api-model/models/content-metadata.d.ts +4 -4
- package/dist/types/api-model/models/content-module-type.d.ts +1 -1
- package/dist/types/api-model/models/content-module.d.ts +2 -2
- package/dist/types/api-model/models/content-record.d.ts +2 -2
- package/dist/types/api-model/models/content-status.d.ts +1 -1
- package/dist/types/api-model/models/content-type.d.ts +1 -1
- package/dist/types/api-model/models/decorator-type.d.ts +1 -1
- package/dist/types/api-model/models/decorator.d.ts +5 -5
- package/dist/types/api-model/models/error-list.d.ts +3 -3
- package/dist/types/api-model/models/get-content-document-response-all-of.d.ts +1 -1
- package/dist/types/api-model/models/get-content-document-response.d.ts +1 -1
- package/dist/types/api-model/models/image-component.d.ts +2 -2
- package/dist/types/api-model/models/image-crop-specification.d.ts +2 -2
- package/dist/types/api-model/models/image-dimensions.d.ts +2 -2
- package/dist/types/api-model/models/image-offsets.d.ts +1 -1
- package/dist/types/api-model/models/integer-with-units.d.ts +1 -1
- package/dist/types/api-model/models/list-content-document-asin-relations-response-all-of.d.ts +1 -1
- package/dist/types/api-model/models/list-content-document-asin-relations-response.d.ts +1 -1
- package/dist/types/api-model/models/model-error.d.ts +2 -2
- package/dist/types/api-model/models/paragraph-component.d.ts +2 -2
- package/dist/types/api-model/models/plain-text-item.d.ts +2 -2
- package/dist/types/api-model/models/position-type.d.ts +2 -2
- package/dist/types/api-model/models/post-content-document-approval-submission-response.d.ts +1 -1
- package/dist/types/api-model/models/post-content-document-asin-relations-request.d.ts +1 -1
- package/dist/types/api-model/models/post-content-document-asin-relations-response.d.ts +1 -1
- package/dist/types/api-model/models/post-content-document-request.d.ts +1 -1
- package/dist/types/api-model/models/post-content-document-response-all-of.d.ts +2 -2
- package/dist/types/api-model/models/post-content-document-response.d.ts +1 -1
- package/dist/types/api-model/models/post-content-document-suspend-submission-response.d.ts +1 -1
- package/dist/types/api-model/models/publish-record.d.ts +5 -5
- package/dist/types/api-model/models/search-content-documents-response-all-of.d.ts +1 -1
- package/dist/types/api-model/models/search-content-documents-response.d.ts +1 -1
- package/dist/types/api-model/models/search-content-publish-records-response-all-of.d.ts +1 -1
- package/dist/types/api-model/models/search-content-publish-records-response.d.ts +1 -1
- package/dist/types/api-model/models/standard-company-logo-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-comparison-product-block.d.ts +2 -2
- package/dist/types/api-model/models/standard-comparison-table-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-four-image-text-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-four-image-text-quadrant-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-header-image-text-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-header-text-list-block.d.ts +2 -2
- package/dist/types/api-model/models/standard-image-caption-block.d.ts +1 -1
- package/dist/types/api-model/models/standard-image-sidebar-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-image-text-block.d.ts +1 -1
- package/dist/types/api-model/models/standard-image-text-caption-block.d.ts +2 -2
- package/dist/types/api-model/models/standard-image-text-overlay-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-multiple-image-text-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-product-description-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-single-image-highlights-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-single-image-specs-detail-module.d.ts +2 -2
- package/dist/types/api-model/models/standard-single-side-image-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-tech-specs-module.d.ts +2 -2
- package/dist/types/api-model/models/standard-text-block.d.ts +2 -2
- package/dist/types/api-model/models/standard-text-list-block.d.ts +2 -2
- package/dist/types/api-model/models/standard-text-module.d.ts +1 -1
- package/dist/types/api-model/models/standard-text-pair-block.d.ts +2 -2
- package/dist/types/api-model/models/standard-three-image-text-module.d.ts +1 -1
- package/dist/types/api-model/models/text-component.d.ts +1 -1
- package/dist/types/api-model/models/text-item.d.ts +2 -2
- package/dist/types/api-model/models/validate-content-document-asin-relations-response.d.ts +1 -1
- package/package.json +5 -5
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Selling Partner API for A+ Content Management
|
|
3
|
-
*
|
|
3
|
+
* 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.
|
|
4
4
|
*
|
|
5
5
|
* The version of the OpenAPI document: 2020-11-01
|
|
6
6
|
*
|
|
@@ -30,87 +30,87 @@ import type { ValidateContentDocumentAsinRelationsResponse } from '../models';
|
|
|
30
30
|
*/
|
|
31
31
|
export declare const AplusContentApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
32
32
|
/**
|
|
33
|
-
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
34
|
-
* @param {string} marketplaceId The
|
|
33
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
34
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
35
35
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
36
36
|
* @param {*} [options] Override http request option.
|
|
37
37
|
* @throws {RequiredError}
|
|
38
38
|
*/
|
|
39
39
|
createContentDocument: (marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
40
|
/**
|
|
41
|
-
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
42
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
43
|
-
* @param {string} marketplaceId The
|
|
41
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
42
|
+
* @param {string} contentReferenceKey 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.
|
|
43
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
44
44
|
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
45
45
|
* @param {*} [options] Override http request option.
|
|
46
46
|
* @throws {RequiredError}
|
|
47
47
|
*/
|
|
48
48
|
getContentDocument: (contentReferenceKey: string, marketplaceId: string, includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
49
|
/**
|
|
50
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you
|
|
51
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
52
|
-
* @param {string} marketplaceId The
|
|
53
|
-
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you
|
|
50
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
51
|
+
* @param {string} contentReferenceKey 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.
|
|
52
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
53
|
+
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] 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.
|
|
54
54
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
55
|
-
* @param {string} [pageToken] A
|
|
55
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
56
56
|
* @param {*} [options] Override http request option.
|
|
57
57
|
* @throws {RequiredError}
|
|
58
58
|
*/
|
|
59
59
|
listContentDocumentAsinRelations: (contentReferenceKey: string, marketplaceId: string, includedDataSet?: Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>, asinSet?: Set<string>, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
60
60
|
/**
|
|
61
|
-
* 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
|
|
62
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
63
|
-
* @param {string} marketplaceId The
|
|
61
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
62
|
+
* @param {string} contentReferenceKey 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.
|
|
63
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
67
67
|
postContentDocumentApprovalSubmission: (contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
68
68
|
/**
|
|
69
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This
|
|
70
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
71
|
-
* @param {string} marketplaceId The
|
|
72
|
-
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The content document ASIN relations
|
|
69
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
70
|
+
* @param {string} contentReferenceKey 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.
|
|
71
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
72
|
+
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The request details for the content document ASIN relations.
|
|
73
73
|
* @param {*} [options] Override http request option.
|
|
74
74
|
* @throws {RequiredError}
|
|
75
75
|
*/
|
|
76
76
|
postContentDocumentAsinRelations: (contentReferenceKey: string, marketplaceId: string, postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
77
|
/**
|
|
78
|
-
* Submits a request to suspend visible A+ Content. This
|
|
79
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
80
|
-
* @param {string} marketplaceId The
|
|
78
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
79
|
+
* @param {string} contentReferenceKey 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.
|
|
80
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
81
81
|
* @param {*} [options] Override http request option.
|
|
82
82
|
* @throws {RequiredError}
|
|
83
83
|
*/
|
|
84
84
|
postContentDocumentSuspendSubmission: (contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
85
|
/**
|
|
86
|
-
* Returns a list of all A+ Content documents assigned to a selling partner.
|
|
87
|
-
* @param {string} marketplaceId The
|
|
88
|
-
* @param {string} [pageToken] A
|
|
86
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
87
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
88
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
89
89
|
* @param {*} [options] Override http request option.
|
|
90
90
|
* @throws {RequiredError}
|
|
91
91
|
*/
|
|
92
92
|
searchContentDocuments: (marketplaceId: string, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
93
|
/**
|
|
94
|
-
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
95
|
-
* @param {string} marketplaceId The
|
|
96
|
-
* @param {string} asin The Amazon Standard Identification Number (ASIN).
|
|
97
|
-
* @param {string} [pageToken] A
|
|
94
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
95
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
96
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
97
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
101
101
|
searchContentPublishRecords: (marketplaceId: string, asin: string, pageToken?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
102
|
/**
|
|
103
|
-
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
104
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
105
|
-
* @param {string} marketplaceId The
|
|
103
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
104
|
+
* @param {string} contentReferenceKey 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.
|
|
105
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
106
106
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
107
107
|
* @param {*} [options] Override http request option.
|
|
108
108
|
* @throws {RequiredError}
|
|
109
109
|
*/
|
|
110
110
|
updateContentDocument: (contentReferenceKey: string, marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
111
|
/**
|
|
112
|
-
* 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
|
|
113
|
-
* @param {string} marketplaceId The
|
|
112
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
113
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
114
114
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
115
115
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
116
116
|
* @param {*} [options] Override http request option.
|
|
@@ -124,87 +124,87 @@ export declare const AplusContentApiAxiosParamCreator: (configuration?: Configur
|
|
|
124
124
|
*/
|
|
125
125
|
export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
126
126
|
/**
|
|
127
|
-
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
128
|
-
* @param {string} marketplaceId The
|
|
127
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
128
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
129
129
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
130
130
|
* @param {*} [options] Override http request option.
|
|
131
131
|
* @throws {RequiredError}
|
|
132
132
|
*/
|
|
133
133
|
createContentDocument(marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentResponse>>;
|
|
134
134
|
/**
|
|
135
|
-
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
136
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
137
|
-
* @param {string} marketplaceId The
|
|
135
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
136
|
+
* @param {string} contentReferenceKey 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.
|
|
137
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
138
138
|
* @param {Set<GetContentDocumentIncludedDataSetEnum>} includedDataSet The set of A+ Content data types to include in the response.
|
|
139
139
|
* @param {*} [options] Override http request option.
|
|
140
140
|
* @throws {RequiredError}
|
|
141
141
|
*/
|
|
142
142
|
getContentDocument(contentReferenceKey: string, marketplaceId: string, includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetContentDocumentResponse>>;
|
|
143
143
|
/**
|
|
144
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you
|
|
145
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
146
|
-
* @param {string} marketplaceId The
|
|
147
|
-
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] The set of A+ Content data types to include in the response. If you
|
|
144
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
145
|
+
* @param {string} contentReferenceKey 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.
|
|
146
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
147
|
+
* @param {Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>} [includedDataSet] 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.
|
|
148
148
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
149
|
-
* @param {string} [pageToken] A
|
|
149
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
150
150
|
* @param {*} [options] Override http request option.
|
|
151
151
|
* @throws {RequiredError}
|
|
152
152
|
*/
|
|
153
153
|
listContentDocumentAsinRelations(contentReferenceKey: string, marketplaceId: string, includedDataSet?: Set<ListContentDocumentAsinRelationsIncludedDataSetEnum>, asinSet?: Set<string>, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListContentDocumentAsinRelationsResponse>>;
|
|
154
154
|
/**
|
|
155
|
-
* 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
|
|
156
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
157
|
-
* @param {string} marketplaceId The
|
|
155
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
156
|
+
* @param {string} contentReferenceKey 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.
|
|
157
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
158
158
|
* @param {*} [options] Override http request option.
|
|
159
159
|
* @throws {RequiredError}
|
|
160
160
|
*/
|
|
161
161
|
postContentDocumentApprovalSubmission(contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentApprovalSubmissionResponse>>;
|
|
162
162
|
/**
|
|
163
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This
|
|
164
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
165
|
-
* @param {string} marketplaceId The
|
|
166
|
-
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The content document ASIN relations
|
|
163
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
164
|
+
* @param {string} contentReferenceKey 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.
|
|
165
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
166
|
+
* @param {PostContentDocumentAsinRelationsRequest} postContentDocumentAsinRelationsRequest The request details for the content document ASIN relations.
|
|
167
167
|
* @param {*} [options] Override http request option.
|
|
168
168
|
* @throws {RequiredError}
|
|
169
169
|
*/
|
|
170
170
|
postContentDocumentAsinRelations(contentReferenceKey: string, marketplaceId: string, postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentAsinRelationsResponse>>;
|
|
171
171
|
/**
|
|
172
|
-
* Submits a request to suspend visible A+ Content. This
|
|
173
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
174
|
-
* @param {string} marketplaceId The
|
|
172
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
173
|
+
* @param {string} contentReferenceKey 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.
|
|
174
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
175
175
|
* @param {*} [options] Override http request option.
|
|
176
176
|
* @throws {RequiredError}
|
|
177
177
|
*/
|
|
178
178
|
postContentDocumentSuspendSubmission(contentReferenceKey: string, marketplaceId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentSuspendSubmissionResponse>>;
|
|
179
179
|
/**
|
|
180
|
-
* Returns a list of all A+ Content documents assigned to a selling partner.
|
|
181
|
-
* @param {string} marketplaceId The
|
|
182
|
-
* @param {string} [pageToken] A
|
|
180
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
181
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
182
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
183
183
|
* @param {*} [options] Override http request option.
|
|
184
184
|
* @throws {RequiredError}
|
|
185
185
|
*/
|
|
186
186
|
searchContentDocuments(marketplaceId: string, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchContentDocumentsResponse>>;
|
|
187
187
|
/**
|
|
188
|
-
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
189
|
-
* @param {string} marketplaceId The
|
|
190
|
-
* @param {string} asin The Amazon Standard Identification Number (ASIN).
|
|
191
|
-
* @param {string} [pageToken] A
|
|
188
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
189
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
190
|
+
* @param {string} asin The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
191
|
+
* @param {string} [pageToken] A token that you use to fetch a specific page when there are multiple pages of results.
|
|
192
192
|
* @param {*} [options] Override http request option.
|
|
193
193
|
* @throws {RequiredError}
|
|
194
194
|
*/
|
|
195
195
|
searchContentPublishRecords(marketplaceId: string, asin: string, pageToken?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchContentPublishRecordsResponse>>;
|
|
196
196
|
/**
|
|
197
|
-
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
198
|
-
* @param {string} contentReferenceKey The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
199
|
-
* @param {string} marketplaceId The
|
|
197
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
198
|
+
* @param {string} contentReferenceKey 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.
|
|
199
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
200
200
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
201
201
|
* @param {*} [options] Override http request option.
|
|
202
202
|
* @throws {RequiredError}
|
|
203
203
|
*/
|
|
204
204
|
updateContentDocument(contentReferenceKey: string, marketplaceId: string, postContentDocumentRequest: PostContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PostContentDocumentResponse>>;
|
|
205
205
|
/**
|
|
206
|
-
* 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
|
|
207
|
-
* @param {string} marketplaceId The
|
|
206
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
207
|
+
* @param {string} marketplaceId The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
208
208
|
* @param {PostContentDocumentRequest} postContentDocumentRequest The content document request details.
|
|
209
209
|
* @param {Set<string>} [asinSet] The set of ASINs.
|
|
210
210
|
* @param {*} [options] Override http request option.
|
|
@@ -218,70 +218,70 @@ export declare const AplusContentApiFp: (configuration?: Configuration) => {
|
|
|
218
218
|
*/
|
|
219
219
|
export declare const AplusContentApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
220
220
|
/**
|
|
221
|
-
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
221
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
222
222
|
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
223
223
|
* @param {*} [options] Override http request option.
|
|
224
224
|
* @throws {RequiredError}
|
|
225
225
|
*/
|
|
226
226
|
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentResponse>;
|
|
227
227
|
/**
|
|
228
|
-
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
228
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
229
229
|
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
230
230
|
* @param {*} [options] Override http request option.
|
|
231
231
|
* @throws {RequiredError}
|
|
232
232
|
*/
|
|
233
233
|
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetContentDocumentResponse>;
|
|
234
234
|
/**
|
|
235
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you
|
|
235
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
236
236
|
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
237
237
|
* @param {*} [options] Override http request option.
|
|
238
238
|
* @throws {RequiredError}
|
|
239
239
|
*/
|
|
240
240
|
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<ListContentDocumentAsinRelationsResponse>;
|
|
241
241
|
/**
|
|
242
|
-
* 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
|
|
242
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
243
243
|
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
244
244
|
* @param {*} [options] Override http request option.
|
|
245
245
|
* @throws {RequiredError}
|
|
246
246
|
*/
|
|
247
247
|
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentApprovalSubmissionResponse>;
|
|
248
248
|
/**
|
|
249
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This
|
|
249
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
250
250
|
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
251
251
|
* @param {*} [options] Override http request option.
|
|
252
252
|
* @throws {RequiredError}
|
|
253
253
|
*/
|
|
254
254
|
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentAsinRelationsResponse>;
|
|
255
255
|
/**
|
|
256
|
-
* Submits a request to suspend visible A+ Content. This
|
|
256
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
257
257
|
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
258
258
|
* @param {*} [options] Override http request option.
|
|
259
259
|
* @throws {RequiredError}
|
|
260
260
|
*/
|
|
261
261
|
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentSuspendSubmissionResponse>;
|
|
262
262
|
/**
|
|
263
|
-
* Returns a list of all A+ Content documents assigned to a selling partner.
|
|
263
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
264
264
|
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
265
265
|
* @param {*} [options] Override http request option.
|
|
266
266
|
* @throws {RequiredError}
|
|
267
267
|
*/
|
|
268
268
|
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchContentDocumentsResponse>;
|
|
269
269
|
/**
|
|
270
|
-
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
270
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
271
271
|
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
272
272
|
* @param {*} [options] Override http request option.
|
|
273
273
|
* @throws {RequiredError}
|
|
274
274
|
*/
|
|
275
275
|
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SearchContentPublishRecordsResponse>;
|
|
276
276
|
/**
|
|
277
|
-
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
277
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
278
278
|
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
279
279
|
* @param {*} [options] Override http request option.
|
|
280
280
|
* @throws {RequiredError}
|
|
281
281
|
*/
|
|
282
282
|
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: RawAxiosRequestConfig): AxiosPromise<PostContentDocumentResponse>;
|
|
283
283
|
/**
|
|
284
|
-
* 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
|
|
284
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
285
285
|
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
286
286
|
* @param {*} [options] Override http request option.
|
|
287
287
|
* @throws {RequiredError}
|
|
@@ -295,7 +295,7 @@ export declare const AplusContentApiFactory: (configuration?: Configuration, bas
|
|
|
295
295
|
*/
|
|
296
296
|
export interface AplusContentApiCreateContentDocumentRequest {
|
|
297
297
|
/**
|
|
298
|
-
* The
|
|
298
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
299
299
|
* @type {string}
|
|
300
300
|
* @memberof AplusContentApiCreateContentDocument
|
|
301
301
|
*/
|
|
@@ -314,13 +314,13 @@ export interface AplusContentApiCreateContentDocumentRequest {
|
|
|
314
314
|
*/
|
|
315
315
|
export interface AplusContentApiGetContentDocumentRequest {
|
|
316
316
|
/**
|
|
317
|
-
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
317
|
+
* 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.
|
|
318
318
|
* @type {string}
|
|
319
319
|
* @memberof AplusContentApiGetContentDocument
|
|
320
320
|
*/
|
|
321
321
|
readonly contentReferenceKey: string;
|
|
322
322
|
/**
|
|
323
|
-
* The
|
|
323
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
324
324
|
* @type {string}
|
|
325
325
|
* @memberof AplusContentApiGetContentDocument
|
|
326
326
|
*/
|
|
@@ -339,19 +339,19 @@ export interface AplusContentApiGetContentDocumentRequest {
|
|
|
339
339
|
*/
|
|
340
340
|
export interface AplusContentApiListContentDocumentAsinRelationsRequest {
|
|
341
341
|
/**
|
|
342
|
-
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
342
|
+
* 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.
|
|
343
343
|
* @type {string}
|
|
344
344
|
* @memberof AplusContentApiListContentDocumentAsinRelations
|
|
345
345
|
*/
|
|
346
346
|
readonly contentReferenceKey: string;
|
|
347
347
|
/**
|
|
348
|
-
* The
|
|
348
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
349
349
|
* @type {string}
|
|
350
350
|
* @memberof AplusContentApiListContentDocumentAsinRelations
|
|
351
351
|
*/
|
|
352
352
|
readonly marketplaceId: string;
|
|
353
353
|
/**
|
|
354
|
-
* The set of A+ Content data types to include in the response. If you
|
|
354
|
+
* 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.
|
|
355
355
|
* @type {Set<'METADATA'>}
|
|
356
356
|
* @memberof AplusContentApiListContentDocumentAsinRelations
|
|
357
357
|
*/
|
|
@@ -363,7 +363,7 @@ export interface AplusContentApiListContentDocumentAsinRelationsRequest {
|
|
|
363
363
|
*/
|
|
364
364
|
readonly asinSet?: Set<string>;
|
|
365
365
|
/**
|
|
366
|
-
* A
|
|
366
|
+
* A token that you use to fetch a specific page when there are multiple pages of results.
|
|
367
367
|
* @type {string}
|
|
368
368
|
* @memberof AplusContentApiListContentDocumentAsinRelations
|
|
369
369
|
*/
|
|
@@ -376,13 +376,13 @@ export interface AplusContentApiListContentDocumentAsinRelationsRequest {
|
|
|
376
376
|
*/
|
|
377
377
|
export interface AplusContentApiPostContentDocumentApprovalSubmissionRequest {
|
|
378
378
|
/**
|
|
379
|
-
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
379
|
+
* 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.
|
|
380
380
|
* @type {string}
|
|
381
381
|
* @memberof AplusContentApiPostContentDocumentApprovalSubmission
|
|
382
382
|
*/
|
|
383
383
|
readonly contentReferenceKey: string;
|
|
384
384
|
/**
|
|
385
|
-
* The
|
|
385
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
386
386
|
* @type {string}
|
|
387
387
|
* @memberof AplusContentApiPostContentDocumentApprovalSubmission
|
|
388
388
|
*/
|
|
@@ -395,19 +395,19 @@ export interface AplusContentApiPostContentDocumentApprovalSubmissionRequest {
|
|
|
395
395
|
*/
|
|
396
396
|
export interface AplusContentApiPostContentDocumentAsinRelationsRequest {
|
|
397
397
|
/**
|
|
398
|
-
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
398
|
+
* 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.
|
|
399
399
|
* @type {string}
|
|
400
400
|
* @memberof AplusContentApiPostContentDocumentAsinRelations
|
|
401
401
|
*/
|
|
402
402
|
readonly contentReferenceKey: string;
|
|
403
403
|
/**
|
|
404
|
-
* The
|
|
404
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
405
405
|
* @type {string}
|
|
406
406
|
* @memberof AplusContentApiPostContentDocumentAsinRelations
|
|
407
407
|
*/
|
|
408
408
|
readonly marketplaceId: string;
|
|
409
409
|
/**
|
|
410
|
-
* The content document ASIN relations
|
|
410
|
+
* The request details for the content document ASIN relations.
|
|
411
411
|
* @type {PostContentDocumentAsinRelationsRequest}
|
|
412
412
|
* @memberof AplusContentApiPostContentDocumentAsinRelations
|
|
413
413
|
*/
|
|
@@ -420,13 +420,13 @@ export interface AplusContentApiPostContentDocumentAsinRelationsRequest {
|
|
|
420
420
|
*/
|
|
421
421
|
export interface AplusContentApiPostContentDocumentSuspendSubmissionRequest {
|
|
422
422
|
/**
|
|
423
|
-
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
423
|
+
* 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.
|
|
424
424
|
* @type {string}
|
|
425
425
|
* @memberof AplusContentApiPostContentDocumentSuspendSubmission
|
|
426
426
|
*/
|
|
427
427
|
readonly contentReferenceKey: string;
|
|
428
428
|
/**
|
|
429
|
-
* The
|
|
429
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
430
430
|
* @type {string}
|
|
431
431
|
* @memberof AplusContentApiPostContentDocumentSuspendSubmission
|
|
432
432
|
*/
|
|
@@ -439,13 +439,13 @@ export interface AplusContentApiPostContentDocumentSuspendSubmissionRequest {
|
|
|
439
439
|
*/
|
|
440
440
|
export interface AplusContentApiSearchContentDocumentsRequest {
|
|
441
441
|
/**
|
|
442
|
-
* The
|
|
442
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
443
443
|
* @type {string}
|
|
444
444
|
* @memberof AplusContentApiSearchContentDocuments
|
|
445
445
|
*/
|
|
446
446
|
readonly marketplaceId: string;
|
|
447
447
|
/**
|
|
448
|
-
* A
|
|
448
|
+
* A token that you use to fetch a specific page when there are multiple pages of results.
|
|
449
449
|
* @type {string}
|
|
450
450
|
* @memberof AplusContentApiSearchContentDocuments
|
|
451
451
|
*/
|
|
@@ -458,19 +458,19 @@ export interface AplusContentApiSearchContentDocumentsRequest {
|
|
|
458
458
|
*/
|
|
459
459
|
export interface AplusContentApiSearchContentPublishRecordsRequest {
|
|
460
460
|
/**
|
|
461
|
-
* The
|
|
461
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
462
462
|
* @type {string}
|
|
463
463
|
* @memberof AplusContentApiSearchContentPublishRecords
|
|
464
464
|
*/
|
|
465
465
|
readonly marketplaceId: string;
|
|
466
466
|
/**
|
|
467
|
-
* The Amazon Standard Identification Number (ASIN).
|
|
467
|
+
* The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
|
|
468
468
|
* @type {string}
|
|
469
469
|
* @memberof AplusContentApiSearchContentPublishRecords
|
|
470
470
|
*/
|
|
471
471
|
readonly asin: string;
|
|
472
472
|
/**
|
|
473
|
-
* A
|
|
473
|
+
* A token that you use to fetch a specific page when there are multiple pages of results.
|
|
474
474
|
* @type {string}
|
|
475
475
|
* @memberof AplusContentApiSearchContentPublishRecords
|
|
476
476
|
*/
|
|
@@ -483,13 +483,13 @@ export interface AplusContentApiSearchContentPublishRecordsRequest {
|
|
|
483
483
|
*/
|
|
484
484
|
export interface AplusContentApiUpdateContentDocumentRequest {
|
|
485
485
|
/**
|
|
486
|
-
* The unique reference key for the A+ Content document. A content reference key cannot form a permalink and
|
|
486
|
+
* 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.
|
|
487
487
|
* @type {string}
|
|
488
488
|
* @memberof AplusContentApiUpdateContentDocument
|
|
489
489
|
*/
|
|
490
490
|
readonly contentReferenceKey: string;
|
|
491
491
|
/**
|
|
492
|
-
* The
|
|
492
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
493
493
|
* @type {string}
|
|
494
494
|
* @memberof AplusContentApiUpdateContentDocument
|
|
495
495
|
*/
|
|
@@ -508,7 +508,7 @@ export interface AplusContentApiUpdateContentDocumentRequest {
|
|
|
508
508
|
*/
|
|
509
509
|
export interface AplusContentApiValidateContentDocumentAsinRelationsRequest {
|
|
510
510
|
/**
|
|
511
|
-
* The
|
|
511
|
+
* The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to [Marketplace IDs](https://developer-docs.amazon.com/sp-api/docs/marketplace-ids).
|
|
512
512
|
* @type {string}
|
|
513
513
|
* @memberof AplusContentApiValidateContentDocumentAsinRelations
|
|
514
514
|
*/
|
|
@@ -534,7 +534,7 @@ export interface AplusContentApiValidateContentDocumentAsinRelationsRequest {
|
|
|
534
534
|
*/
|
|
535
535
|
export declare class AplusContentApi extends BaseAPI {
|
|
536
536
|
/**
|
|
537
|
-
* Creates a new A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
537
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
538
538
|
* @param {AplusContentApiCreateContentDocumentRequest} requestParameters Request parameters.
|
|
539
539
|
* @param {*} [options] Override http request option.
|
|
540
540
|
* @throws {RequiredError}
|
|
@@ -542,7 +542,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
542
542
|
*/
|
|
543
543
|
createContentDocument(requestParameters: AplusContentApiCreateContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PostContentDocumentResponse, any>>;
|
|
544
544
|
/**
|
|
545
|
-
* Returns an A+ Content document, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
545
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
546
546
|
* @param {AplusContentApiGetContentDocumentRequest} requestParameters Request parameters.
|
|
547
547
|
* @param {*} [options] Override http request option.
|
|
548
548
|
* @throws {RequiredError}
|
|
@@ -550,7 +550,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
550
550
|
*/
|
|
551
551
|
getContentDocument(requestParameters: AplusContentApiGetContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<GetContentDocumentResponse, any>>;
|
|
552
552
|
/**
|
|
553
|
-
* Returns a list of ASINs related to the specified A+ Content document, if available. If you
|
|
553
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
554
554
|
* @param {AplusContentApiListContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
555
555
|
* @param {*} [options] Override http request option.
|
|
556
556
|
* @throws {RequiredError}
|
|
@@ -558,7 +558,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
558
558
|
*/
|
|
559
559
|
listContentDocumentAsinRelations(requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<ListContentDocumentAsinRelationsResponse, any>>;
|
|
560
560
|
/**
|
|
561
|
-
* 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
|
|
561
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
562
562
|
* @param {AplusContentApiPostContentDocumentApprovalSubmissionRequest} requestParameters Request parameters.
|
|
563
563
|
* @param {*} [options] Override http request option.
|
|
564
564
|
* @throws {RequiredError}
|
|
@@ -566,7 +566,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
566
566
|
*/
|
|
567
567
|
postContentDocumentApprovalSubmission(requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<import("../models").AplusResponse, any>>;
|
|
568
568
|
/**
|
|
569
|
-
* Replaces all ASINs related to the specified A+ Content document, if available. This
|
|
569
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
570
570
|
* @param {AplusContentApiPostContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
571
571
|
* @param {*} [options] Override http request option.
|
|
572
572
|
* @throws {RequiredError}
|
|
@@ -574,7 +574,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
574
574
|
*/
|
|
575
575
|
postContentDocumentAsinRelations(requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<import("../models").AplusResponse, any>>;
|
|
576
576
|
/**
|
|
577
|
-
* Submits a request to suspend visible A+ Content. This
|
|
577
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
578
578
|
* @param {AplusContentApiPostContentDocumentSuspendSubmissionRequest} requestParameters Request parameters.
|
|
579
579
|
* @param {*} [options] Override http request option.
|
|
580
580
|
* @throws {RequiredError}
|
|
@@ -582,7 +582,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
582
582
|
*/
|
|
583
583
|
postContentDocumentSuspendSubmission(requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<import("../models").AplusResponse, any>>;
|
|
584
584
|
/**
|
|
585
|
-
* Returns a list of all A+ Content documents assigned to a selling partner.
|
|
585
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
586
586
|
* @param {AplusContentApiSearchContentDocumentsRequest} requestParameters Request parameters.
|
|
587
587
|
* @param {*} [options] Override http request option.
|
|
588
588
|
* @throws {RequiredError}
|
|
@@ -590,7 +590,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
590
590
|
*/
|
|
591
591
|
searchContentDocuments(requestParameters: AplusContentApiSearchContentDocumentsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SearchContentDocumentsResponse, any>>;
|
|
592
592
|
/**
|
|
593
|
-
* Searches for A+ Content publishing records, if available. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
593
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
594
594
|
* @param {AplusContentApiSearchContentPublishRecordsRequest} requestParameters Request parameters.
|
|
595
595
|
* @param {*} [options] Override http request option.
|
|
596
596
|
* @throws {RequiredError}
|
|
@@ -598,7 +598,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
598
598
|
*/
|
|
599
599
|
searchContentPublishRecords(requestParameters: AplusContentApiSearchContentPublishRecordsRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<SearchContentPublishRecordsResponse, any>>;
|
|
600
600
|
/**
|
|
601
|
-
* Updates an existing A+ Content document. **Usage Plan:** | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The `x-amzn-RateLimit-Limit` response header
|
|
601
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
602
602
|
* @param {AplusContentApiUpdateContentDocumentRequest} requestParameters Request parameters.
|
|
603
603
|
* @param {*} [options] Override http request option.
|
|
604
604
|
* @throws {RequiredError}
|
|
@@ -606,7 +606,7 @@ export declare class AplusContentApi extends BaseAPI {
|
|
|
606
606
|
*/
|
|
607
607
|
updateContentDocument(requestParameters: AplusContentApiUpdateContentDocumentRequest, options?: RawAxiosRequestConfig): Promise<globalAxios.AxiosResponse<PostContentDocumentResponse, any>>;
|
|
608
608
|
/**
|
|
609
|
-
* 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
|
|
609
|
+
* 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](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).
|
|
610
610
|
* @param {AplusContentApiValidateContentDocumentAsinRelationsRequest} requestParameters Request parameters.
|
|
611
611
|
* @param {*} [options] Override http request option.
|
|
612
612
|
* @throws {RequiredError}
|