Patch
Update Checkout
Updates a checkout.
Use this endpoint 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 endpoints:
- Add to Checkout: Add line items to the checkout.
- Update Line Items Quantity: Update the quantity of one or more line items in the checkout.
- Remove Line Items: Remove a line item from the checkout.
- Mark Checkout As Completed: To update
completed
totrue
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.
Permission Scopes
For app development, you must have one of the following permission scopes:Manage Stores - all permissions
Manage eCommerce - all permissions
Manage Orders
Learn more about permission scopes.
Endpoint
PATCH
https://www.wixapis.com/ecom/v1/checkouts/{checkout.id}Was this helpful?
Yes
No