AdminStoresResource

admin/store.AdminStoresResource

Methods

addCurrency

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

Parameters

currency_codestringRequired

code of the currency to add

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminStoresRes>

ResponsePromiseResponsePromise<AdminStoresRes>Required

updated store.

Description

adds a currency to the store.

---

deleteCurrency

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

Parameters

currency_codestringRequired

currency code of the currency to delete from the store.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminStoresRes>

ResponsePromiseResponsePromise<AdminStoresRes>Required

updated store

Description

deletes a currency from the available store currencies

---

listPaymentProviders

listPaymentProviders(customHeaders?): ResponsePromise<AdminPaymentProvidersList>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminPaymentProvidersList>

ResponsePromiseResponsePromise<AdminPaymentProvidersList>Required

a list of payment providers configured on the store

Description

Lists the store's payment providers

---

listTaxProviders

listTaxProviders(customHeaders?): ResponsePromise<AdminTaxProvidersList>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminTaxProvidersList>

ResponsePromiseResponsePromise<AdminTaxProvidersList>Required

a list of payment providers configured on the store

Description

Lists the store's payment providers

---

retrieve

retrieve(customHeaders?): ResponsePromise<AdminExtendedStoresRes>

Parameters

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminExtendedStoresRes>

ResponsePromiseResponsePromise<AdminExtendedStoresRes>Required

a medusa store

Description

gets a medusa store

---

update

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

Parameters

payloadAdminPostStoreReqRequired

update to apply to the store.

customHeadersRecord<string, any>Required

Default: `{}`

Returns

ResponsePromise<AdminStoresRes>

ResponsePromiseResponsePromise<AdminStoresRes>Required

the updated store.

Description

Updates the store