get

/currencies

Returns a list of all store Currency.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

2 Headers

Responses

Schema
array[object]
is_default
boolean

Specifies the store’s default currency display format. For write operations, only true value is accepted. When set to true, it cannot be unset, only overridden.

1 validation
country_iso2
string

2-letter ISO Alpha-2 code for this currency’s country.

1 validation
currency_code
string

3-letter ISO 4217 code for this currency.

1 validation + required
currency_exchange_rate
string

Amount of this currency that is equivalent to one U.S. dollar.(Float, Float as String, Integer)

1 validation + required
auto_update
boolean

Specifies whether to use the Open Exchange Rates service to update the currency conversion. A value of false specifies a static conversion value.

1 validation
token_location
string

Specifies whether this currency’s symbol appears to the “left” or “right” of the numeric amount.

1 validation + required
token
string

Symbol for this currency.

1 validation + required
decimal_token
string

Symbol used as the decimal separator in this currency.

1 validation + required
thousands_token
string

Symbol used as the thousands separator in this currency.

1 validation + required
decimal_places
integer

Number of decimal places to show for this currency.

1 validation + required
name
string

Name of the currency.

1 validation + required
enabled
boolean

If the currency is active on the store.

1 validation
is_transactional
boolean

Indicates if the currency is set as transactional or not. False means display only currency

1 validation
id
integer

Id of the currency. READ-ONLY.

1 validation
last_updated
string

Date the currency was last updated, created or modified.

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client