eCommerce Docs

Community
Log in
Your Account

commerce/catalog/admin/currency

Manage the currency localization rules and exchange rates for any of the currencies that are supported for placing orders in.

JSON Example

CurrencyLocalization Properties

Property	Description
auditInfo	type: auditInfo Basic audit info about the object, including date, time, and user account. This data may be captured when creating, updating, and removing data.
auditInfo.createBy	type: string Identifier of the user that created the object. System created and read only.
auditInfo.createDate	type: DateTime The date and time in UTC format set when the object was created.
auditInfo.updateBy	type: string Identifier of the user that updated the entity most recently.
auditInfo.updateDate	type: DateTime The date and time in UTC format the object was updated most recently.
currencyCode	type: string The localized currency code for the monetary amount.
decimalPlaces	type: int The allowed decimal places used in the localized currency format
roundingStrategy	type: int The rounding strategy used in the localized currency format.

Operations

Operation Name	Request URI	Description
AddCurrencyExchangeRates	POST %7bcurrencyCode%7d%2fexchangerates	Provide the currency exchange rates that are required for calculating payments of international orders.
AddCurrencyLocalization	POST %3fresponseFields%3d%7bresponseFields%7d	Currency localization details include the allowed decimal places and rounding strategy that is used in formatting currencies.
DeleteCurrencyExchangeRate	DELETE %7bcurrencyCode%7d%2fexchangerates%2f%7btoCurrencyCode%7d	Currency exchange rate information can be deleted from the currency databank if needed.
DeleteCurrencyLocalization	DELETE %7bcurrencyCode%7d	Localized currency format information can be deleted from the currency databank if needed.
GetCurrencyExchangeRate	GET %7bcurrencyCode%7d%2fexchangerates%2f%7btoCurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieve the exchange rates of currencies for international orders.
GetCurrencyExchangeRates	GET %7bcurrencyCode%7d%2fexchangerates%3fresponseFields%3d%7bresponseFields%7d	Retrieve the exchange rates of currencies for international orders.
GetCurrencyLocalization	GET %7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d	Retrieve the currency localization information, such as the formatting rules with allowed decimal places and rounding strategies.
GetCurrencyLocalizations	GET %3fresponseFields%3d%7bresponseFields%7d	Retrieve the currency localization information, such as the formatting rules with allowed decimal places and rounding strategies.
UpdateCurrencyExchangeRates	PUT %7bcurrencyCode%7d%2fexchangerates	Change the details of an existing exchange rate between two currencies.
UpdateCurrencyLocalization	PUT %7bcurrencyCode%7d%3fresponseFields%3d%7bresponseFields%7d	Update existing currency localization information by providing new formatting rules, such as allowed decimal places and rounding strategies.