About the eCommerce Orders API
The eCommerce Orders API allows apps or site owners to customize management of the order lifecycle, including viewing, updating, and canceling. In the dashboard, business staff can create new orders, view and edit existing orders, track fulfillment, and manage the payments cycle.
An order holds information about purchased items, price and tax summaries, shipping and billing information, any applied discounts, and the status of payment and fulfillment.
With the eCommerce Orders API you can:
- Get and search for orders.
- Update and cancel an order.
- Create an order for your records.
- Listen to events when an order is approved, updated, or canceled.
- Listen to events when an order's transactions are updated. This event is part of the Order Transactions API.
Before you begin
If you are migrating from the Stores Orders API, please refer to the following conversion tables:
- Stores to eCommerce Order Object Conversion Table.
- Stores to eCommerce Webhook Conversion Table.
Was this helpful?
Yes
No