Skip to main content
GET
/
api
/
v3
/
store
/
markets
Spree SDK
import { createClient } from '@spree/sdk'

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

const markets = await client.markets.list()
curl --request GET \
  --url http://{defaultHost}/api/v3/store/markets \
  --header 'x-spree-api-key: <api-key>'
{
  "data": [
    {
      "id": "mkt_UkLWZg9DAJ",
      "name": "North America",
      "currency": "USD",
      "default_locale": "en",
      "tax_inclusive": false,
      "default": true,
      "country_isos": [
        "US"
      ],
      "supported_locales": [
        "en",
        "es"
      ],
      "countries": [
        {
          "iso": "US",
          "iso3": "USA",
          "name": "United States of America",
          "states_required": true,
          "zipcode_required": true
        }
      ]
    },
    {
      "id": "mkt_gbHJdmfrXB",
      "name": "Europe",
      "currency": "EUR",
      "default_locale": "de",
      "tax_inclusive": true,
      "default": false,
      "country_isos": [
        "DE",
        "FR"
      ],
      "supported_locales": [
        "de",
        "en",
        "fr"
      ],
      "countries": [
        {
          "iso": "DE",
          "iso3": "IS68",
          "name": "Germany",
          "states_required": false,
          "zipcode_required": true
        },
        {
          "iso": "FR",
          "iso3": "IS69",
          "name": "France",
          "states_required": false,
          "zipcode_required": true
        }
      ]
    }
  ]
}
{
  "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

markets found

data
array
required