POST

Create Order

Creates an order.

Use this method to create manual orders for phone or email sales or to add orders from external systems (such as POS, marketplaces, or legacy platforms). For standard online purchases, orders are created automatically through the checkout flow.

To record payment information for the order, pass the order ID to Add Payments.

For apps that aren't yet published in the Wix App Market, Create Order is limited to 5 calls per hour per site.

Notes:

  • Inventory is automatically reduced when the order is placed (default) or when the order is paid. This can be configured per order creation in the settings.orderApprovalStrategy field in the body params. To configure this behavior for all orders, use the Orders Settings API.
  • A confirmation email is sent when the order is approved.
  • If an item is digital - lineItems[i].itemType.preset: DIGITAL - then lineItems[i].digitalFile must be provided.
  • If lineItems[i].id is passed, it must be either a valid GUID, or empty.
  • Each line item must include either taxDetails or taxInfo.
  • If currency, weightUnit, or buyerLanguage aren't passed, they default to the site's settings.
  • status and paymentStatus may be adjusted during creation. For example, an order with a total of 0 is automatically created with status: "APPROVED" and paymentStatus: "PAID".
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Orders
Learn more about app permissions.
Method Declaration
Copy
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Order Created
Did this help?