Function AplusContentApiFp

Returns {
    createContentDocument(
        marketplaceId: string,
        postContentDocumentRequest: PostContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PostContentDocumentResponse>,
    >;
    createMedia(
        createMediaRequest: CreateMediaRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateMediaResponse>,
    >;
    getContentDocument(
        contentReferenceKey: string,
        marketplaceId: string,
        includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetContentDocumentResponse>,
    >;
    getMedia(
        mediaId: string,
        associatedMediaId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetMediaResponse>,
    >;
    listContentDocumentAsinRelations(
        contentReferenceKey: string,
        marketplaceId: string,
        includedDataSet?: Set<"METADATA">,
        asinSet?: Set<string>,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListContentDocumentAsinRelationsResponse>,
    >;
    postContentDocumentApprovalSubmission(
        contentReferenceKey: string,
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >;
    postContentDocumentAsinRelations(
        contentReferenceKey: string,
        marketplaceId: string,
        postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >;
    postContentDocumentSuspendSubmission(
        contentReferenceKey: string,
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >;
    searchContentDocuments(
        marketplaceId: string,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchContentDocumentsResponse>,
    >;
    searchContentPublishRecords(
        marketplaceId: string,
        asin: string,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchContentPublishRecordsResponse>,
    >;
    updateContentDocument(
        contentReferenceKey: string,
        marketplaceId: string,
        postContentDocumentRequest: PostContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PostContentDocumentResponse>,
    >;
    updateMedia(
        mediaId: string,
        updateMediaRequest: UpdateMediaRequest,
        associatedMediaId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateMediaResponse>,
    >;
    validateContentDocumentAsinRelations(
        marketplaceId: string,
        postContentDocumentRequest: PostContentDocumentRequest,
        asinSet?: Set<string>,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ValidateContentDocumentAsinRelationsResponse>,
    >;
}

• createContentDocument: function

  • createContentDocument(
        marketplaceId: string,
        postContentDocumentRequest: PostContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PostContentDocumentResponse>,
    >

    Create a new A+ Content document. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • postContentDocumentRequest: PostContentDocumentRequest

      The content document request details.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PostContentDocumentResponse>,
    >

    Throws

• createMedia: function

  • createMedia(
        createMediaRequest: CreateMediaRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateMediaResponse>,
    >

    Create a media asset record. The mediaType field determines the type of asset to create. This operation is idempotent; if the asset or pairing already exists with identical metadata, this operation returns a 200 response with existing data. Returns 201 when a new asset or pairing is created. Returns 409 if the asset or pairing already exists but the metadata fields differ. If an uploadDestinationId is provided, it is resolved to its mediaId before any further processing. A request that references an asset by uploadDestinationId and a subsequent request that uses the resulting mediaId are treated as referring to the same identity. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • createMediaRequest: CreateMediaRequest

      The media creation request details.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateMediaResponse>,
    >

    Throws

• getContentDocument: function

  • getContentDocument(
        contentReferenceKey: string,
        marketplaceId: string,
        includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetContentDocumentResponse>,
    >

    Retrieve an A+ Content document, if available. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • contentReferenceKey: string

      The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>

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

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetContentDocumentResponse>,
    >

    Throws

• getMedia: function

  • getMedia(
        mediaId: string,
        associatedMediaId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetMediaResponse>,
    >

    Retrieve media metadata and related media for a given media ID. The response uses the unified Media shape. Related media associations are also included in the response. When associatedMediaId is provided, relatedMedia is filtered to the specific pairing. When omitted, all related media are returned. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • mediaId: string

      The unique identifier for the media asset.

    • OptionalassociatedMediaId: string

      When provided, returns only the specific association. When omitted, returns all associated media.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetMediaResponse>,
    >

    Throws

• listContentDocumentAsinRelations: function

  • listContentDocumentAsinRelations(
        contentReferenceKey: string,
        marketplaceId: string,
        includedDataSet?: Set<"METADATA">,
        asinSet?: Set<string>,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListContentDocumentAsinRelationsResponse>,
    >

    Retrieve a list of ASINs related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • contentReferenceKey: string

      The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • OptionalincludedDataSet: Set<"METADATA">

      The set of A+ Content data types to include in the response. If you do not include this parameter, the operation returns the related ASINs without metadata.

    • OptionalasinSet: Set<string>

      The set of ASINs.

    • OptionalpageToken: string

      A page token from the `nextPageToken` response element returned by your previous call to this operation. `nextPageToken` is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include `pageToken` as the only parameter. Specifying `pageToken` with any other parameter will cause the request to fail. When no `nextPageToken` value is returned there are no more pages to return. A `pageToken` value is not usable across different operations.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ListContentDocumentAsinRelationsResponse>,
    >

    Throws

• postContentDocumentApprovalSubmission: function

  • postContentDocumentApprovalSubmission(
        contentReferenceKey: string,
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >

    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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • contentReferenceKey: string

      The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >

    Throws

• postContentDocumentAsinRelations: function

  • postContentDocumentAsinRelations(
        contentReferenceKey: string,
        marketplaceId: string,
        postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >

    Replaces all ASINs related to the specified A+ Content document, if available. This may add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN has the side effect of suspending the content document from that ASIN. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • contentReferenceKey: string

      The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest

      The content document ASIN relations request details.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >

    Throws

• postContentDocumentSuspendSubmission: function

  • postContentDocumentSuspendSubmission(
        contentReferenceKey: string,
        marketplaceId: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >

    Submits a request to suspend visible A+ Content. This neither deletes the content document nor the ASIN relations. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • contentReferenceKey: string

      The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<AplusResponse>,
    >

    Throws

• searchContentDocuments: function

  • searchContentDocuments(
        marketplaceId: string,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchContentDocumentsResponse>,
    >

    Retrieve a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • OptionalpageToken: string

      A page token from the `nextPageToken` response element returned by your previous call to this operation. `nextPageToken` is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include `pageToken` as the only parameter. Specifying `pageToken` with any other parameter will cause the request to fail. When no `nextPageToken` value is returned there are no more pages to return. A `pageToken` value is not usable across different operations.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchContentDocumentsResponse>,
    >

    Throws

• searchContentPublishRecords: function

  • searchContentPublishRecords(
        marketplaceId: string,
        asin: string,
        pageToken?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchContentPublishRecordsResponse>,
    >

    Searches for A+ Content publishing records, if available. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • asin: string

      The Amazon Standard Identification Number (ASIN).

    • OptionalpageToken: string

      A page token from the `nextPageToken` response element returned by your previous call to this operation. `nextPageToken` is returned when the results of a call exceed the page size. To get the next page of results, call the operation and include `pageToken` as the only parameter. Specifying `pageToken` with any other parameter will cause the request to fail. When no `nextPageToken` value is returned there are no more pages to return. A `pageToken` value is not usable across different operations.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<SearchContentPublishRecordsResponse>,
    >

    Throws

• updateContentDocument: function

  • updateContentDocument(
        contentReferenceKey: string,
        marketplaceId: string,
        postContentDocumentRequest: PostContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PostContentDocumentResponse>,
    >

    Update an existing A+ Content document. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • contentReferenceKey: string

      The unique reference key for the A+ Content document. A content reference key cannot form a permalink and may change in the future. A content reference key is not guaranteed to match any A+ Content identifier.

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • postContentDocumentRequest: PostContentDocumentRequest

      The content document request details.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PostContentDocumentResponse>,
    >

    Throws

• updateMedia: function

  • updateMedia(
        mediaId: string,
        updateMediaRequest: UpdateMediaRequest,
        associatedMediaId?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateMediaResponse>,
    >

    Update metadata on an existing media asset. The mediaId path parameter identifies the target asset. For video-image pairing title updates, provide associatedMediaId as a query parameter. For video-level description updates or standalone image title updates, omit associatedMediaId. Each request updates either title or descriptions, but not both. Descriptions are upserted by locale; only provided locales are modified, and existing locales not in the request are preserved. The response contains the full unified Media shape. When associatedMediaId is provided, relatedMedia contains only the specified pairing. When associatedMediaId is absent, relatedMedia contains all affected pairings. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • mediaId: string

      The unique identifier for the media asset to update.

    • updateMediaRequest: UpdateMediaRequest

      The media update request details.

    • OptionalassociatedMediaId: string

      When provided, identifies the specific video-image pairing for title updates. Required when updating a pairing title.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateMediaResponse>,
    >

    Throws

• validateContentDocumentAsinRelations: function

  • validateContentDocumentAsinRelations(
        marketplaceId: string,
        postContentDocumentRequest: PostContentDocumentRequest,
        asinSet?: Set<string>,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ValidateContentDocumentAsinRelationsResponse>,
    >

    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 returns the usage plan rate limits that were applied to the requested operation, when available. The preceding table indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

    Parameters

    • marketplaceId: string

      The identifier for the Amazon store where the A+ Content is published.

    • postContentDocumentRequest: PostContentDocumentRequest

      The content document request details.

    • OptionalasinSet: Set<string>

      The set of ASINs.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<ValidateContentDocumentAsinRelationsResponse>,
    >

    Throws