currencies

currencies.find

Returns all the currencies of the e-

Request

Admin SDK
Admin.api('commerce.currencies.find', request, function(response) { … });
HTTP POST
/api/v6/commerce.currencies.find
{
  "fields" : [ "code", "name", … ] // fields to return - string
}

Response

{
  "status" : "ok",
  "currencies" : [ {
    "code" : "EUR", // code (ISO) - string(3)
    "name" : "Euro", // name - string(1…30)
    "fractionDigits" : 2, // number of fraction digits - int(0…)
    "symbol" : "€", // symbol - string
    "change" : "1.57028" // change related to the default currency - decimal[10,5](0…)
  }, … ]
}

currencies.create

Create a new currency in the e-

Request

Admin SDK
Admin.api('commerce.currencies.create', request, function(response) { … });
HTTP POST
/api/v6/commerce.currencies.create
{
  "currency" : { // currency to create (required)
    "code" : "EUR", // code (ISO) (required) - string(3)
    "change" : "1.57028" // change related to the default currency (required) - decimal[10,5](0…)
  }
}

Response

{
  "status" : "ok"
}

Errors

Field Type Description
code AlreadyExists Currency '<code>' already exists

currencies.update-changes

Updates the changes of one or more currencies.

Request

Admin SDK
Admin.api('commerce.currencies.update-changes', request, function(response) { … });
HTTP POST
/api/v6/commerce.currencies.update-changes
{
  "changes" : { // changes to update (required) - string(3) -> decimal[10,5](0…)
    "EUR" : 1.57028,
    "USD" : 1.29257,
    "GBP" : 0.91642
  }
}

Response

{
  "status" : "ok"
}

Errors

Field Type Description
code NotFound Currency '<code>' does not exist

currencies.delete

Deletes one or more currencies from the e-

Request

Admin SDK
Admin.api('commerce.currencies.delete', request, function(response) { … });
HTTP POST
/api/v6/commerce.currencies.delete
{
  "codes" : [ "EUR", "USD", … ] // codes (ISO) of the currencies to delete (required) - string(3)
}

Response

{
  "status" : "ok"
}

Available currencies

The following currencies are supported:

Code Name Symbol Fractional digits
ALL Albanian Lek Lek 2
ARS Argentine Peso $ 2
AUD Australian Dollar $ 2
BAM Bosnian Mark KM 2
BGN Bulgarian Lev лв 2
BRL Brazilian Real R$ 2
CAD Canadian Dollar CDN$ 2
CHF Swiss Franc CHF 2
CLP Chilean Peso $ 0
CNY Chinese Yuan Renminbi ¥ 2
COP Colombian Peso $ 0
CRC Costa Rican Colon 2
CZK Czech Koruna Kč 2
DKK Danish Krone kr 2
DOP Dominican R. Peso RD$ 2
EEK Estonian Kroon ks 2
EUR Euro € 2
GBP British Pound Sterling £ 2
GTQ Guatemalan Quetzal Q 2
HNL Honduran Lempira L. 2
HRK Croatian Kuna kn 2
HUF Hungarian Forint Ft 2
ILS Israeli New Shekel ₪ 2
INR Indian Rupee Rs. 2
ISK Iceland Krona kr 0
JPY Japanese Yen ¥ 0
LTL Lithuanian Litas Lt 2
LVL Latvian Lats Ls 2
MXN Mexican Peso $ 2
NIO Nicaraguan Cordoba Oro C$ 2
NOK Norwegian Kroner kr 2
NZD New Zealand Dollar $ 2
PAB Panamanian Balboa B/. 2
PEN Peruvian Nuevo Sol S/. 2
PLN Polish Zloty zł 2
PYG Paraguay Guarani Gs 2
RON Romanian New Lei lei 2
RUB Russian Rouble руб 2
SEK Swedish Krona kr 2
TND Tunisian Dinar TND 2
UAH Ukraine Hryvnia грн 2
USD US Dollar $ 2
UYU Uruguayan Peso $U 2
VEF Venezuelan Bolivar Bs 2
ZAR South African Rand R 2
`