Files
medusa-store/www/apps/docs/content/references/js-client/classes/AdminShippingProfilesResource.md
github-actions[bot] daea35fe73 chore(docs): Generated JS Client Reference (#5334)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-10-10 17:47:07 +00:00

3.9 KiB

displayed_sidebar
displayed_sidebar
jsClientSidebar

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:29


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:45


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:37


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:20