Interface: UseCheckoutReturn
Defined in: composables/react/useCheckout.ts:86
State and checkout actions returned by useCheckout.
Properties
error
error:
string|null
Defined in: composables/react/useCheckout.ts:90
Last error message, or null.
loading
loading:
boolean
Defined in: composables/react/useCheckout.ts:88
true while a checkout call is in flight.
placeOrder
placeOrder: (
options) =>Promise<Result<{orderId:number; },string>>
Defined in: composables/react/useCheckout.ts:98
Process cart to order/quote, set status, optionally trigger quote send. Returns orderId on success.
Parameters
options
Returns
Promise<Result<{ orderId: number; }, string>>
populateCartAddresses
populateCartAddresses: (
cart) =>Promise<Cart>
Defined in: composables/react/useCheckout.ts:92
Pre-populate cart addresses from user's default saved addresses. Returns updated cart.
Parameters
cart
Cart
Returns
Promise<Cart>
updateCartAddress
updateCartAddress: (
cartId,input) =>Promise<Cart>
Defined in: composables/react/useCheckout.ts:94
Update a single cart address (invoice or delivery). Returns updated cart.
Parameters
cartId
string
input
CartUpdateAddressInput
Returns
Promise<Cart>
updateCartShipping
updateCartShipping: (
cartId,input) =>Promise<Cart>
Defined in: composables/react/useCheckout.ts:96
Update cart shipping carrier + payment method. Returns updated cart.
Parameters
cartId
string
input
CartUpdateInput
Returns
Promise<Cart>
updateUserAccountAddress
updateUserAccountAddress: (
addressData,type) =>Promise<void>
Defined in: composables/react/useCheckout.ts:100
Sync a user's stored account address with data entered during checkout.
Parameters
addressData
Record<string, unknown>
type
CartAddressType
Returns
Promise<void>