Skip to main content

Class: AdminStoresResource

Hierarchy

  • default

    AdminStoresResource

Methods

addCurrency

addCurrency(currency_code, customHeaders?): ResponsePromise<AdminStoresRes>

Description

adds a currency to the store.

Parameters

NameTypeDescription
currency_codestringcode of the currency to add
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminStoresRes>

updated store.

Defined in

medusa-js/src/resources/admin/store.ts:31


deleteCurrency

deleteCurrency(currency_code, customHeaders?): ResponsePromise<AdminStoresRes>

Description

deletes a currency from the available store currencies

Parameters

NameTypeDescription
currency_codestringcurrency code of the currency to delete from the store.
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminStoresRes>

updated store

Defined in

medusa-js/src/resources/admin/store.ts:45


listPaymentProviders

listPaymentProviders(customHeaders?): ResponsePromise<AdminPaymentProvidersList>

Description

Lists the store's payment providers

Parameters

NameType
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminPaymentProvidersList>

a list of payment providers configured on the store

Defined in

medusa-js/src/resources/admin/store.ts:68


listTaxProviders

listTaxProviders(customHeaders?): ResponsePromise<AdminTaxProvidersList>

Description

Lists the store's payment providers

Parameters

NameType
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminTaxProvidersList>

a list of payment providers configured on the store

Defined in

medusa-js/src/resources/admin/store.ts:79


retrieve

retrieve(customHeaders?): ResponsePromise<AdminStoresRes>

Description

gets a medusa store

Parameters

NameType
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminStoresRes>

a medusa store

Defined in

medusa-js/src/resources/admin/store.ts:57


update

update(payload, customHeaders?): ResponsePromise<AdminStoresRes>

Description

Updates the store

Parameters

NameTypeDescription
payloadAdminPostStoreRequpdate to apply to the store.
customHeadersRecord<string, any>

Returns

ResponsePromise<AdminStoresRes>

the updated store.

Defined in

medusa-js/src/resources/admin/store.ts:17