createCheckout( )

Creates a checkout.

The createCheckout() function returns a Promise that resolves to the new checkout when it's created.

Notes:

  • Checkout must include at least 1 item in the options.lineItems array.
  • options.channelType is required.
  • If _id for options.lineItems is added, make sure that each _id is unique.
  • If options.checkoutInfo.customFields are added, then options.checkoutInfo.customFields.value is required.
Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Orders
Manage eCommerce - Admin Permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsCreateCheckoutOptions

Checkout creation options.

Returns
Return Type:Promise<Checkout>
Errors
404Not Found

There are 4 errors with this status code.

428Failed Precondition

There are 9 errors with this status code.

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

Did this help?