For the complete documentation index, see llms.txt. This page is also available as Markdown.

List cities

Returns a paginated list of cities ordered by priority ascending, then name ascending.

Unlike the storefront endpoint, this admin endpoint returns all cities regardless of their is_active status.

Filter by country, country__code, name, name_startswith, retailstore__isnull, retailstore__is_active, or store_type. Order results with sort.

get
/cities/
Authorizations
AuthorizationstringRequired

Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.

Query parameters
pageintegerOptional

The page number to return.

Default: 1
limitintegerOptional

The number of items to return per page.

Default: 10
sortstringOptional

Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.

Example: -id
namestringOptional

Filter by name. Case-sensitive exact match.

Example: Istanbul
countryintegerOptional

Filter by country identifier. Keeps only cities belonging to the given country.

Example: 1
country__codestringOptional

Filter by country code. Case-insensitive exact match.

Example: TR
name_startswithstringOptional

Filter by name prefix. Case-insensitive starts-with match — ?name_startswith=ist matches Istanbul.

Example: Ist
retailstore__isnullbooleanOptional

Filter by retail store presence (via townships). false keeps only cities that have at least one retail store; true keeps only cities with no retail store.

Example: false
retailstore__is_activebooleanOptional

Filter by the active status of retail stores linked through townships.

Example: true
store_typestringOptional

Filter by retail store type name. Case-sensitive exact match. Keeps only cities whose retail stores (via townships) have the given store type name.

Example: flagship
Responses
200

A page of cities.

application/json

A paginated list of cities.

countintegerOptional

Total number of cities matching the request.

nextstring · nullableOptional

URL of the next page, or null if this is the last page.

previousstring · nullableOptional

URL of the previous page, or null if this is the first page.

get/cities/
GET /api/v1/remote/1/cities/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "pk": 3,
      "is_active": true,
      "name": "Istanbul",
      "country": 1,
      "priority": 1,
      "postcode": null,
      "translations": {
        "tr": {
          "name": "İstanbul"
        }
      }
    }
  ]
}

Last updated

Was this helpful?