Files
medusa-store/docs/content/references/js-client/classes/ShippingOptionsResource.md
2022-11-10 10:35:17 +02:00

58 lines
1.6 KiB
Markdown

# Class: ShippingOptionsResource
## Hierarchy
- `default`
**`ShippingOptionsResource`**
## Methods
### list
**list**(`query?`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-46.md#storeshippingoptionslistres)\>
**`Description`**
Lists shiping options available
#### Parameters
| Name | Type |
| :------ | :------ |
| `query?` | [`StoreGetShippingOptionsParams`](internal-46.StoreGetShippingOptionsParams.md) |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-46.md#storeshippingoptionslistres)\>
#### Defined in
[medusa-js/src/resources/shipping-options.ts:27](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/shipping-options.ts#L27)
___
### listCartOptions
**listCartOptions**(`cart_id`, `customHeaders?`): [`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-46.md#storeshippingoptionslistres)\>
**`Description`**
Lists shiping options available for a cart
#### Parameters
| Name | Type |
| :------ | :------ |
| `cart_id` | `string` |
| `customHeaders` | `Record`<`string`, `any`\> |
#### Returns
[`ResponsePromise`](../modules/internal.md#responsepromise)<[`StoreShippingOptionsListRes`](../modules/internal-46.md#storeshippingoptionslistres)\>
#### Defined in
[medusa-js/src/resources/shipping-options.ts:16](https://github.com/medusajs/medusa/blob/a4dd26e13/packages/medusa-js/src/resources/shipping-options.ts#L16)