Function AplusContentApiFp

Returns {
    createContentDocument(
        marketplaceId: string,
        postContentDocumentRequest: PostContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PostContentDocumentResponse>,
    >;
    getContentDocument(
        contentReferenceKey: string,
        marketplaceId: string,
        includedDataSet: Set<GetContentDocumentIncludedDataSetEnum>,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetContentDocumentResponse>,
    >;
    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>,
    >;
    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>,
    >

    Creates a new A+ Content document. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • postContentDocumentRequest: PostContentDocumentRequest

      The content document request details.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getContentDocument:function

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

    Returns an A+ Content document, if available. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • contentReferenceKey: string

      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.
    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • 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

• listContentDocumentAsinRelations:function

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

    Returns a list of ASINs that are related to the specified A+ Content document, if available. If you don't include the asinSet parameter, this operation returns all ASINs related to the content document. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • contentReferenceKey: string

      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.
    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • OptionalincludedDataSet: Set<"METADATA">

      The set of A+ Content data types to include in the response. If you don&#39;t include this parameter, the operation returns the related ASINs without metadata.
    • OptionalasinSet: Set<string>

      The set of ASINs.
    • OptionalpageToken: string

      A token that you use to fetch a specific page when there are multiple pages of results.
    • 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • contentReferenceKey: string

      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.
    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • 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 operation can add or remove ASINs, depending on the current set of related ASINs. Removing an ASIN will suspend the content document from that ASIN. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • contentReferenceKey: string

      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.
    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • postContentDocumentAsinRelationsRequest: PostContentDocumentAsinRelationsRequest

      The request details for the content document ASIN relations.
    • 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 doesn't delete the content document or the ASIN relations. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • contentReferenceKey: string

      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.
    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • 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>,
    >

    Returns a list of all A+ Content documents, including metadata, that are assigned to a selling partner. To get the actual contents of the A+ Content documents, call the getContentDocument operation. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • OptionalpageToken: string

      A token that you use to fetch a specific page when there are multiple pages of results.
    • 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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • asin: string

      The Amazon Standard Identification Number (ASIN) is the unique identifier of a product within a marketplace.
    • OptionalpageToken: string

      A token that you use to fetch a specific page when there are multiple pages of results.
    • 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>,
    >

    Updates an existing A+ Content document. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 10 | 10 | The x-amzn-RateLimit-Limit response header contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • contentReferenceKey: string

      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.
    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • postContentDocumentRequest: PostContentDocumentRequest

      The content document request details.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    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 contains the usage plan rate limits for the operation, when available. The preceding table contains the default rate and burst values for this operation. Selling partners whose business demands require higher throughput might have higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits.

    Parameters

    • marketplaceId: string

      The marketplace ID is the globally unique identifier of a marketplace. To find the ID for your marketplace, refer to Marketplace IDs.
    • 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