Skip to content
Guides
ES
API reference
stable

List areas

Lists the delivery areas the store has defined. Areas group districts to price shipping without listing every district.

GET/v1/geo/areas

Lists the delivery areas the store has defined. Areas group districts to price shipping without listing every district.

Query Parameters

countryCode?string

ISO 3166-1 alpha-2 country code, for example PE.

type?string

Value in

  • "level1"
  • "level2"
  • "level3"
parentId?null|string
parentCode?string
source?string
search?string

Free-text filter. Which fields it covers depends on the resource.

limit?integer

Maximum number of results to return.

Formatint32

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/geo/areas"
[  {    "id": "string",    "countryCode": "string",    "type": "level1",    "code": "string",    "name": "string",    "parentId": null,    "source": "string"  }]