CartRepositoryInterface

Interface for cart repository implementations. Defines methods for interacting with the cart API.

Methods

addToCart()

addToCart(params): Promise<{ cart: { discount_codes: object[]; items: object[]; token: string; }; sections?: Record<string, string | null>; }>

Adds items to the cart.

Parameters

Parameter	Type	Description
params	{ items: object[]; sections?: string[]; }	Parameters for adding items
params.items	object[]	Array of items to add
params.sections?	string[]	Optional sections to return in response

Returns

Promise<{ cart: { discount_codes: object[]; items: object[]; token: string; }; sections?: Record<string, string | null>; }>

Promise with updated cart and optional sections

---

changeCartItem()

changeCartItem(params): Promise<{ cart: { discount_codes: object[]; items: object[]; token: string; }; sections?: Record<string, string | null>; }>

Updates the cart with discount codes, attributes, or other modifications.

Parameters

Parameter	Type	Description
params	{ lineKey?: string; quantity: number; sections?: string[]; variantID: number; }	Update parameters
params.lineKey?	string	Ajax cart line key, when the caller knows which line to change.
params.quantity	number	-
params.sections?	string[]	Sections to return in response
params.variantID	number	-

Returns

Promise<{ cart: { discount_codes: object[]; items: object[]; token: string; }; sections?: Record<string, string | null>; }>

Promise with updated cart data

---

getCart()

getCart(): Promise<{ cart: { discount_codes: object[]; items: object[]; token: string; }; }>

Retrieves the current cart.

Returns

Promise<{ cart: { discount_codes: object[]; items: object[]; token: string; }; }>

Promise with cart data

---

updateCart()

updateCart(params): Promise<{ discount_codes: object[]; items: object[]; sections: Record<string, string | null>; token: string; }>

Parameters

Parameter	Type
params	{ attributes?: Record<string, string>; discount?: string; sections: string[]; }
params.attributes?	Record<string, string>
params.discount?	string
params.sections	string[]

Returns

Promise<{ discount_codes: object[]; items: object[]; sections: Record<string, string | null>; token: string; }>