About the Orders API

The 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 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.

Order creation and the Create Order endpoint

Orders are typically created automatically when a buyer completes checkout on a Wix site. However, you can use the Create Order endpoint to:

• Record orders from external systems, such as POS terminals, marketplaces, or legacy platforms.
• Create manual orders for phone or email sales.

When creating an order via the API, set the channelInfo.type to match the original source of the order. If no matching type exists, use OTHER_PLATFORM.

Editing orders with Draft Orders

The Update Order endpoint only supports updating specific fields such as contact info, addresses, and metadata. To modify pricing or line items on an existing order, use the Draft Orders API.

Use cases

• Use an order ID across different eCommerce APIs
• Search for orders by customer
• Track fulfillment status

Terminology

For definitions of key terms used in this API, see Terminology.

See also

• Order Transactions API
• Order Fulfillments API
• Draft Orders API