List countries - Spree Commerce documentation

GET

api

store

countries

Spree SDK

import { createClient } from '@spree/sdk'

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

const countries = await client.countries.list()

{
  "data": [
    {
      "iso": "DE",
      "iso3": "IS39",
      "name": "Germany",
      "states_required": false,
      "zipcode_required": true
    },
    {
      "iso": "US",
      "iso3": "USA",
      "name": "United States of America",
      "states_required": true,
      "zipcode_required": true
    }
  ]
}

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

countries found

data

object[]

required

Show child attributes

Get a store credit

Get a country

⌘I

Spree SDK

import { createClient } from '@spree/sdk'

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

const countries = await client.countries.list()

{
  "data": [
    {
      "iso": "DE",
      "iso3": "IS39",
      "name": "Germany",
      "states_required": false,
      "zipcode_required": true
    },
    {
      "iso": "US",
      "iso3": "USA",
      "name": "United States of America",
      "states_required": true,
      "zipcode_required": true
    }
  ]
}