Set up the Solicitations API

Learn how to set up the Solicitations API before soliciting feedback.

Prerequisites

To complete this tutorial, you need:

• Authorization from the selling partner for whom you are making calls. For more information, refer to Authorizing Selling Partner API applications.
• The Buyer Solicitation role or Product Listing role assigned to your developer profile.
• The Buyer Solicitation role or Product Listing role selected in the app registration page for your application.

Step 1. Subscribe to the ORDER_CHANGE notification

For more information, refer to Tutorial: Subscribe to the ORDER_CHANGE Notification.

Step 2. Validate the OrderStatus parameter

The Amazon Simple Queue Service (SQS) workflows receives the payload of the ORDER_CHANGE notification. You can use Amazon SQS to validate the OrderStatus parameter. Check that the OrderStatus value has changed to Shipped. Eliminate redundancies to make sure whether a solicitation has already been dispatched for a specific order. For more information on how to poll the SQS queue, refer to Tutorial: Set up notifications (Amazon Simple Queue Service workflow).

Step 3. Check the EarliestDeliveryDate and LatestDeliveryDate parameters

You can request solicitation within a time frame of five days after the EarliestDeliveryDate to 30 days after the LatestDeliveryDate. Calling the Solicitations API outside this time frame will lead to unexpected API errors.

Step 4. Store key identifiers

Archive or cache the amazonOrderId and MarketplaceId parameters. These identifiers are required to solicit reviews in the future.

Now you are ready to solicit feedback.