Skip to main content

Class: AdminShippingOptionsResource

Hierarchy

  • Copy to Clipboard

    Copy to Clipboard

Methods

create

create(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

creates a shipping option.

Parameters

NameType
Copy to ClipboardCopy to Clipboard
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

created shipping option.

Defined in

medusa-js/src/resources/admin/shipping-options.ts:20


delete

delete(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

deletes a shipping option

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of shipping option to delete.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

deleted response

Defined in

medusa-js/src/resources/admin/shipping-options.ts:50


list

list(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

lists shipping options matching a query

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardquery for searching shipping options
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

a list of shipping options matching the query.

Defined in

medusa-js/src/resources/admin/shipping-options.ts:78


retrieve

retrieve(Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

get a shipping option

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the shipping option to retrieve.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the shipping option with the given id

Defined in

medusa-js/src/resources/admin/shipping-options.ts:64


update

update(Copy to Clipboard, Copy to Clipboard, Copy to Clipboard): Copy to Clipboard<Copy to Clipboard>

Copy to Clipboard

updates a shipping option

Parameters

NameTypeDescription
Copy to ClipboardCopy to Clipboardid of the shipping option to update.
Copy to ClipboardCopy to Clipboardupdate to apply to shipping option.
Copy to ClipboardCopy to Clipboard<Copy to Clipboard, Copy to Clipboard>

Returns

Copy to Clipboard<Copy to Clipboard>

the updated shipping option.

Defined in

medusa-js/src/resources/admin/shipping-options.ts:35