currencies

• currencies.find
• currencies.create
• currencies.update-changes
• currencies.delete

currencies.find

Returns all the currencies of the e-

Request

Admin SDK
Admin.api('commerce.currencies.find', request, function(response) { … });

HTTP POST
/api/v13/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/v13/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

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/v13/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

currencies.delete

Deletes one or more currencies from the e-

Request

Admin SDK
Admin.api('commerce.currencies.delete', request, function(response) { … });

HTTP POST
/api/v13/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: