Get delivery preferences for an Amazon Business order

Learn how to get delivery preferences for an Amazon Business order.

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 Direct-to-Consumer Delivery (Restricted) role assigned to your developer profile.
• The Direct-to-Consumer Delivery (Restricted) role selected in the app registration page for your application.

Step 1. Get the order IDs for an Amazon Business order

📘

Note

This is a restricted operation and requires a Restricted Data Token (RDT) for authorization. Some operations require restrictions because they contain customer PII data. These operations require passing an additional security review. For more information on RDT, refer to the Tokens API guide.

Call the getOrders operation. A successful response includes a payload object, which contains an Orders array of one or more orders, and optionally additional properties. An order is an Amazon Business order if the isBusinessOrder response attribute is set to true. The AmazonOrderId response attribute contains the order ID.

Step 2. Get order address details for an Amazon Business order

📘

Note

This is a restricted operation and requires a Restricted Data Token (RDT) for authorization. Some operations require restrictions because they contain customer PII data. These operations require passing an additional security review. For more information on RDT, refer to the Tokens API guide.

Call the getOrderAddress operation with an orderID to get all delivery preferences (DeliveryPreferences) that the user customer specified for the shipping address (DeliveryPreferences are only available for Amazon Business orders). If the customer did not specify delivery preferences for the address, the getOrderAddress operation returns the default business hours for the region. Ensure that:

• The order ID belongs to an Amazon Business order
• The order was created after February 8, 2023

📘

Note

The getOrderAddress operation does not return ShippingAddress for pending and cancelled orders.