Messaging#

class sp_api.api.Messaging(marketplace: ~sp_api.base.marketplaces.Marketplaces = Marketplaces.US, *, refresh_token=None, account='default', credentials=None, restricted_data_token=None, proxies=None, verify=True, timeout=None, version=None, credential_providers=None, auth_token_client_class=<class 'sp_api.auth.access_token_client.AccessTokenClient'>)#

Messaging SP-API Client :link:

With the Messaging API you can build applications that send messages to buyers. You can get a list of message types that are available for an order that you specify, then call an operation that sends a message to the buyer for that order. The Messaging API returns responses that are formed according to the <a href=https://tools.ietf.org/html/draft-kelly-json-hal-08>JSON Hypertext Application Language</a> (HAL) standard.

get_messaging_actions_for_order(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().get_messaging_actions_for_order("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This specifies the order for which you want a list of available message types.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

Returns:

ApiResponse

confirm_customization_details(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().confirm_customization_details("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateConfirmCustomizationDetailsRequest | required This contains the message body for a message.

Returns:

ApiResponse

create_confirm_delivery_details(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().create_confirm_delivery_details("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateConfirmDeliveryDetailsRequest | required This contains the message body for a message.

Returns:

ApiResponse

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().create_legal_disclosure("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateLegalDisclosureRequest | required This contains the message body for a message.

Returns:

ApiResponse

create_negative_feedback_removal(self, order_id, **kwargs) → ApiResponse#

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.

Examples

literal blocks:

Messaging().create_negative_feedback_removal("value")
Parameters:

  • order_id –

    required

  • **kwargs

Returns:

ApiResponse

create_confirm_order_details(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().create_confirm_order_details("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateConfirmOrderDetailsRequest | required This contains the message body for a message.

Returns:

ApiResponse

create_confirm_service_details(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().create_confirm_service_details("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateConfirmServiceDetailsRequest | required This contains the message body for a message.

Returns:

ApiResponse

create_amazon_motors(self, order_id, **kwargs) → ApiResponse#

Sends a message to a buyer to provide details about an Amazon Motors order. This message can only be sent by Amazon Motors sellers.

Examples

literal blocks:

Messaging().create_amazon_motors("value")
Parameters:

  • order_id –

    required

  • **kwargs

Returns:

ApiResponse

create_warranty(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().create_warranty("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateWarrantyRequest | required This contains the message body for a message.

Returns:

ApiResponse

get_attributes(self, order_id, **kwargs) → ApiResponse#

Returns a response containing attributes related to an order. This includes buyer preferences.

Usage Plan:

Rate (requests per second)

Burst

1

5

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().get_attributes("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

Returns:

ApiResponse

create_digital_access_key(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().create_digital_access_key("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateDigitalAccessKeyRequest | required This contains the message body for a message.

Returns:

ApiResponse

create_unexpected_problem(self, order_id, **kwargs) → ApiResponse#

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

For more information, see “Usage Plans and Rate Limits” in the Selling Partner API documentation.

Examples

literal blocks:

Messaging().create_unexpected_problem("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – CreateUnexpectedProblemRequest | required This contains the message body for a message.

Returns:

ApiResponse

send_invoice(self, order_id, **kwargs) → ApiResponse#

Sends a message providing the buyer an invoice

Examples

literal blocks:

Messaging().send_invoice("value")
Parameters:

  • amazonOrderId – object | required An Amazon order identifier. This identifies the order for which a message is sent.

  • marketplaceIds (key) – object | required A marketplace identifier. This identifies the marketplace in which the order was placed. You can only specify one marketplace.

  • body – InvoiceRequest | required This contains the message body for a message.

Returns:

ApiResponse