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.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
      • Explorer
          • QUERYsite
          • QUERYchannel
          • QUERYcustomer
          • QUERYnode
          • QUERYlocations
          • QUERYshopperPreferences
          • QUERYstore
          • QUERYcountries
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLStorefrontQueries

countries

Example Query
1query ExampleQuery($filters: CountryFiltersInput) {
2 countries(filters: $filters) {
3 entityId
4 code
5 name
6 iso3
7 currency {
8 code
9 name
10 symbol
11 }
12 statesOrProvinces {
13 entityId
14 name
15 abbreviation
16 }
17 }
18}
Variables
1{
2 "filters": {
3 "name": "example",
4 "code": "example"
5 }
6}
Example response
1{
2 "data": {
3 "countries": [
4 {
5 "entityId": 0,
6 "code": "example",
7 "name": "example",
8 "iso3": "example",
9 "currency": {
10 "code": "example",
11 "name": "example",
12 "symbol": "example"
13 },
14 "statesOrProvinces": [
15 {
16 "entityId": 0,
17 "name": "example",
18 "abbreviation": "example"
19 }
20 ]
21 }
22 ]
23 }
24}
A list of available countries.
Was this page helpful?
Previous

store

Next

createCart

Built with

Arguments

filtersCountryFiltersInputOptional
An input parameter to narrow down the countries you receive based on country name and code.

Returns

an optional list of Countrys
entityIdInteger
A country's ID.
codeString

The 2-letter ISO Alpha-2 code for a country.

nameString
A country's name.
iso3String

The 3-letter ISO Alpha-3 code for a country.

currencyCountryCurrency
A country's currency.
statesOrProvinceslist of StateOrProvinces
A country's states or provinces.