Get all countries and regions information for the store

GET /V1/directory/countries

Get all countries and regions information for the store.

Responses

  • 200

    200 Success.

    Hide response attributes Show response attributes object
    • id string Required

      The country id for the store.

    • two_letter_abbreviation string Required

      The country 2 letter abbreviation for the store.

    • three_letter_abbreviation string Required

      The country 3 letter abbreviation for the store.

    • full_name_locale string Required

      The country full name (in store locale) for the store.

    • full_name_english string Required

      The country full name (in English) for the store.

    • available_regions array[object]

      Region Information interface.

      Hide available_regions attributes Show available_regions attributes object
      • id string Required

        Region id

      • code string Required

        Region code

      • name string Required

        Region name

      • extension_attributes object

        ExtensionInterface class for @see \Magento\Directory\Api\Data\RegionInformationInterface

    • extension_attributes object

      ExtensionInterface class for @see \Magento\Directory\Api\Data\CountryInformationInterface
  • default

    Unexpected error

    Hide response attributes Show response attributes object
    • message string Required

      Error message

    • errors array[object]

      Error details

      Hide errors attributes Show errors attributes object
    • code integer

      Error code

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object
    • trace string

      Stack trace
GET /V1/directory/countries 
curl \
 -X GET https://magento2.winkelstraat.mac/rest/all/V1/directory/countries
Response examples (200) 
[
  {
    "id": "string",
    "two_letter_abbreviation": "string",
    "three_letter_abbreviation": "string",
    "full_name_locale": "string",
    "full_name_english": "string",
    "available_regions": [
      {
        "id": "string",
        "code": "string",
        "name": "string",
        "extension_attributes": {}
      }
    ],
    "extension_attributes": {}
  }
]
Response examples (default) 
{
  "message": "string",
  "errors": [
    {
      "message": "string",
      "parameters": [
        {
          "resources": "string",
          "fieldName": "string",
          "fieldValue": "string"
        }
      ]
    }
  ],
  "code": 42,
  "parameters": [
    {
      "resources": "string",
      "fieldName": "string",
      "fieldValue": "string"
    }
  ],
  "trace": "string"
}