Interface: UseCartReturn
Defined in: composables/react/useCart.ts:70
Cart state and actions returned by useCart.
Properties
addActionCode
addActionCode: (
code) =>Promise<Cart|undefined>
Defined in: composables/react/useCart.ts:94
Applies a promotional action code to the cart.
Parameters
code
string
Returns
Promise<Cart | undefined>
addItem
addItem: (
options) =>Promise<Result<{cart:Cart;item:CartMainItem|null; },string>>
Defined in: composables/react/useCart.ts:84
Adds a product (optionally a cluster/bundle) to the cart.
Parameters
options
Returns
Promise<Result<{ cart: Cart; item: CartMainItem | null; }, string>>
cart
cart:
Cart|null
Defined in: composables/react/useCart.ts:72
The resolved cart, or null before resolveCart runs.
cartId
cartId:
string
Defined in: composables/react/useCart.ts:74
Id of the resolved cart, or ''.
checkoutAllowed
checkoutAllowed:
boolean
Defined in: composables/react/useCart.ts:80
false when a B2B purchaser's authorization limit is exceeded by the cart total.
deleteItem
deleteItem: (
cartItemId) =>Promise<Cart|undefined>
Defined in: composables/react/useCart.ts:92
Removes a line item from the cart.
Parameters
cartItemId
string
Returns
Promise<Cart | undefined>
error
error:
string|null
Defined in: composables/react/useCart.ts:78
Last error message, or null.
getCrossupsells
getCrossupsells: (
options) =>Promise<Crossupsell[]>
Defined in: composables/react/useCart.ts:102
Fetches crossupsell / accessory products for a product or cluster.
Parameters
options
Returns
Promise<Crossupsell[]>
getMinQuantity
getMinQuantity: (
product) =>number
Defined in: composables/react/useCart.ts:104
Returns the minimum orderable quantity for a product (>= 1).
Parameters
product
Product | null | undefined
Returns
number
getStep
getStep: (
product) =>number
Defined in: composables/react/useCart.ts:106
Returns the quantity step / unit increment for a product (>= 1).
Parameters
product
Product | null | undefined
Returns
number
loading
loading:
boolean
Defined in: composables/react/useCart.ts:76
true while a mutating cart call is in flight.
processCart
processCart: (
orderStatus?) =>Promise<Result<CartProcessResponse,string>>
Defined in: composables/react/useCart.ts:100
Converts the cart into an order (orderStatus defaults to 'COMPLETE').
Parameters
orderStatus?
string
Returns
Promise<Result<CartProcessResponse, string>>
removeActionCode
removeActionCode: (
code) =>Promise<Cart|undefined>
Defined in: composables/react/useCart.ts:96
Removes a previously-applied action code.
Parameters
code
string
Returns
Promise<Cart | undefined>
requestAuthorization
requestAuthorization: () =>
Promise<Result<void,string>>
Defined in: composables/react/useCart.ts:98
Submits the cart for purchase authorization (B2B).
Returns
Promise<Result<void, string>>
resolveCart
resolveCart: () =>
Promise<Cart>
Defined in: composables/react/useCart.ts:82
Resolves an existing cart or creates one via the shared initCart flow.
Returns
Promise<Cart>
updateItemNotes
updateItemNotes: (
cartItemId,notes,debounceMs?) =>void
Defined in: composables/react/useCart.ts:90
Debounced update of a line item's notes (debounceMs defaults to 500).
Parameters
cartItemId
string
notes
string
debounceMs?
number
Returns
void
updateItemQuantity
updateItemQuantity: (
cartItemId,quantity) =>Promise<Cart|undefined>
Defined in: composables/react/useCart.ts:88
Updates a line item's quantity.
Parameters
cartItemId
string
quantity
number
Returns
Promise<Cart | undefined>