Skip to content
docs
Guides
ES
Fulfillment & ShippingGeo

List areas

Lists geographic areas, optionally filtered by country, level, parent, source and text.

GET/v1/geo/areas

Lists geographic areas, optionally filtered by country, level, parent, source and text.

Query Parameters

countryCode?string

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

type?string

Only this type.

Value in

  • "level1"
  • "level2"
  • "level3"
parentId?string

Identifier of the parent.

parentCode?string
source?string

Source of the data.

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": "7204558912004325301",    "countryCode": "PE",    "type": "level1",    "code": "example_code",    "name": "Example resource",    "parentId": "7204558912004325301",    "source": "example"  }]