Get order information

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

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

Prerequisites

To complete this tutorial, you need:

To access Personally Identifiable Information (PII), you must have approval for the following roles:

You do not need a Restricted Data Token to access PII with the Orders API v2026-01-01.

Get basic order information

Call the getOrder operation. If you do not specify includedData, then the response will only include basic information about the order and order items, such as orderId, createdTime, salesChannel, programs, orderItemId, product, and other relevant details.

Get order information with custom data sets

Call the getOrder operation and include the includedData parameter with the information you want the response to include.

Supported valuesDescriptionCorresponding attribute in the Order Schema
BUYERThe information of the buyer who purchased the order.Order.buyer
RECIPIENTThe information of the recipient to whom the order is delivered.Order.recipient
FULFILLMENTThe information about how this order is being processed and shipped applied to the order and order items.Order.fulfillment
Order.orderItems.fulfillment
PROCEEDSThe revenue and financial breakdown for the order and order items.Order.proceeds
Order.orderItems.proceeds
EXPENSEThe cost information applied to the order and order items.Order.orderItems.expense
PROMOTIONThe discount and promotional offer details applied to the order and order items.Order.orderItems.promotion
CANCELLATIONThe cancellation information applied to the order and order items.Order.orderItems.cancellation
PACKAGESThe shipping packages and tracking information.Order.packages