Function MessagingApiFp

Returns {
    confirmCustomizationDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmCustomizationDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateConfirmCustomizationDetailsResponse>,
    >;
    createAmazonMotors(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateAmazonMotorsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateAmazonMotorsResponse>,
    >;
    createConfirmDeliveryDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmDeliveryDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateConfirmDeliveryDetailsResponse>,
    >;
    createConfirmOrderDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmOrderDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateConfirmOrderDetailsResponse>,
    >;
    createConfirmServiceDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmServiceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateConfirmServiceDetailsResponse>,
    >;
    createDigitalAccessKey(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateDigitalAccessKeyRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateDigitalAccessKeyResponse>,
    >;
    createLegalDisclosure(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateLegalDisclosureRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateLegalDisclosureResponse>,
    >;
    createUnexpectedProblem(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateUnexpectedProblemRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateUnexpectedProblemResponse>,
    >;
    createWarranty(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateWarrantyRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateWarrantyResponse>,
    >;
    getAttributes(
        amazonOrderId: string,
        marketplaceIds: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAttributesResponse>,
    >;
    getMessagingActionsForOrder(
        amazonOrderId: string,
        marketplaceIds: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetMessagingActionsForOrderResponse>,
    >;
    sendInvoice(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: InvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >;
}

• confirmCustomizationDetails: function

  • confirmCustomizationDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmCustomizationDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateConfirmCustomizationDetailsRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createAmazonMotors: function

  • createAmazonMotors(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateAmazonMotorsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateAmazonMotorsRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createConfirmDeliveryDetails: function

  • createConfirmDeliveryDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmDeliveryDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateConfirmDeliveryDetailsRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createConfirmOrderDetails: function

  • createConfirmOrderDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmOrderDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateConfirmOrderDetailsRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createConfirmServiceDetails: function

  • createConfirmServiceDetails(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateConfirmServiceDetailsRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateConfirmServiceDetailsRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createDigitalAccessKey: function

  • createDigitalAccessKey(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateDigitalAccessKeyRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<CreateDigitalAccessKeyResponse>,
    >

    Sends a buyer a message to share a digital access key that is required to utilize digital content in their order. Usage Plan: | Rate (requests per second) | Burst | | ---- | ---- | | 1 | 5 | 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateDigitalAccessKeyRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createLegalDisclosure: function

  • createLegalDisclosure(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateLegalDisclosureRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateLegalDisclosureRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createUnexpectedProblem: function

  • createUnexpectedProblem(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateUnexpectedProblemRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateUnexpectedProblemRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• createWarranty: function

  • createWarranty(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: CreateWarrantyRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: CreateWarrantyRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getAttributes: function

  • getAttributes(
        amazonOrderId: string,
        marketplaceIds: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• getMessagingActionsForOrder: function

  • getMessagingActionsForOrder(
        amazonOrderId: string,
        marketplaceIds: string[],
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => 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 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

    • amazonOrderId: string

      An Amazon order identifier. This specifies the order for which you want a list of available message types.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws

• sendInvoice: function

  • sendInvoice(
        amazonOrderId: string,
        marketplaceIds: string[],
        body: InvoiceRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<InvoiceResponse>,
    >

    Sends a message providing the buyer an invoice

    Parameters

    • amazonOrderId: string

      An Amazon order identifier. This identifies the order for which a message is sent.

    • marketplaceIds: string[]

      A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

    • body: InvoiceRequest

      This contains the message body for a message.

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

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

    Throws