Home > @vue-storefront/magento-api > setShippingAddressesOnCart

setShippingAddressesOnCart() function

Sets a shipping address on received cart.

Signature:

export default function setShippingAddressesOnCart(context: Context, input: SetShippingAddressesOnCartInput, customQuery?: CustomQuery, customHeaders?: CustomHeaders): Promise<FetchResult<SetShippingAddressesOnCartMutation>>;

Parameters

Parameter Type Description
context Context VSF context
input SetShippingAddressesOnCartInput params with cart ID and shipping address.
customQuery CustomQuery (Optional) (optional) - custom GraphQL query that extends the default one
customHeaders CustomHeaders (Optional) (optional) - custom headers that extends the default headers

Returns:

Promise<FetchResult<SetShippingAddressesOnCartMutation>>