exchange-rates endpoint returns a bundle of current exchange rates that can be used to convert amounts from any known currency into a freely selectable target currency.
The rates are based on the reference rates obtained from the European Central Bank (ECB). Internally these rates are stored relative to the base currency EUR; the endpoint derives the cross rates to the requested target currency from them. Among other things, the interface is used by the Admin Interface to display amounts locally in the selected display currency without requiring a separate request for each conversion.
The exchange rates are fetched daily from the ECB. The endpoint always returns the most recent exchange rate known to the shop.
Supported methods
Overview of all supported methods.Data fields of a rate entry
Each entry in therates object describes the conversion rate of one currency into the requested target currency.
The base currency EUR is always included in the result, even if no dedicated rate record exists for it in the database. It implicitly has the rate
1.0 with the current date.Methods for exchange rates
GET exchange-rates
This endpoint retrieves a bundle of conversion rates relative to a target currency. The target currency is passed via the mandatory parametertarget as a three-letter ISO 4217 currency code (e.g. EUR, USD, GBP). The response contains a rate entry for every currency known to the system, plus the target currency itself (with rate 1.0).
Example
Supported parameters
Response
1 USD equals roughly 0.92 EUR and 1 GBP roughly 1.18 EUR. To convert an amount, multiply it by the rate of the source currency.