Get a country

GET

api

store

countries

{iso}

Spree SDK

import { createClient } from '@spree/sdk'

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

const country = await client.countries.get('US')

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

{
  "iso": "US",
  "iso3": "USA",
  "name": "United States of America",
  "states_required": true,
  "zipcode_required": true
}

{
  "error": {
    "code": "record_not_found",
    "message": "Country not found"
  }
}

Authorizations

x-spree-api-key

string

header

required

Publishable API key for store access

Headers

x-spree-api-key

string

required

Path Parameters

iso

string

required

Country ISO 3166-1 alpha-2 code (e.g., "US", "DE")

Query Parameters

fields

string

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

Response

country found

iso

string

required

iso3

string

required

name

string

required

states_required

boolean

required

zipcode_required

boolean

required

List countries

List supported currencies

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

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

const country = await client.countries.get('US')

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

{
  "iso": "US",
  "iso3": "USA",
  "name": "United States of America",
  "states_required": true,
  "zipcode_required": true
}

{
  "error": {
    "code": "record_not_found",
    "message": "Country not found"
  }
}

API basics

Endpoints

Authorizations

Headers

Path Parameters

Query Parameters

Response