Class: AdminShippingOptionsResource
Hierarchy
defaultCopy to Clipboard↳
AdminShippingOptionsResourceCopy to Clipboard
Methods
create
▸ create(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminShippingOptionsResCopy to Clipboard>
DescriptionCopy to Clipboard
creates a shipping option.
Parameters
| Name | Type |
|---|---|
payloadCopy to Clipboard | AdminPostShippingOptionsReqCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminShippingOptionsResCopy to Clipboard>
created shipping option.
Defined in
medusa-js/src/resources/admin/shipping-options.ts:20
delete
▸ delete(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
DescriptionCopy to Clipboard
deletes a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of shipping option to delete. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<DeleteResponseCopy to Clipboard>
deleted response
Defined in
medusa-js/src/resources/admin/shipping-options.ts:50
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminShippingOptionsListResCopy to Clipboard>
DescriptionCopy to Clipboard
lists shipping options matching a query
Parameters
| Name | Type | Description |
|---|---|---|
query?Copy to Clipboard | AdminGetShippingOptionsParamsCopy to Clipboard | query for searching shipping options |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminShippingOptionsListResCopy to Clipboard>
a list of shipping options matching the query.
Defined in
medusa-js/src/resources/admin/shipping-options.ts:78
retrieve
▸ retrieve(idCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminShippingOptionsResCopy to Clipboard>
DescriptionCopy to Clipboard
get a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the shipping option to retrieve. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminShippingOptionsResCopy to Clipboard>
the shipping option with the given id
Defined in
medusa-js/src/resources/admin/shipping-options.ts:64
update
▸ update(idCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminShippingOptionsResCopy to Clipboard>
DescriptionCopy to Clipboard
updates a shipping option
Parameters
| Name | Type | Description |
|---|---|---|
idCopy to Clipboard | stringCopy to Clipboard | id of the shipping option to update. |
payloadCopy to Clipboard | AdminPostShippingOptionsOptionReqCopy to Clipboard | update to apply to shipping option. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminShippingOptionsResCopy to Clipboard>
the updated shipping option.