updateCheckout( )


Updates a checkout.

The updateCheckout() function returns a Promise that resolves to the updated checkout when the specified properties are updated.

Notes:

  • If nothing is passed in the request, the call will fail.
  • The checkout.buyerInfo.email may not be removed once it is set.
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
_idstringRequired

Checkout ID.


checkoutUpdateCheckoutRequired

optionsUpdateCheckoutOptions

Checkout update options.

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

There are 4 errors with this status code.

428Failed Precondition

There are 8 errors with this status code.

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

Did this help?