Get order information

Learn how to use the Orders API to get order information.

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 Inventory and Order Tracking role assigned to your developer profile.
• The Inventory and Order Tracking role selected in the app registration page for your application.

To access buyer and shipping address information, you must:

• Have approval for the following roles:

  • Direct-to-Consumer Delivery (Restricted) role is required to access shipping address information.
  • The Tax Remittance (Restricted) role is required to access buyer information.
  • The Tax Invoicing (Restricted) role is required to access buyer information.

• Use a Restricted Data Token (RDT):

  • Follow the Tokens API Use Case Guide to get an RDT that provides authorization to access Personally Identifiable Information (PII) for an operation.
  • Use any of the following values in the dataElements parameter in the createRestrictedDataToken operation to access the getOrder operation:
    • buyerInfo
    • shippingAddress
    • buyerTaxInformation

Get the order information

📘

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 getOrder operation.