Subscribe
Subscribe

How to Get All Countries List Using GraphQL in Magento 2?

Magento 2

In Magento 2, the countries query is used to retrieve a list of all countries where the entity can do business. If you need information about a specific country, use the country query instead. This guide explains how to fetch the list of countries using GraphQL.

GraphQL Query Syntax

To fetch the list of countries, you can use the following GraphQL syntax:

{
  countries {
    Countries
  }
}

For detailed information about the fields and types in this query, refer to the countries reference.

Example:

The example below demonstrates how to retrieve all countries listed in the current instance of Magento 2, along with their details.

Request

query {
  countries {
    id
    two_letter_abbreviation
    three_letter_abbreviation
    full_name_locale
    full_name_english
    available_regions {
      id
      code
      name
    }
  }
}

Response

Here is a truncated example of the response. Note that the available_regions attribute is null if the country does not have any regions. Otherwise, it contains an array of the country’s regions.

{
  "data": {
    "countries": [
      {
        "id": "AD",
        "two_letter_abbreviation": "AD",
        "three_letter_abbreviation": "AND",
        "full_name_locale": "Andorra",
        "full_name_english": "Andorra",
        "available_regions": null
      },
      {
        "id": "AE",
        "two_letter_abbreviation": "AE",
        "three_letter_abbreviation": "ARE",
        "full_name_locale": "United Arab Emirates",
        "full_name_english": "United Arab Emirates",
        "available_regions": null
      },
      {
        "id": "AF",
        "two_letter_abbreviation": "AF",
        "three_letter_abbreviation": "AFG",
        "full_name_locale": "Afghanistan",
        "full_name_english": "Afghanistan",
        "available_regions": null
      },
      {
        "id": "AT",
        "two_letter_abbreviation": "AT",
        "three_letter_abbreviation": "AUT",
        "full_name_locale": "Austria",
        "full_name_english": "Austria",
        "available_regions": [
          {
            "id": 102,
            "code": "BL",
            "name": "Burgenland"
          },
          {
            "id": 99,
            "code": "KN",
            "name": "Kärnten"
          },
          {
            "id": 96,
            "code": "NO",
            "name": "Niederösterreich"
          },
          {
            "id": 97,
            "code": "OO",
            "name": "Oberösterreich"
          },
          {
            "id": 98,
            "code": "SB",
            "name": "Salzburg"
          },
          {
            "id": 100,
            "code": "ST",
            "name": "Steiermark"
          },
          {
            "id": 101,
            "code": "TI",
            "name": "Tirol"
          },
          {
            "id": 103,
            "code": "VB",
            "name": "Vorarlberg"
          },
          {
            "id": 95,
            "code": "WI",
            "name": "Wien"
          }
        ]
      }
    ]
  }
}

Conclusion

Using the countries query in Magento 2, you can retrieve a comprehensive list of all countries and their regions. This information is helpful for building location-based features or ensuring proper geographic configurations in your store.

Related Posts