ShippingOptionsResource
This class is used to send requests to Store Shipping Option API Routes. All its method
are available in the JS Client under the medusa.shippingOptions
property.
A shipping option is used to define the available shipping methods during checkout or when creating a return.
Related Guide: Shipping Option architecture.
Methods
listCartOptions
Retrieve a list of shipping options available for a cart.
Example
Parameters
cart_id
stringRequiredThe cart's ID.
customHeaders
Record<string, any>RequiredCustom headers to attach to the request.
Default: {}
Returns
ResponsePromise
ResponsePromise<StoreShippingOptionsListRes>RequiredResolves to the list of shipping options.
ResponsePromise
ResponsePromise<StoreShippingOptionsListRes>Requiredlist
Retrieve a list of shipping options. The shipping options can be filtered using the query
parameter.
Example
Parameters
customHeaders
Record<string, any>RequiredCustom headers to attach to the request.
Default: {}
The filters to apply on the shipping options.
Returns
ResponsePromise
ResponsePromise<StoreShippingOptionsListRes>RequiredResolves to the list of shipping options.
ResponsePromise
ResponsePromise<StoreShippingOptionsListRes>RequiredWas this section helpful?