List supported currencies - Spree Commerce documentation

GET

api

store

currencies

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const currencies = await client.currencies.list()

curl --request GET \
  --url http://{defaultHost}/api/v3/store/currencies \
  --header 'x-spree-api-key: <api-key>'

{
  "data": [
    {
      "iso_code": "USD",
      "name": "United States Dollar",
      "symbol": "$"
    },
    {
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€"
    }
  ]
}

{
  "error": {
    "code": "invalid_token",
    "message": "Valid API key required"
  }
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Query Parameters

fields

string

Comma-separated list of fields to include (e.g., name,slug,price). id is always included.

Response

currencies found

data

object[]

required

Show child attributes

Get a country

List supported locales

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

const client = createClient({
  baseUrl: 'https://your-store.com',
  publishableKey: '<api-key>',
})

const currencies = await client.currencies.list()

curl --request GET \
  --url http://{defaultHost}/api/v3/store/currencies \
  --header 'x-spree-api-key: <api-key>'

{
  "data": [
    {
      "iso_code": "USD",
      "name": "United States Dollar",
      "symbol": "$"
    },
    {
      "iso_code": "EUR",
      "name": "Euro",
      "symbol": "€"
    }
  ]
}

{
  "error": {
    "code": "invalid_token",
    "message": "Valid API key required"
  }
}