Cart Object


Create and manage an eCommerce cart

Properties
idstringformat GUID

Cart ID.


lineItemsArray <LineItem>Read-onlyminItems 1maxItems 300

Line items.


buyerNotestringmaxLength 1000

Note left by the buyer/customer.


buyerInfoobject

Buyer information.


currencystringRead-onlyformat CURRENCY

Currency used for pricing.


conversionCurrencystringRead-onlyformat CURRENCY

Currency code used for all the converted prices that are returned. For a site that supports multiple currencies, this is the currency the buyer selected.


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
3 enum supported values:
UNSPECIFIED_WEIGHT_UNITKGLB

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.


contactInfoobject

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.


selectedShippingOptionobject

Selected shipping option.

Was this helpful?
Yes
No