AdminShippingOptionsResource

admin/shipping-options.AdminShippingOptionsResource

Methods

create

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

Parameters

payloadAdminPostShippingOptionsReqRequired

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminShippingOptionsRes>

ResponsePromiseResponsePromise<AdminShippingOptionsRes>Required

created shipping option.

Description

creates a shipping option.

---

delete

delete(id, customHeaders?): ResponsePromise<DeleteResponse>

Parameters

idstringRequired

id of shipping option to delete.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<DeleteResponse>

ResponsePromiseResponsePromise<DeleteResponse>Required

deleted response

Description

deletes a shipping option

---

list

list(query?, customHeaders?): ResponsePromise<AdminShippingOptionsListRes>

Parameters

queryAdminGetShippingOptionsParams

query for searching shipping options

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminShippingOptionsListRes>

ResponsePromiseResponsePromise<AdminShippingOptionsListRes>Required

a list of shipping options matching the query.

Description

lists shipping options matching a query

---

retrieve

retrieve(id, customHeaders?): ResponsePromise<AdminShippingOptionsRes>

Parameters

idstringRequired

id of the shipping option to retrieve.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminShippingOptionsRes>

ResponsePromiseResponsePromise<AdminShippingOptionsRes>Required

the shipping option with the given id

Description

get a shipping option

---

update

update(id, payload, customHeaders?): ResponsePromise<AdminShippingOptionsRes>

Parameters

idstringRequired

id of the shipping option to update.

payloadAdminPostShippingOptionsOptionReqRequired

update to apply to shipping option.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminShippingOptionsRes>

ResponsePromiseResponsePromise<AdminShippingOptionsRes>Required

the updated shipping option.

Description

updates a shipping option