Class AplusContentApi

AplusContentApi - object-oriented interface

Export

AplusContentApi

Hierarchy (View Summary)

Constructors

constructor

Properties

axios basePath configuration

Methods

createContentDocument getContentDocument listContentDocumentAsinRelations postContentDocumentApprovalSubmission postContentDocumentAsinRelations postContentDocumentSuspendSubmission searchContentDocuments searchContentPublishRecords updateContentDocument validateContentDocumentAsinRelations

Constructors

constructor

  • new AplusContentApi(
        configuration?: Configuration,
        basePath?: string,
        axios?: AxiosInstance,
    ): AplusContentApi

  • Parameters

    • Optionalconfiguration: Configuration
    • basePath: string = BASE_PATH
    • axios: AxiosInstance = globalAxios

    Returns AplusContentApi

Properties

Protectedaxios

axios: AxiosInstance = globalAxios

ProtectedbasePath

basePath: string = BASE_PATH

Protectedconfiguration

configuration: undefined | Configuration

Methods

createContentDocument

  • createContentDocument(
        requestParameters: AplusContentApiCreateContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<PostContentDocumentResponse, any>>

  • 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

    Returns Promise<AxiosResponse<PostContentDocumentResponse, any>>

    Throws

    Memberof

    AplusContentApi

getContentDocument

  • getContentDocument(
        requestParameters: AplusContentApiGetContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<GetContentDocumentResponse, any>>

  • 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

    Returns Promise<AxiosResponse<GetContentDocumentResponse, any>>

    Throws

    Memberof

    AplusContentApi

listContentDocumentAsinRelations

  • listContentDocumentAsinRelations(
        requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<ListContentDocumentAsinRelationsResponse, any>>

  • 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

    Returns Promise<AxiosResponse<ListContentDocumentAsinRelationsResponse, any>>

    Throws

    Memberof

    AplusContentApi

postContentDocumentApprovalSubmission

  • postContentDocumentApprovalSubmission(
        requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<AplusResponse, any>>

  • 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

    Returns Promise<AxiosResponse<AplusResponse, any>>

    Throws

    Memberof

    AplusContentApi

postContentDocumentAsinRelations

  • postContentDocumentAsinRelations(
        requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<AplusResponse, any>>

  • 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

    Returns Promise<AxiosResponse<AplusResponse, any>>

    Throws

    Memberof

    AplusContentApi

postContentDocumentSuspendSubmission

  • postContentDocumentSuspendSubmission(
        requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<AplusResponse, any>>

  • 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

    Returns Promise<AxiosResponse<AplusResponse, any>>

    Throws

    Memberof

    AplusContentApi

searchContentDocuments

  • searchContentDocuments(
        requestParameters: AplusContentApiSearchContentDocumentsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<SearchContentDocumentsResponse, any>>

  • 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

    Returns Promise<AxiosResponse<SearchContentDocumentsResponse, any>>

    Throws

    Memberof

    AplusContentApi

searchContentPublishRecords

  • searchContentPublishRecords(
        requestParameters: AplusContentApiSearchContentPublishRecordsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<SearchContentPublishRecordsResponse, any>>

  • 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

    Returns Promise<AxiosResponse<SearchContentPublishRecordsResponse, any>>

    Throws

    Memberof

    AplusContentApi

updateContentDocument

  • updateContentDocument(
        requestParameters: AplusContentApiUpdateContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<AxiosResponse<PostContentDocumentResponse, any>>

  • 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

    Returns Promise<AxiosResponse<PostContentDocumentResponse, any>>

    Throws

    Memberof

    AplusContentApi

validateContentDocumentAsinRelations

Settings

Member Visibility

On This Page

Constructors
Properties
Methods