DOCUMENTATION

Multi Currency Store

Everything you need to get up and running with our Multi Currency Store plugin!

Exchange rates APIs

The plugin has 4 APIs built in that it can use to get the live exchange rates.  These are:

  • ExchangeRate-API.com
  • Open Exchange Rates
  • Currency Layer
  • European Central Bank

Each API has a slightly different set of requirements and the plugin tries for cater for each. Each API is discussed in a little more detail below.

ExchangeRate-API.com

ExchangeRate-API.com require you to have an account with them and have both a free and a premium account with the free account having some restrictions on the number of calls that you can make to the API.

Once you have an account, you will be provided with an API key that you will need to enter into the API key field.  You can also set how often the plugin should check the rates using the Check rates drop down. More information about scheduling when to fetch the exchange rates can be found in the Fetching the Live Rates section.

Open Exchange Rates

Open Exchange Rates require you to have an account with them and provide both a free and a premium account. The free account only provides conversion from USD as the base currency and has a limit on the number of calls that you can make a month and how often the rates are updated.

If your have a free account with Open Exchange Rates, set the Free account? drop down to 'Yes' and the plugin will reverse calculate the exchange rates for each currency in your store into USD first before calculating the exchange rate into each currency in your store.

If you have a premium account, set this to 'No' and the plugin will request the rates against your stores base currency as normal.

You will also need to enter the App ID provided by Open Exchange Rates into the App ID field and set how often to check the rates using the Check rates drop down. More information about scheduling when to fetch the exchange rates can be found in the Fetching the Live Rates section.

Currency Layer

Currency Layer require you to have an account with them and provide both a free account and a premium account. The free account only provides conversion from USD and has restrictions on the number of calls you can make and how often the rates are updated.

If you have a free account, set the Free account? drop down to 'Yes' and the plugin will reverse calculate the exchange rates fore each currency in your store into USD first before calculating the actual rate.

You will also need to enter your API key in the API Key field and set the frequency that the rates are checked by setting the check rates drop down. More information about scheduling when to fetch the exchange rates can be found in the Fetching the Live Rates section.

European Central Bank

The ECB does not provide an API but provides a feed every day at 16:00 CET. The plugin automatically downloads the feed and saves the rates.

Exchange rates from the ECB and quoted against the Euro. If your stores base currency is not EUR but is a currency within the feed, the plugin will reverse calculate the exchanges rates against your stores base currency.

Because the time and the frequency at which the ECB makes the rates available is set and doesn't change, the plugin doesn't give you the option of how often to check the rates and will fetch the rates automatically every day. The rates are also provided for free so there is no need for an API key like the other APIs.

Powered by Froala Editor