Cart Object


Create and manage an eCommerce cart

Properties
idstringRead-onlyformat GUID

Cart ID.


lineItemsArray <LineItem>Read-onlyminItems 1maxItems 300

Line items.


buyerNotestringmaxLength 1000

Buyer note left by the customer.


buyerInfoBuyerInfo

Buyer information.


currencystringRead-onlyformat CURRENCY

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.


conversionCurrencystringRead-onlyformat CURRENCY

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.


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.


siteLanguagestringRead-only

Site language in which original values are displayed.


taxIncludedInPricesbooleanRead-only

Whether tax is included in line item prices.


weightUnitstringRead-only

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


checkoutIdstringRead-onlyformat GUID

ID of the checkout that originated from this cart.


appliedDiscountsArray <CartDiscount>Read-only

Cart discounts.


createdDatestringRead-onlyformat date-time

Date and time the cart was created.


updatedDatestringRead-onlyformat date-time

Date and time the cart was updated.


contactInfoContactInfo

Contact info.


overrideCheckoutUrlstringmaxLength 1000

overrideCheckoutUrl allows the flexibility to redirect customers to a customized checkout page.

This field overrides the checkoutUrl in a cart or checkout. checkoutUrl is used in the Abandoned Checkout API to send customers back to their checkouts. By default, a checkoutUrl generates for a checkout and directs to a standard Wix checkout page. When overrideCheckoutUrl has a value, it will replace and set the value of checkoutUrl.


purchaseFlowIdstringRead-onlyformat GUID

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


selectedShippingOptionSelectedShippingOption

Selected shipping option.


extendedFieldsExtendedFieldsbeta

Fields extended by data extensions


businessLocationIdstringbetaformat GUID

The business location ID associated with the cart.

To learn more, see the Locations API.


paymentCurrencystringRead-onlybetaformat CURRENCY

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.


revisionstringRead-onlyformat int64

Revision number, which increments by 1 each time the Cart is updated.

Did this help?