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.
Token credential sent in the Authorization header, in the form: Token <your-token>. Requires a staff (admin) account.
The page number to return.
1The number of items to return per page.
10Orders the results by one or more fields. Separate multiple fields with commas. Prefix a field with a hyphen (-) for descending order.
-idFilter by name. Case-sensitive exact match.
IstanbulFilter by country identifier. Keeps only cities belonging to the given country.
1Filter by country code. Case-insensitive exact match.
TRFilter by name prefix. Case-insensitive starts-with match — ?name_startswith=ist matches Istanbul.
IstFilter 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.
falseFilter by the active status of retail stores linked through townships.
trueFilter by retail store type name. Case-sensitive exact match. Keeps only cities whose retail stores (via townships) have the given store type name.
flagshipA page of cities.
A paginated list of cities.
Total number of cities matching the request.
URL of the next page, or null if this is the last page.
URL of the previous page, or null if this is the first page.
The request contains invalid or missing data.
Authentication credentials were not provided or are invalid.
The authenticated user does not have administrator privileges.
The requested page of the city list does not exist — the page number is beyond the last page or is not a number.
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?

