Alokai

Cart

A cart contains a collection of items, prices, discounts, etc... It does not contain customer-related data.

interface Cart$1 {
	base_amount?: number;
	cart_amount?: number;
	channel_id?: number;
	coupons?: AppliedCoupon[];
	created_time?: string;
	currency?: CartCurrency;
	customer_id?: number;
	discount_amount?: number;
	discounts?: AppliedDiscount[];
	email?: string;
	id?: string;
	line_items?: LineItems;
	locale?: string;
	parent_id?: string;
	redirect_urls?: RedirectUrls;
	tax_included?: boolean;
	updated_time?: string;
}

Properties

NameRequiredTypeDescription
base_amountOptionalnumberSum of cart line-item amounts before cart-level discounts, coupons, or taxes.
cart_amountOptionalnumberSum of cart line-item amounts minus cart-level discounts and coupons. This amount includes taxes (where applicable).
channel_idOptionalnumberIf no channel is specified, defaults to 1.
couponsOptionalAppliedCoupon[]Coupon applied in cart.
created_timeOptionalstringTime when the cart was created.
currencyOptionalCartCurrencyThis will always be the same between cart and checkout.
customer_idOptionalnumberID of the customer to which the cart belongs.
discount_amountOptionalnumberDiscounted amount.
discountsOptionalAppliedDiscount[]Discounts applied in cart.
emailOptionalstringThe cart's email. This is the same email that is used in the billing address.
idOptionalstringCart ID.
line_itemsOptionalLineItemsCart line items.
localeOptionalstringLocale of the cart.
parent_idOptionalstringBundled items will have their parent's item Id.
redirect_urlsOptionalRedirectUrlsRedirect URLs for checkout.
tax_includedOptionalbooleanInformation if tax is included.
updated_timeOptionalstringTime when the cart was last updated.

Referenced Types

On this page