Create and manage an eCommerce checkout
Checkout ID.
Line items.
Max: 300 items
Billing information.
Shipping information.
Buyer note left by the customer.
Buyer information.
All converted prices are displayed in this currency in three-letter ISO-4217 alphabetic format.
Calculated price summary for the checkout.
Errors when calculating totals.
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.
Applied discounts.
Custom fields.
Weight measurement unit - defaults to site's weight unit.
Tax summary.
The currency used when submitting the order.
Sales channel that submitted the order.
"UNSPECIFIED": Unspecified sales channel. This value is not supported."WEB": A web client."POS": Point of sale solutions"EBAY": eBay"AMAZON": Amazon"WISH": Wish"WIX_INVOICES": Wix Invoices app in your dashboard"WIX_APP_STORE": Wix Owner app"BACKOFFICE_MERCHANT": Wix merchant backoffice"OTHER_PLATFORM": Other sales platform.Site language in which original values are shown.
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.
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).
Whether tax is included in line item prices.
ID of the checkout's initiator.
Date and time the checkout was created.
Date and time the checkout was updated.
Minimal amount to pay in order to place the order.
Remaining amount for the order to be fully paid.
Memberships to apply when creating the order.
Additional Fees.
Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
List of validation violations raised by the Validations service plugin.
Custom field data for the checkout object.
Extended fields must be configured in the app dashboard before they can be accessed with API calls.
Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
Additional settings for customization of the checkout process.
Notes:
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.