commitDraftOrder( )

Finalizes a draft order and applies its modifications to the associated order. You can also control which side-effects are executed on commit.

Notes:

  • The draft order's status is set to COMMITTED.
  • Commiting a draft order cannot be undone or reverted.
  • A committed draft order does not allow for further modifications. However, it is kept for reference and can be retrieved.
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
draftOrderIdstringRequired

Draft order ID.

optionsCommitDraftOrderOptions
Returns
Return Type:Promise<CommitDraftOrderResponse>
Errors
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.

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

Did this help?