GET
/
api
/
v2
/
storefront
/
countries
/
{iso}
Retrieve a Country
curl --request GET \
  --url https://demo.spreecommerce.org/api/v2/storefront/countries/{iso}
{
  "data": {
    "id": "1",
    "type": "country",
    "attributes": {
      "iso": "US",
      "iso3": "USA",
      "iso_name": "UNITED STATES",
      "name": "United States",
      "states_required": true,
      "zipcode_required": true,
      "default": true
    },
    "relationships": {
      "states": {
        "data": [
          {
            "abbr": "NY",
            "name": "New York"
          }
        ]
      }
    }
  },
  "included": [
    {
      "abbr": "NY",
      "name": "New York"
    }
  ]
}

Path Parameters

​
iso
string
required

Provide a Country ISO US or ISO3 USA code.

Example:

"GB"

Query Parameters

​
include
string

Specify the related resources you would like to receive in the response body. More Information.

​
fields[country]
string

Specify the fields you would like returned in the response body. More information.

Response

200
application/vnd.api+json

200 Success - Returns the country object.

The response is of type object.