Function AplusContentApiFp

AplusContentApi - functional programming interface

Export

  • AplusContentApiFp(
        configuration?: Configuration,
    ): {
        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>,
        >;
    }

  • Parameters

    • Optionalconfiguration: Configuration

    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 Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        Parameters

        • marketplaceId: string

          The identifier for the marketplace 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

    • 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 Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        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 marketplace 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

    • 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 related to the specified A+ Content document, if available. If you do not include the asinSet parameter, the operation returns all ASINs related to the content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        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 marketplace 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 Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        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 marketplace 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 Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        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 marketplace 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 Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        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 marketplace 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>,
        >

      • Returns a list of all A+ Content documents assigned to a selling partner. This operation returns only the metadata of the A+ Content documents. Call the getContentDocument operation to get the actual contents of the A+ Content documents. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        Parameters

        • marketplaceId: string

          The identifier for the marketplace 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 Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        Parameters

        • marketplaceId: string

          The identifier for the marketplace 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>,
        >

      • Updates an existing A+ Content document. Usage Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        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 marketplace 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

    • 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 Plans: | Plan type | Rate (requests per second) | Burst | | ---- | ---- | ---- | |Default| 10 | 10 | |Selling partner specific| Variable | Variable | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation. Rate limits for some selling partners will vary from the default rate and burst shown in the table above. For more information, see "Usage Plans and Rate Limits" in the Selling Partner API documentation.

        Parameters

        • marketplaceId: string

          The identifier for the marketplace 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

Settings

Member Visibility