Messaging API

You use the Messaging API to send messages to buyers.

Release notes

For releases prior to January 19, 2022, refer to Announcements in the Selling Partner API GitHub repository.

To learn more about the terms that are used in this guide, refer to Terminology.

Message availability

Not all message types are available in all circumstances. There are a number of factors that can affect message availability, including whether the order has been fulfilled, the type of seller, or the number of messages already sent for the order.

Workflow for sending a message

The following is for the user of the application. Sending a message is a multi-step process that includes calls to operations in both the Messaging API and the Uploads API. Here is the basic workflow for sending a message:

1. Your application displays the seller's recent orders, and the seller chooses an order for which they want to send a message to the buyer.

2. Your application displays the message types that are available for the order that the seller chooses. Get the available message types by calling the getMessagingActionsForOrder operation of the Messaging API.

3. The seller chooses a message type for the order.

4. If custom messages are supported for the message type, the seller inputs a custom message.

5. If attachments are supported for the message type, the seller uploads an attachment to your application. The seller also inputs a file name for the attachment.

6. If the seller uploads an attachment to your application, your application uploads the attachment to an Amazon S3 bucket by doing the following:

   • Calculating a Content-MD5 hash for the attachment, which is needed for creating an upload destination.

   • Creating an upload destination by calling the createUploadDestination operation of the Uploads API.

   • Uploading the attachment to the destination.

7. Your application requests that a message be sent from the seller to the buyer by calling the operation that corresponds to the message type that the seller chose in step #3. For example, your application calls the createConfirmOrderDetails operation if the seller chose the "Confirm order details" message type.

8. Amazon emails a message from the seller to the buyer. Refer to Tutorial: Send a message for the detailed workflow.

Use cases

The following use case example is available for the Messaging API v1:

• Send a message: Learn how to make an application that lets a seller send a message to a buyer.

Roles

confirmCustomizationDetails

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

CreateAmazonMotors

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Amazon Fulfillment Buyer Communication

createConfirmDeliveryDetails

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

createConfirmOrderDetails

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

createConfirmServiceDetails

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

createDigitalAccessKey

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

createLegalDisclosure

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

createNegativeFeedbackRemoval

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

createUnexpectedProblem

Attribute	Value
Regions	NA, FE
Required roles (need at least one)	Buyer Communication Product Listing

CreateWarranty

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

GetAttributes

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

getMessagingActionsForOrder

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication

sendInvoice

Attribute	Value
Regions	NA, EU, FE
Required roles (need at least one)	Buyer Communication