medusa-store/docs/content/references/js-client/classes/AdminShippingProfilesResource.md

Class: AdminShippingProfilesResource

Hierarchy

• default

  ↳ AdminShippingProfilesResource

Methods

create

▸ create(payload, customHeaders?): ResponsePromise<AdminShippingProfilesRes>

Parameters

Name	Type
payload	AdminPostShippingProfilesReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminShippingProfilesRes>

Defined in

medusa-js/src/resources/admin/shipping-profiles.ts:12

---

delete

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

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<DeleteResponse>

Defined in

medusa-js/src/resources/admin/shipping-profiles.ts:29

---

list

▸ list(customHeaders?): ResponsePromise<AdminShippingProfilesListRes>

Parameters

Name	Type
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminShippingProfilesListRes>

Defined in

medusa-js/src/resources/admin/shipping-profiles.ts:45

---

retrieve

▸ retrieve(id, customHeaders?): ResponsePromise<AdminShippingProfilesRes>

Parameters

Name	Type
id	string
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminShippingProfilesRes>

Defined in

medusa-js/src/resources/admin/shipping-profiles.ts:37

---

update

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

Parameters

Name	Type
id	string
payload	AdminPostShippingProfilesProfileReq
customHeaders	Record<string, any>

Returns

ResponsePromise<AdminShippingProfilesRes>

Defined in

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