updateCheckout( )

Updates a checkout.

Use this method to update checkout fields such as billing and shipping info, or to add a coupon code or gift card.

To update a checkout's lineItems, completed status, or to remove coupons and gift cards, see these methods:

  • Add to Checkout: Add line items to the checkout.
  • Update Line Items Quantity: Update the quantity of 1 or more line items in the checkout.
  • Remove Line Items: Remove a line item from the checkout.
  • Mark Checkout As Completed: To update completed to true if the checkout was completed through a non-Wix orders or payments system.
  • Remove Coupon: To remove an applied coupon from the checkout.
  • Remove Gift Card: To remove an applied gift card from the checkout.

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
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage eCommerce - all permissions
Manage Stores - all permissions
Manage Orders
Manage Restaurants - all permissions
Manage Stores
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?