Class: AdminCurrenciesResource
Hierarchy
defaultCopy to Clipboard↳
AdminCurrenciesResourceCopy to Clipboard
Methods
list
▸ list(query?Copy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCurrenciesListResCopy to Clipboard>
DescriptionCopy to Clipboard
Lists currencies.
This feature is under development and may change in the future.
To use this feature please enable featureflag tax_inclusive_pricingCopy to Clipboard in your medusa backend project.
Parameters
| Name | Type |
|---|---|
query?Copy to Clipboard | AdminGetCurrenciesParamsCopy to Clipboard |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCurrenciesListResCopy to Clipboard>
the list of currencies as well as the pagination properties.
Defined in
medusa-js/src/resources/admin/currencies.ts:20
update
▸ update(codeCopy to Clipboard, payloadCopy to Clipboard, customHeaders?Copy to Clipboard): ResponsePromiseCopy to Clipboard<AdminCurrenciesResCopy to Clipboard>
DescriptionCopy to Clipboard
Updates a currency
This feature is under development and may change in the future.
To use this feature please enable featureflag tax_inclusive_pricingCopy to Clipboard in your medusa backend project.
Parameters
| Name | Type | Description |
|---|---|---|
codeCopy to Clipboard | stringCopy to Clipboard | code of the currency to update. |
payloadCopy to Clipboard | AdminPostCurrenciesCurrencyReqCopy to Clipboard | update to apply to currency. |
customHeadersCopy to Clipboard | RecordCopy to Clipboard<stringCopy to Clipboard, anyCopy to Clipboard> |
Returns
ResponsePromiseCopy to Clipboard<AdminCurrenciesResCopy to Clipboard>
the updated currency.