createDraftOrder( )

Creates or retrieves a draft order based on the specified order ID.

When passing the ID of an order that is already in draft, the existing draft order is returned. To complete a draft and update the original order, call Commit Draft Order.

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 eCommerce - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsCreateDraftOrderOptions
Returns
Return Type:Promise<CreateDraftOrderResponse>
Errors
400Invalid Argument

There are 8 errors with this status code.

404Not Found

There is 1 error with this status code.

409Already Exists

There is 1 error with this status code.

428Failed Precondition

There is 1 error with this status code.

500Internal

There is 1 error with this status code.

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

Did this help?