Get Countries
Retrieve a list of all available countries and their states/provinces.
Endpoint
GET /api/shop/countriesRequest Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
X-STOREFRONT-KEY | Yes | Your storefront API key |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
includeStates | boolean | No | Include state/province information (default: true) |
Response Fields (200 OK)
| Field | Type | Description |
|---|---|---|
id | integer | Country ID |
code | string | ISO 2-letter country code |
name | string | Country name |
states | array | States/provinces within country |
State Fields
| Field | Type | Description |
|---|---|---|
code | string | State/province code |
name | string | State/province name |
Use Cases
- Build country selector dropdowns
- Populate country list in shipping/billing forms
- Load state/province options based on country selection
- Validate shipping addresses
- Display available shipping destinations