Home > @vsf-enterprise/bigcommerce-theme > useCartStore
# useCartStore variable
Cart [Pinia](https://pinia.vuejs.org/) store.
Signature:
useCartStore: import("pinia").StoreDefinition<"cartStore", CartState, {
getItems: (state: {
cart: {
id?: string;
parent_id?: string;
customer_id?: number;
email?: string;
currency?: {
code?: string;
};
tax_included?: boolean;
base_amount?: number;
discount_amount?: number;
cart_amount?: number;
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discounts?: {
id?: number;
discounted_amount?: number;
}[];
line_items?: {
physical_items: {
is_require_shipping?: boolean;
gift_wrapping?: {
name?: string;
message?: string;
amount?: number;
};
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
}[];
digital_items: {
download_file_urls?: string[];
download_page_url?: string;
download_size?: string;
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
}[];
gift_certificates: {
id?: string;
name?: string;
theme: string;
amount: number;
is_taxable?: boolean;
sender: {
name?: string;
email?: string;
};
recipient: {
name?: string;
email?: string;
};
message?: string;
}[];
custom_items: {
extended_list_price: number;
id?: string;
sku?: string;
name?: string;
quantity?: string;
list_price?: string;
}[];
};
created_time?: string;
updated_time?: string;
channel_id?: number;
locale?: string;
redirect_urls?: {
cart_url: string;
checkout_url: string;
embedded_checkout_url: string;
};
};
} & {}) => ({
is_require_shipping?: boolean;
gift_wrapping?: {
name?: string;
message?: string;
amount?: number;
};
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
} | {
download_file_urls?: string[];
download_page_url?: string;
download_size?: string;
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
})[];
getTotals: (state: {
cart: {
id?: string;
parent_id?: string;
customer_id?: number;
email?: string;
currency?: {
code?: string;
};
tax_included?: boolean;
base_amount?: number;
discount_amount?: number;
cart_amount?: number;
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discounts?: {
id?: number;
discounted_amount?: number;
}[];
line_items?: {
physical_items: {
is_require_shipping?: boolean;
gift_wrapping?: {
name?: string;
message?: string;
amount?: number;
};
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
}[];
digital_items: {
download_file_urls?: string[];
download_page_url?: string;
download_size?: string;
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
}[];
gift_certificates: {
id?: string;
name?: string;
theme: string;
amount: number;
is_taxable?: boolean;
sender: {
name?: string;
email?: string;
};
recipient: {
name?: string;
email?: string;
};
message?: string;
}[];
custom_items: {
extended_list_price: number;
id?: string;
sku?: string;
name?: string;
quantity?: string;
list_price?: string;
}[];
};
created_time?: string;
updated_time?: string;
channel_id?: number;
locale?: string;
redirect_urls?: {
cart_url: string;
checkout_url: string;
embedded_checkout_url: string;
};
};
} & {}) => {
total: number;
subtotal: number;
special: number;
};
getTotalItems: (state: {
cart: {
id?: string;
parent_id?: string;
customer_id?: number;
email?: string;
currency?: {
code?: string;
};
tax_included?: boolean;
base_amount?: number;
discount_amount?: number;
cart_amount?: number;
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discounts?: {
id?: number;
discounted_amount?: number;
}[];
line_items?: {
physical_items: {
is_require_shipping?: boolean;
gift_wrapping?: {
name?: string;
message?: string;
amount?: number;
};
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
}[];
digital_items: {
download_file_urls?: string[];
download_page_url?: string;
download_size?: string;
id?: string;
variant_id: number;
product_id: number;
parent_id?: number;
sku?: string;
name?: string;
url?: string;
quantity: number;
taxable?: boolean;
image_url?: string;
discounts?: {
id?: number;
discounted_amount?: number;
}[];
coupons?: {
coupons?: {
coupon_code: {
id?: number;
code?: string;
name?: string;
discount_type?: number;
discount_amount?: number;
expires_date?: number;
total_discount?: number;
};
};
}[];
discount_amount?: number;
coupon_amount?: number;
list_price?: number;
sale_price?: number;
extended_list_price?: number;
extended_sale_price?: number;
options?: {
name?: string;
nameId?: number;
value?: string;
valueId?: number;
}[];
}[];
gift_certificates: {
id?: string;
name?: string;
theme: string;
amount: number;
is_taxable?: boolean;
sender: {
name?: string;
email?: string;
};
recipient: {
name?: string;
email?: string;
};
message?: string;
}[];
custom_items: {
extended_list_price: number;
id?: string;
sku?: string;
name?: string;
quantity?: string;
list_price?: string;
}[];
};
created_time?: string;
updated_time?: string;
channel_id?: number;
locale?: string;
redirect_urls?: {
cart_url: string;
checkout_url: string;
embedded_checkout_url: string;
};
};
} & {}) => number;
}, {}>