Skip to main content

Interface: UseCartReturn

Defined in: composables/vue/useCart.ts:75

Properties​

addActionCode​

addActionCode: (code) => Promise<Cart | undefined>

Defined in: composables/vue/useCart.ts:96

Parameters​

code​

string

Returns​

Promise<Cart | undefined>

addItem​

addItem: (options) => Promise<Result<{ cart: Cart; item: CartMainItem | null; }, string>>

Defined in: composables/vue/useCart.ts:83

Parameters​

options​

AddItemOptions

Returns​

Promise<Result<{ cart: Cart; item: CartMainItem | null; }, string>>

addItems​

addItems: (items) => Promise<Result<{ cart: Cart; items: (CartMainItem | null)[]; }, string>>

Defined in: composables/vue/useCart.ts:90

Adds several products in one call, sequentially, threading the resolved cart id from each add into the next. Stops at the first failure.

Parameters​

items​

AddItemOptions[]

Returns​

Promise<Result<{ cart: Cart; items: (CartMainItem | null)[]; }, string>>

cart​

cart: Ref<Cart | null>

Defined in: composables/vue/useCart.ts:76

cartId​

cartId: Ref<string>

Defined in: composables/vue/useCart.ts:77

checkoutAllowed​

checkoutAllowed: ComputedRef<boolean>

Defined in: composables/vue/useCart.ts:80

deleteItem​

deleteItem: (cartItemId) => Promise<Cart | undefined>

Defined in: composables/vue/useCart.ts:95

Parameters​

cartItemId​

string

Returns​

Promise<Cart | undefined>

error​

error: Ref<string | null>

Defined in: composables/vue/useCart.ts:79

fetchActiveCart​

fetchActiveCart: () => Promise<Cart | null>

Defined in: composables/vue/useCart.ts:82

Returns​

Promise<Cart | null>

getCrossupsells​

getCrossupsells: (options) => Promise<Crossupsell[]>

Defined in: composables/vue/useCart.ts:100

Parameters​

options​

GetCrossupsellsOptions

Returns​

Promise<Crossupsell[]>

getMinQuantity​

getMinQuantity: (product) => number

Defined in: composables/vue/useCart.ts:101

Parameters​

product​

Product | null | undefined

Returns​

number

getStep​

getStep: (product) => number

Defined in: composables/vue/useCart.ts:102

Parameters​

product​

Product | null | undefined

Returns​

number

loading​

loading: Ref<boolean>

Defined in: composables/vue/useCart.ts:78

processCart​

processCart: (orderStatus?) => Promise<Result<CartProcessResponse, string>>

Defined in: composables/vue/useCart.ts:99

Parameters​

orderStatus?​

string

Returns​

Promise<Result<CartProcessResponse, string>>

removeActionCode​

removeActionCode: (code) => Promise<Cart | undefined>

Defined in: composables/vue/useCart.ts:97

Parameters​

code​

string

Returns​

Promise<Cart | undefined>

requestAuthorization​

requestAuthorization: () => Promise<Result<void, string>>

Defined in: composables/vue/useCart.ts:98

Returns​

Promise<Result<void, string>>

resolveCart​

resolveCart: () => Promise<Cart>

Defined in: composables/vue/useCart.ts:81

Returns​

Promise<Cart>

updateItemNotes​

updateItemNotes: (cartItemId, notes, debounceMs?) => void

Defined in: composables/vue/useCart.ts:94

Parameters​

cartItemId​

string

notes​

string

debounceMs?​

number

Returns​

void

updateItemQuantity​

updateItemQuantity: (cartItemId, quantity) => Promise<Cart | undefined>

Defined in: composables/vue/useCart.ts:93

Parameters​

cartItemId​

string

quantity​

number

Returns​

Promise<Cart | undefined>