RESTAdminManagementCurrencies

List Currencies

Returns a list of all store Currency.

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Information & Settings | modify | `store_v2_information` | | Information & Settings | read-only | `store_v2_information_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Query parameters

pageintegerOptionalDefaults to 1

Specifies the page number in a limited (paginated) list of currencies.

limitintegerOptionalDefaults to 50

Controls the number of items per page in a limited (paginated) list of currencies.

Response

auto_updateboolean

Specifies whether to use the Open Exchange Rates service to update the currency conversion. A value of false specifies a static conversion value. auto_update only applies to non-transactional currencies.

country_iso2string

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

currency_codestring

3-letter ISO 4217 code for this currency.

currency_exchange_ratestring

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

decimal_placesinteger
Number of decimal places to show for this currency.
decimal_tokenstring
Symbol used as the decimal separator in this currency.
default_for_country_codeslist of strings

Default 3-letter ISO 4217 code for this currency.

enabledboolean
If the currency is active on the store.
idintegerRead-only
ID of the currency. Read only.
is_defaultboolean

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.

is_transactionalboolean
Indicates if the currency is set as transactional or not. False means display only currency
last_updateddatetimeRead-only
Date the currency was last updated, created or modified.
namestring
Name of the currency.
thousands_tokenstring
Symbol used as the thousands separator in this currency.
tokenstring
Symbol for this currency.
token_locationstring

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

use_default_nameboolean
Default currency name