Documentation

Ucommerce includes full API reference documentation and lots of helpful articles to help you build your e-commerce site as effortlessly as possible.

Topics Payment Providers
v7.18

ExchangeRateQuery

What is it used for?

The ExchangeRateQuery is used to query the "uCommerce_ExchangeRate" table for the exchange rate between two currency ISO codes. It is primarily used by the default implementation of ICurrencyConversionService, which will then use this rate to perform a conversion between two currencies.

Arguments

The query argument is of type UCommerce.Catalog.Models.ExchangeRateQueryArgs and it simply contains the following properties:

Request

The request argument is of type UCommerce.Catalog.Models.ExchangeRateQueryArgs and contains the following:

Property Name Property Type Property Description
FromCurrency String ISO code for the currency to convert from.
ToCurrency String ISO code for the currency to convert to.

Result

The result is of type UCommerce.Catalog.Models.ExchangeRateQueryResult and contains the following:

Property Name Property Type Property Description
Properties IDictionary<string, object> Dictionary with the purpose of extending the Result object.
Items IList List of result items. See below for more details.

Result Item

The result contains a list of result items of type UCommerce.Catalog.Models.ExchangeRateQueryResult.Item. This contains the following:

Property Name Property Type Property Description
FromCurrencyISOCode string ISO code for the currency to be converted from.
ToCurrencyISOCode string ISO code for the currency to be converted to.
Rate decimal Exchange rate value between the two currencies.
Properties IDictionary<string, object> Dictionary with the purpose of extending each Item object.