Create and manage an eCommerce checkout

Creates a checkout.

Note: For more information on what to pass to lineItems.catalogReference, see eCommerce Integration in the Wix Stores Catalog API.

Retrieves a checkout.

Retrieves the checkout page URL of a specified checkout.

By default, a checkoutUrl generates for a checkout and directs to a standard Wix checkout page. However, if overrideCheckoutUrl has a value, it will replace and set the value of checkoutUrl.

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 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.

Removes the coupon from a specified checkout.

Removes the gift card from a specified checkout.

Removes the overrideCheckoutUrl from a specified checkout.

When overrideCheckoutUrl is removed, the checkoutUrl will be set to the default, standard Wix checkout page URL.

Adds line items to a checkout.

Note: For more information on what to pass to lineItems.catalogReference, see eCommerce Integration in the Wix Stores Catalog API.

Removes specified line items from a checkout.

Sets completed to true to mark a checkout as completed.

When an order is completed through Wix, the completed field in the associated checkout object will automatically be updated to true. If an order is completed through a separate system, use this endpoint to manually mark the checkout as completed.

Updates the quantity of one or more line items in a checkout.

This endpoint is only for updating the quantity of line items. To entirely remove a line item from the checkout, use Remove Line Items. To add a new line item to the checkout, use Add to Checkout.

This endpoint checks the amount of stock remaining for this line item. If the specified quantity is greater than the remaining stock, then the quantity returned in the response is the total amount of remaining stock.

Triggered when a checkout is created.

Triggered when a checkout is updated.

Triggered when an order created from this checkout is successfully paid for or when a checkout is marked as completed.