Get All Cities

Retrieves a list of all cities.

HTTP Request

GET/api/shop/locations/cities

Authorization

Authorization

• Required: No
• Permission: Public
• Authentication: None

Query Parameters

Parameter	Type	Default	Description
limit	integer	10	Number of results to return per page.
offset	integer	0	Number of results to skip before returning results.
search	string	—	Search term to lookup results by`name`.
ordering	string	—	Order results by (`name`).
state	string	—	Filter results by state ID.

Example Requests

🐍 Python

1import requests
2response = requests.get('http://www.example.com/api/shop/locations/cities', params={
3  'limit': 5,
4  'ordering': 'name',
5  'search': 'Tehran',
6  'state': 1,
7})
8print(response.json())

🌐 Curl

1curl "http://www.example.com/api/shop/locations/cities?limit=5&ordering=name&search=Tehran&state=1"

Response Fields

Field	Type	Description
count	Integer	Total number of categories
next	String	URL for the next page of results
previous	String	URL for the previous page of results
results	Array[Object]	Array of City objects

City Object Data Structure

Field	Type	Description
id	integer	Unique ID of the city.
name	string	Name of the city.

Example Response

{
    "count": 1119,
    "next": "http://127.0.0.1:8000/api/shop/locations/cities?limit=3&offset=3",
    "previous": null,
    "results": [
        {
            "id": 527,
            "name": "آب بر"
        },
        {
            "id": 261,
            "name": "آب پخش"
        },
        {
            "id": 477,
            "name": "آبادان"
        }
    ]
}