3b28f46705
* added reference for JS Client * added reference for JS Client * added reference for JS Client
4.7 KiB
Class: AdminStoresResource
Hierarchy
-
default↳
AdminStoresResource
Methods
addCurrency
▸ addCurrency(currency_code, customHeaders?): ResponsePromise<AdminStoresRes>
description adds a currency to the store.
Parameters
| Name | Type | Description |
|---|---|---|
currency_code |
string |
code of the currency to add |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStoresRes>
updated store.
Defined in
packages/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
| Name | Type | Description |
|---|---|---|
currency_code |
string |
currency code of the currency to delete from the store. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStoresRes>
updated store
Defined in
packages/medusa-js/src/resources/admin/store.ts:45
listPaymentProviders
▸ listPaymentProviders(customHeaders?): ResponsePromise<AdminPaymentProvidersList>
description Lists the store's payment providers
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminPaymentProvidersList>
a list of payment providers configured on the store
Defined in
packages/medusa-js/src/resources/admin/store.ts:68
listTaxProviders
▸ listTaxProviders(customHeaders?): ResponsePromise<AdminTaxProvidersList>
description Lists the store's payment providers
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminTaxProvidersList>
a list of payment providers configured on the store
Defined in
packages/medusa-js/src/resources/admin/store.ts:79
retrieve
▸ retrieve(customHeaders?): ResponsePromise<AdminStoresRes>
description gets a medusa store
Parameters
| Name | Type |
|---|---|
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStoresRes>
a medusa store
Defined in
packages/medusa-js/src/resources/admin/store.ts:57
update
▸ update(payload, customHeaders?): ResponsePromise<AdminStoresRes>
description Updates the store
Parameters
| Name | Type | Description |
|---|---|---|
payload |
AdminPostStoreReq |
update to apply to the store. |
customHeaders |
Record<string, any> |
Returns
ResponsePromise<AdminStoresRes>
the updated store.