createOrder( )

Creates an order.

The createOrder() function returns a Promise that resolves when the order is created.

Notes:

  • 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.
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
Method Parameters
orderOrderRequired

Order info.

optionsCreateOrderOptions
Returns
Return Type:Promise<Order>
Errors
428Failed Precondition

There is 1 error with this status code.

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

Did this help?