Get 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	—	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`, `code`.
ordering	string	—	Field to 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"

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 state.
name	string	Name of the state.
code	string	ISO code of the state (e.g., "IR-07").