You are reading the documentation for Vue Storefront v2. See the latest docs.

Home > @vue-storefront/core > UseUserShipping

UseUserShipping interface

Signature:

export interface UseUserShipping<USER_SHIPPING, USER_SHIPPING_ITEM, API extends PlatformApi = any> extends Composable<API> 

Extends: Composable

Properties

Property Modifiers Type Description
addAddress (params: { address: USER_SHIPPING_ITEM; customQuery?: CustomQuery; }) => Promise<void>
deleteAddress (params: { address: USER_SHIPPING_ITEM; customQuery?: CustomQuery; }) => Promise<void>
error ComputedProperty<UseUserShippingErrors>
load () => Promise<void>
loading ComputedProperty<boolean>
setDefaultAddress (params: { address: USER_SHIPPING_ITEM; customQuery?: CustomQuery; }) => Promise<void>
shipping ComputedProperty<USER_SHIPPING>
updateAddress (params: { address: USER_SHIPPING_ITEM; customQuery?: CustomQuery; }) => Promise<void>