Class: AdminStoresResource
Hierarchy
defaultCopy to Clipboard↳
AdminStoresResourceCopy to Clipboard
Methods
addCurrency
▸ addCurrency(currency_codeCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
DescriptionCopy to Clipboard
adds a currency to the store.
Parameters
| Name | Type | Description |
|---|---|---|
currency_codeCopy to Clipboard | stringCopy to Clipboard | code of the currency to add |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
updated store.
Defined in
medusa-js/src/resources/admin/store.ts:31
deleteCurrency
▸ deleteCurrency(currency_codeCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
DescriptionCopy to Clipboard
deletes a currency from the available store currencies
Parameters
| Name | Type | Description |
|---|---|---|
currency_codeCopy to Clipboard | stringCopy to Clipboard | currency code of the currency to delete from the store. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
updated store
Defined in
medusa-js/src/resources/admin/store.ts:45
listPaymentProviders
▸ listPaymentProviders(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminPaymentProvidersListCopy to Clipboard>
DescriptionCopy to Clipboard
Lists the store's payment providers
Parameters
| Name | Type |
|---|---|
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminPaymentProvidersListCopy to Clipboard>
a list of payment providers configured on the store
Defined in
medusa-js/src/resources/admin/store.ts:68
listTaxProviders
▸ listTaxProviders(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminTaxProvidersListCopy to Clipboard>
DescriptionCopy to Clipboard
Lists the store's payment providers
Parameters
| Name | Type |
|---|---|
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminTaxProvidersListCopy to Clipboard>
a list of payment providers configured on the store
Defined in
medusa-js/src/resources/admin/store.ts:79
retrieve
▸ retrieve(customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
DescriptionCopy to Clipboard
gets a medusa store
Parameters
| Name | Type |
|---|---|
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
a medusa store
Defined in
medusa-js/src/resources/admin/store.ts:57
update
▸ update(payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
DescriptionCopy to Clipboard
Updates the store
Parameters
| Name | Type | Description |
|---|---|---|
payloadCopy to Clipboard | AdminPostStoreReqCopy to Clipboard | update to apply to the store. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminStoresResCopy to Clipboard>
the updated store.