Class: AdminShippingOptionsResource
Hierarchy
default↳
AdminShippingOptionsResource
Methods
create
▸ create(payload, customHeaders?): ResponsePromise<AdminShippingOptionsRes>
Description
creates a shipping option.
Parameters
| Name | Type |
|---|---|
payload | AdminPostShippingOptionsReq |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsRes>
created shipping option.
Defined in
medusa-js/src/resources/admin/shipping-options.ts:20
delete
▸ delete(id, customHeaders?): ResponsePromise<DeleteResponse>
Description
deletes a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of shipping option to delete. |
customHeaders | Record<string, any> |
Returns
ResponsePromise<DeleteResponse>
deleted response
Defined in
medusa-js/src/resources/admin/shipping-options.ts:50
list
▸ list(query?, customHeaders?): ResponsePromise<AdminShippingOptionsListRes>
Description
lists shipping options matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query? | AdminGetShippingOptionsParams | query for searching shipping options |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsListRes>
a list of shipping options matching the query.
Defined in
medusa-js/src/resources/admin/shipping-options.ts:78
retrieve
▸ retrieve(id, customHeaders?): ResponsePromise<AdminShippingOptionsRes>
Description
get a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of the shipping option to retrieve. |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsRes>
the shipping option with the given id
Defined in
medusa-js/src/resources/admin/shipping-options.ts:64
update
▸ update(id, payload, customHeaders?): ResponsePromise<AdminShippingOptionsRes>
Description
updates a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
id | string | id of the shipping option to update. |
payload | AdminPostShippingOptionsOptionReq | update to apply to shipping option. |
customHeaders | Record<string, any> |
Returns
ResponsePromise<AdminShippingOptionsRes>
the updated shipping option.