Function MessagingApiFactory

MessagingApi - factory interface

Export

MessagingApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    confirmCustomizationDetails(
        requestParameters: MessagingApiConfirmCustomizationDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmCustomizationDetailsResponse>;
    createAmazonMotors(
        requestParameters: MessagingApiCreateAmazonMotorsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateAmazonMotorsResponse>;
    createConfirmDeliveryDetails(
        requestParameters: MessagingApiCreateConfirmDeliveryDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmDeliveryDetailsResponse>;
    createConfirmOrderDetails(
        requestParameters: MessagingApiCreateConfirmOrderDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmOrderDetailsResponse>;
    createConfirmServiceDetails(
        requestParameters: MessagingApiCreateConfirmServiceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmServiceDetailsResponse>;
    createDigitalAccessKey(
        requestParameters: MessagingApiCreateDigitalAccessKeyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateDigitalAccessKeyResponse>;
    createLegalDisclosure(
        requestParameters: MessagingApiCreateLegalDisclosureRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateLegalDisclosureResponse>;
    createNegativeFeedbackRemoval(
        requestParameters: MessagingApiCreateNegativeFeedbackRemovalRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateNegativeFeedbackRemovalResponse>;
    createUnexpectedProblem(
        requestParameters: MessagingApiCreateUnexpectedProblemRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateUnexpectedProblemResponse>;
    createWarranty(
        requestParameters: MessagingApiCreateWarrantyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateWarrantyResponse>;
    getAttributes(
        requestParameters: MessagingApiGetAttributesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAttributesResponse>;
    getMessagingActionsForOrder(
        requestParameters: MessagingApiGetMessagingActionsForOrderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetMessagingActionsForOrderResponse>;
    sendInvoice(
        requestParameters: MessagingApiSendInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InvoiceResponse>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    confirmCustomizationDetails(
        requestParameters: MessagingApiConfirmCustomizationDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmCustomizationDetailsResponse>;
    createAmazonMotors(
        requestParameters: MessagingApiCreateAmazonMotorsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateAmazonMotorsResponse>;
    createConfirmDeliveryDetails(
        requestParameters: MessagingApiCreateConfirmDeliveryDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmDeliveryDetailsResponse>;
    createConfirmOrderDetails(
        requestParameters: MessagingApiCreateConfirmOrderDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmOrderDetailsResponse>;
    createConfirmServiceDetails(
        requestParameters: MessagingApiCreateConfirmServiceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmServiceDetailsResponse>;
    createDigitalAccessKey(
        requestParameters: MessagingApiCreateDigitalAccessKeyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateDigitalAccessKeyResponse>;
    createLegalDisclosure(
        requestParameters: MessagingApiCreateLegalDisclosureRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateLegalDisclosureResponse>;
    createNegativeFeedbackRemoval(
        requestParameters: MessagingApiCreateNegativeFeedbackRemovalRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateNegativeFeedbackRemovalResponse>;
    createUnexpectedProblem(
        requestParameters: MessagingApiCreateUnexpectedProblemRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateUnexpectedProblemResponse>;
    createWarranty(
        requestParameters: MessagingApiCreateWarrantyRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateWarrantyResponse>;
    getAttributes(
        requestParameters: MessagingApiGetAttributesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAttributesResponse>;
    getMessagingActionsForOrder(
        requestParameters: MessagingApiGetMessagingActionsForOrderRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetMessagingActionsForOrderResponse>;
    sendInvoice(
        requestParameters: MessagingApiSendInvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<InvoiceResponse>;
}
- confirmCustomizationDetails:function
  - confirmCustomizationDetails(
    requestParameters: MessagingApiConfirmCustomizationDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmCustomizationDetailsResponse>
  - Sends a message asking a buyer to provide or verify customization details such as name spelling, images, initials, etc. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiConfirmCustomizationDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateConfirmCustomizationDetailsResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:861
- createAmazonMotors:function
  - createAmazonMotors(
    requestParameters: MessagingApiCreateAmazonMotorsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateAmazonMotorsResponse>
  - Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateAmazonMotorsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateAmazonMotorsResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:870
- createConfirmDeliveryDetails:function
  - createConfirmDeliveryDetails(
    requestParameters: MessagingApiCreateConfirmDeliveryDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmDeliveryDetailsResponse>
  - Sends a message to a buyer to arrange a delivery or to confirm contact information for making a delivery. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateConfirmDeliveryDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateConfirmDeliveryDetailsResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:879
- createConfirmOrderDetails:function
  - createConfirmOrderDetails(
    requestParameters: MessagingApiCreateConfirmOrderDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmOrderDetailsResponse>
  - Sends a message to ask a buyer an order-related question prior to shipping their order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateConfirmOrderDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateConfirmOrderDetailsResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:888
- createConfirmServiceDetails:function
  - createConfirmServiceDetails(
    requestParameters: MessagingApiCreateConfirmServiceDetailsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateConfirmServiceDetailsResponse>
  - Sends a message to contact a Home Service customer to arrange a service call or to gather information prior to a service call. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateConfirmServiceDetailsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateConfirmServiceDetailsResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:897
- createDigitalAccessKey:function
  - createDigitalAccessKey(
    requestParameters: MessagingApiCreateDigitalAccessKeyRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateDigitalAccessKeyResponse>
  - Sends a message to a buyer to share a digital access key needed to utilize digital content in their order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateDigitalAccessKeyRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateDigitalAccessKeyResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:906
- createLegalDisclosure:function
  - createLegalDisclosure(
    requestParameters: MessagingApiCreateLegalDisclosureRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateLegalDisclosureResponse>
  - Sends a critical message that contains documents that a seller is legally obligated to provide to the buyer. This message should only be used to deliver documents that are required by law. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateLegalDisclosureRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateLegalDisclosureResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:915
- createNegativeFeedbackRemoval:function
  - createNegativeFeedbackRemoval(
    requestParameters: MessagingApiCreateNegativeFeedbackRemovalRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateNegativeFeedbackRemovalResponse>
  - Sends a non-critical message that asks a buyer to remove their negative feedback. This message should only be sent after the seller has resolved the buyer's problem. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateNegativeFeedbackRemovalRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateNegativeFeedbackRemovalResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:924
- createUnexpectedProblem:function
  - createUnexpectedProblem(
    requestParameters: MessagingApiCreateUnexpectedProblemRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateUnexpectedProblemResponse>
  - Sends a critical message to a buyer that an unexpected problem was encountered affecting the completion of the order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateUnexpectedProblemRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateUnexpectedProblemResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:933
- createWarranty:function
  - createWarranty(
    requestParameters: MessagingApiCreateWarrantyRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<CreateWarrantyResponse>
  - Sends a message to a buyer to provide details about warranty information on a purchase in their order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiCreateWarrantyRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<CreateWarrantyResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:942
- getAttributes:function
  - getAttributes(
    requestParameters: MessagingApiGetAttributesRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAttributesResponse>
  - Returns a response containing attributes related to an order. This includes buyer preferences. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 |
    Parameters
    - requestParameters: MessagingApiGetAttributesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetAttributesResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:951
- getMessagingActionsForOrder:function
  - getMessagingActionsForOrder(
    requestParameters: MessagingApiGetMessagingActionsForOrderRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetMessagingActionsForOrderResponse>
  - Returns a list of message types that are available for an order that you specify. A message type is represented by an actions object, which contains a path and query parameter(s). You can use the path and parameter(s) to call an operation that sends a message. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above 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, see Usage Plans and Rate Limits in the Selling Partner API.
    Parameters
    - requestParameters: MessagingApiGetMessagingActionsForOrderRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<GetMessagingActionsForOrderResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:960
- sendInvoice:function
  - sendInvoice(
    requestParameters: MessagingApiSendInvoiceRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<InvoiceResponse>
  - Sends a message providing the buyer an invoice
    Parameters
    - requestParameters: MessagingApiSendInvoiceRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<InvoiceResponse>
    Throws
    - Defined in api-model/api/messaging-api.ts:969
- Defined in api-model/api/messaging-api.ts:852

Function MessagingApiFactory

Export

Parameters

confirmCustomizationDetails:function

Parameters

Returns AxiosPromise<CreateConfirmCustomizationDetailsResponse>

Throws

createAmazonMotors:function

Parameters

Returns AxiosPromise<CreateAmazonMotorsResponse>

Throws

createConfirmDeliveryDetails:function

Parameters

Returns AxiosPromise<CreateConfirmDeliveryDetailsResponse>

Throws

createConfirmOrderDetails:function

Parameters

Returns AxiosPromise<CreateConfirmOrderDetailsResponse>

Throws

createConfirmServiceDetails:function

Parameters

Returns AxiosPromise<CreateConfirmServiceDetailsResponse>

Throws

createDigitalAccessKey:function

Parameters

Returns AxiosPromise<CreateDigitalAccessKeyResponse>

Throws

createLegalDisclosure:function

Parameters

Returns AxiosPromise<CreateLegalDisclosureResponse>

Throws

createNegativeFeedbackRemoval:function

Parameters

Returns AxiosPromise<CreateNegativeFeedbackRemovalResponse>

Throws

createUnexpectedProblem:function

Parameters

Returns AxiosPromise<CreateUnexpectedProblemResponse>

Throws

createWarranty:function

Parameters

Returns AxiosPromise<CreateWarrantyResponse>

Throws

getAttributes:function

Parameters

Returns AxiosPromise<GetAttributesResponse>

Throws

getMessagingActionsForOrder:function

Parameters

Returns AxiosPromise<GetMessagingActionsForOrderResponse>

Throws

sendInvoice:function

Parameters

Returns AxiosPromise<InvoiceResponse>

Throws

Settings