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	—	Number of results to return per page.
offset	integer	—	Number of results to skip before returning results.
search	string	—	Search term to filter results by `name`.
ordering	string	—	Field to 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"

Status Codes

Code	Description
200	List retrieved successfully
400	Bad request — invalid input
500	Internal server error

Response Fields

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