Home > @shopware-pwa/composables > IUseCheckout
# IUseCheckout interface
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
interface for useCheckout composable
Signature:
export interface IUseCheckout
# Properties
Property | Type | Description |
---|---|---|
billingAddress | Readonly<Ref<Partial<BillingAddress> | undefined>> | (BETA) |
createOrder | () => Promise<Order> | (BETA) |
getPaymentMethods | (options?: { forceReload: boolean; }) => Promise<Readonly<Ref<readonly PaymentMethod[]>>> | (BETA) |
getShippingMethods | (options?: { forceReload: boolean; }) => Promise<Readonly<Ref<readonly ShippingMethod[]>>> | (BETA) |
guestOrderParams | Ref<Readonly<Partial<GuestOrderParams>>> | (BETA) |
isGuestOrder | Readonly<Ref<boolean>> | (BETA) Flag isGuestOrder is true when user is not logged in |
onOrderPlace | (fn: (params: { order: Order; }) => void) => void | (BETA) |
paymentMethods | Readonly<Ref<readonly PaymentMethod[]>> | (BETA) |
shippingAddress | Readonly<Ref<ShippingAddress | undefined>> | (BETA) |
shippingMethods | Readonly<Ref<readonly ShippingMethod[]>> | (BETA) |
updateGuestOrderParams | (params: Partial<GuestOrderParams>) => void | (BETA) |