Function AplusContentApiFactory

AplusContentApi - factory interface

Export

AplusContentApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    createContentDocument(
        requestParameters: AplusContentApiCreateContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PostContentDocumentResponse>;
    getContentDocument(
        requestParameters: AplusContentApiGetContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetContentDocumentResponse>;
    listContentDocumentAsinRelations(
        requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListContentDocumentAsinRelationsResponse>;
    postContentDocumentApprovalSubmission(
        requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AplusResponse>;
    postContentDocumentAsinRelations(
        requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AplusResponse>;
    postContentDocumentSuspendSubmission(
        requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AplusResponse>;
    searchContentDocuments(
        requestParameters: AplusContentApiSearchContentDocumentsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SearchContentDocumentsResponse>;
    searchContentPublishRecords(
        requestParameters: AplusContentApiSearchContentPublishRecordsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SearchContentPublishRecordsResponse>;
    updateContentDocument(
        requestParameters: AplusContentApiUpdateContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PostContentDocumentResponse>;
    validateContentDocumentAsinRelations(
        requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ValidateContentDocumentAsinRelationsResponse>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    createContentDocument(
        requestParameters: AplusContentApiCreateContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PostContentDocumentResponse>;
    getContentDocument(
        requestParameters: AplusContentApiGetContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetContentDocumentResponse>;
    listContentDocumentAsinRelations(
        requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ListContentDocumentAsinRelationsResponse>;
    postContentDocumentApprovalSubmission(
        requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AplusResponse>;
    postContentDocumentAsinRelations(
        requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AplusResponse>;
    postContentDocumentSuspendSubmission(
        requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<AplusResponse>;
    searchContentDocuments(
        requestParameters: AplusContentApiSearchContentDocumentsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SearchContentDocumentsResponse>;
    searchContentPublishRecords(
        requestParameters: AplusContentApiSearchContentPublishRecordsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<SearchContentPublishRecordsResponse>;
    updateContentDocument(
        requestParameters: AplusContentApiUpdateContentDocumentRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<PostContentDocumentResponse>;
    validateContentDocumentAsinRelations(
        requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<ValidateContentDocumentAsinRelationsResponse>;
}
- createContentDocument:function
  - createContentDocument(
    requestParameters: AplusContentApiCreateContentDocumentRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiCreateContentDocumentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PostContentDocumentResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:670
- getContentDocument:function
  - getContentDocument(
    requestParameters: AplusContentApiGetContentDocumentRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiGetContentDocumentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetContentDocumentResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:679
- listContentDocumentAsinRelations:function
  - listContentDocumentAsinRelations(
    requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiListContentDocumentAsinRelationsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ListContentDocumentAsinRelationsResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:688
- postContentDocumentApprovalSubmission:function
  - postContentDocumentApprovalSubmission(
    requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiPostContentDocumentApprovalSubmissionRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<AplusResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:697
- postContentDocumentAsinRelations:function
  - postContentDocumentAsinRelations(
    requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiPostContentDocumentAsinRelationsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<AplusResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:706
- postContentDocumentSuspendSubmission:function
  - postContentDocumentSuspendSubmission(
    requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiPostContentDocumentSuspendSubmissionRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<AplusResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:715
- searchContentDocuments:function
  - searchContentDocuments(
    requestParameters: AplusContentApiSearchContentDocumentsRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiSearchContentDocumentsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<SearchContentDocumentsResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:724
- searchContentPublishRecords:function
  - searchContentPublishRecords(
    requestParameters: AplusContentApiSearchContentPublishRecordsRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiSearchContentPublishRecordsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<SearchContentPublishRecordsResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:733
- updateContentDocument:function
  - updateContentDocument(
    requestParameters: AplusContentApiUpdateContentDocumentRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiUpdateContentDocumentRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<PostContentDocumentResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:742
- validateContentDocumentAsinRelations:function
  - validateContentDocumentAsinRelations(
    requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest,
    options?: RawAxiosRequestConfig,
    ): 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
    - requestParameters: AplusContentApiValidateContentDocumentAsinRelationsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<ValidateContentDocumentAsinRelationsResponse>
    Throws
    - Defined in api-model/api/aplus-content-api.ts:751
- Defined in api-model/api/aplus-content-api.ts:661

Function AplusContentApiFactory

Export

Parameters

createContentDocument:function

Parameters

Returns AxiosPromise<PostContentDocumentResponse>

Throws

getContentDocument:function

Parameters

Returns AxiosPromise<GetContentDocumentResponse>

Throws

listContentDocumentAsinRelations:function

Parameters

Returns AxiosPromise<ListContentDocumentAsinRelationsResponse>

Throws

postContentDocumentApprovalSubmission:function

Parameters

Returns AxiosPromise<AplusResponse>

Throws

postContentDocumentAsinRelations:function

Parameters

Returns AxiosPromise<AplusResponse>

Throws

postContentDocumentSuspendSubmission:function

Parameters

Returns AxiosPromise<AplusResponse>

Throws

searchContentDocuments:function

Parameters

Returns AxiosPromise<SearchContentDocumentsResponse>

Throws

searchContentPublishRecords:function

Parameters

Returns AxiosPromise<SearchContentPublishRecordsResponse>

Throws

updateContentDocument:function

Parameters

Returns AxiosPromise<PostContentDocumentResponse>

Throws

validateContentDocumentAsinRelations:function

Parameters

Returns AxiosPromise<ValidateContentDocumentAsinRelationsResponse>

Throws

Settings