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

Home > @vue-storefront/core > UseUserShippingFactoryParams

UseUserShippingFactoryParams interface

Signature:

export interface UseUserShippingFactoryParams<USER_SHIPPING, USER_SHIPPING_ITEM, API extends PlatformApi = any> extends FactoryParams<API> 

Extends: FactoryParams

Properties

Property Modifiers Type Description
addAddress (context: Context, params: { address: Readonly<USER_SHIPPING_ITEM>; shipping: Readonly<USER_SHIPPING>; customQuery?: CustomQuery; }) => Promise<USER_SHIPPING>
deleteAddress (context: Context, params: { address: Readonly<USER_SHIPPING_ITEM>; shipping: Readonly<USER_SHIPPING>; customQuery?: CustomQuery; }) => Promise<USER_SHIPPING>
load (context: Context, params: { shipping: Readonly<USER_SHIPPING>; }) => Promise<USER_SHIPPING>
setDefaultAddress (context: Context, params: { address: Readonly<USER_SHIPPING_ITEM>; shipping: Readonly<USER_SHIPPING>; customQuery?: CustomQuery; }) => Promise<USER_SHIPPING>
updateAddress (context: Context, params: { address: Readonly<USER_SHIPPING_ITEM>; shipping: Readonly<USER_SHIPPING>; customQuery?: CustomQuery; }) => Promise<USER_SHIPPING>