Create and manage an eCommerce checkout
Additional Fees.
Applied discounts.
Billing information.
The business location ID associated with the checkout.
To learn more, see the Locations API.
Buyer information.
Language for communication with the buyer. Defaults to the site language.
For a site that supports multiple languages, this is the language the buyer selected.
Buyer note left by the customer.
Errors when calculating totals.
Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
Sales channel that submitted the order.
Whether an order was successfully created from this checkout.
For an order to be successful, it must be successfully paid for (unless the total is 0).
The currency selected by the customer during the purchase flow, in three-letter ISO-4217 alphabetic format.
This reflects the customer’s preferred display currency and may differ from the site’s default currency.
When no specific currency is selected by the customer, this matches the currency property.
ID of the checkout's initiator.
Date and time the checkout was created.
The site’s default currency, in three-letter ISO-4217 alphabetic format. This represents the base currency configured for the site and remains constant regardless of the customer’s currency selection.
Reference IDs for the app and component providing custom checkout page content.
To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about permission scopes.
Custom fields.
Additional settings for customization of the checkout process.
Notes:
Custom field data for the checkout object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
References to an external app and resource associated with this checkout. Used for integration and tracking across different platforms.
Applied gift card details.
Note: Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about Wix Gift Cards.
Checkout ID.
Line items.
Max: 300 items
Memberships to apply when creating the order.
Payment for subscriptions after free trial period.
Remaining amount for the order to be fully paid.
The currency used for payment, in three-letter ISO-4217 alphabetic format.
This is determined by the customer's selected currency and the site’s supported payment currencies.
If the customer’s selected currency is supported for payment, this matches the conversionCurrency property. If not supported, this falls back to the currency property.
Minimal amount to pay in order to place the order.
Calculated price summary for the checkout.
Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
Shipping information.
Site language in which original values are shown.
Tax exempt group ID to use for tax exemptions.
Whether tax is included in line item prices.
Tax summary.
Date and time the checkout was updated.
List of validation violations raised by the Validations service plugin.
Weight measurement unit. Defaults to a site's weight unit.