List All States

Retrieves a list of all states.

HTTP Request

GET/api/shop/locations/states

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`, `code`.
ordering	string	—	Order results by (`name`, `code`, `country`).
country	string	—	Filter results by country ID.

Example Requests

🐍 Python

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

🌐 Curl

1curl "http://www.example.com/api/shop/locations/states?limit=5&ordering=name&search=Tehran&country=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 State objects

State Object Data Structure

Field	Type	Description
id	integer	Unique ID of the state.
name	string	Name of the state.
code	string	ISO code of the state (e.g., "IR-07").

Example Response

{
    "count": 31,
    "next": "http://127.0.0.1:8000/api/shop/locations/states?limit=2&offset=2",
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "آذربایجان شرقی",
            "code": "EA"
        },
        {
            "id": 2,
            "name": "آذربایجان غربی",
            "code": "WA"
        }
    ]
}