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

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 Orders
Manage eCommerce - Admin Permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
checkoutUpdateCheckoutRequired

_idstringRequired

Checkout ID.


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?