Checkout Object

Create and manage an eCommerce checkout

Properties
idstringRead-onlyformat GUID

Checkout ID.

lineItemsArray <LineItem>Read-onlyminItems 1maxItems 300

Line items.

Max: 300 items

billingInfoobject

Billing information.

shippingInfoobject

Shipping information.

buyerNotestringmaxLength 1000

Buyer note left by the customer.

buyerInfoobject

Buyer information.

conversionCurrencystringRead-onlyformat CURRENCY

All converted prices are displayed in this currency in three-letter ISO-4217 alphabetic format.

priceSummaryobjectRead-only

Calculated price summary for the checkout.

calculationErrorsobjectRead-only

Errors when calculating totals.

giftCardobjectRead-only

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.

appliedDiscountsArray <AppliedDiscount>Read-only

Applied discounts.

customFieldsArray <CustomField>

Custom fields.

weightUnitstringRead-only
3 enum supported values:
UNSPECIFIED_WEIGHT_UNITKGLB

Weight measurement unit - defaults to site's weight unit.

taxSummaryobjectRead-only

Tax summary.

currencystringRead-onlyformat CURRENCY

The currency used when submitting the order.

channelTypestringRead-only
16 enum supported values:
UNSPECIFIEDWEBPOSEBAYAMAZONOTHER_PLATFORMWIX_APP_STOREWIX_INVOICESBACKOFFICE_MERCHANTWISHCLASS_PASSGLOBAL_EFACEBOOKETSYTIKTOKFAIRE_COM

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

Site language in which original values are shown.

buyerLanguagestringRead-only

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.

completedbooleanRead-only

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

taxIncludedInPricebooleanRead-only

Whether tax is included in line item prices.

createdByobjectRead-only

ID of the checkout's initiator.

createdDatestringRead-onlyformat date-time

Date and time the checkout was created.

updatedDatestringRead-onlyformat date-time

Date and time the checkout was updated.

payNowobjectRead-only

Minimal amount to pay in order to place the order.

payLaterobjectRead-only

Remaining amount for the order to be fully paid.

membershipOptionsobject

Memberships to apply when creating the order.

additionalFeesArray <AdditionalFee>maxItems 100

Additional Fees.

cartIdstringformat GUID

Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.

violationsArray <Violation>Read-only

List of validation violations raised by the Validations service plugin.

extendedFieldsobject

Custom field data for the checkout object.

Extended fields must be configured in the Wix Dev Center before they can be accessed with API calls.

purchaseFlowIdstringRead-onlyformat GUID

Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.

customSettingsobject

Additional settings for customization of the checkout process.

Custom settings can only be set when creating a checkout.

Was this helpful?
Yes
No