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 function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
orderOrderRequired

Order info.

optionsCreateOrderOptions
Returns
Return Type:Promise<Order>
Was this helpful?
Yes
No