Files
medusa-store/docs/content/references/js-client/classes/AdminShippingProfilesResource.md
Shahed Nasser 3b28f46705 docs: added reference for JS Client (#1629)
* added reference for JS Client

* added reference for JS Client

* added reference for JS Client
2022-07-08 18:21:46 +03:00

3.7 KiB

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

packages/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

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


list

list(customHeaders?): ResponsePromise<AdminShippingProfilesListRes>

Parameters

Name Type
customHeaders Record<string, any>

Returns

ResponsePromise<AdminShippingProfilesListRes>

Defined in

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


retrieve

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

Parameters

Name Type
id string
customHeaders Record<string, any>

Returns

ResponsePromise<AdminShippingProfilesRes>

Defined in

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


update

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

Parameters

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

Returns

ResponsePromise<AdminShippingProfilesRes>

Defined in

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