For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP
- Overview

GraphQL B2B Queries

countries

Example Query

1 query ExampleQuery($storeHash: String) {
2   countries(storeHash: $storeHash) {
3     id
4     countryName
5     countryCode
6     states {
7       stateName
8       stateCode
9     }
10     stateRequired
11   }
12 }

Variables

1 {
2   "storeHash": "example"
3 }

Example response

1 {
2   "data": {
3     "countries": [
4       {
5         "id": "example",
6         "countryName": "example",
7         "countryCode": "example",
8         "states": [
9           {
10             "stateName": "example",
11             "stateCode": "example"
12           }
13         ],
14         "stateRequired": true
15       }
16     ]
17   }
18 }

List of countries and states in the country. Doesn't require a Token.

Was this page helpful?

address

defaultShippingAddress

Arguments

storeHashStringOptional

Store hash

Returns

an optional list of optional CountryType

idString

The id of country

countryNameString

The country name

countryCodeString

The country iso2 code

stateslist of optional StatesType

List of states

stateRequiredBoolean

Whether state is required for this country