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.
Archive and unarchive orders by setting the archived field with Update Order. Archived orders are hidden from the main orders view in the dashboard.
Create an order for your records.
Listen to events when an order is approved, updated, or canceled.

Order creation and the Create Order method

Orders are typically created automatically when a buyer completes checkout on a Wix site. However, you can use the Create Order method 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 method 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.

Controlling who can edit an order

When creating an order with Create Order, use settings.editableByOwnerApps to control which apps are allowed to edit the order.

By default, any app with the required permissions can edit an order. To restrict editing to specific apps, set settings.editableByOwnerApps and specify the app IDs. Apps not listed as owners receive an ORDER_CANNOT_BE_EDITED error when attempting to edit.

This setting can't be changed after the order is created.

Use cases

Terminology