Skip to main content

Class: AdminShippingOptionsResource

Hierarchy

  • default

    AdminShippingOptionsResource

Methods

create

create(payload, customHeaders?): ResponsePromise<AdminShippingOptionsRes>

Description

creates a shipping option.

Parameters

NameType
payloadAdminPostShippingOptionsReq
customHeadersRecord<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

NameTypeDescription
idstringid of shipping option to delete.
customHeadersRecord<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

NameTypeDescription
query?AdminGetShippingOptionsParamsquery for searching shipping options
customHeadersRecord<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

NameTypeDescription
idstringid of the shipping option to retrieve.
customHeadersRecord<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

NameTypeDescription
idstringid of the shipping option to update.
payloadAdminPostShippingOptionsOptionRequpdate to apply to shipping option.
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminShippingOptionsRes>

the updated shipping option.

Defined in

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