[POST] .../v1/region/get
Returns region. Use this method to read the region reference tree for addresses, customers, delivery data and other catalog records that store a region_id. The response returns active, non-deleted regions with id, parent_id, name and last_update; the request body is required and supports id and parent_id filters while ids and parent_ids fields. The caller must have region select permission 444 and the method reads data in the current request context without changing state. Missing body, denied permission, invalid filter values and database errors are returned as HTTP 200 ErrorResult business errors.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| id | int | Region IDs. |
| parent_id | int | IDs of parent regions that contain the requested regions. |
Request Example
{
"filters": [
{
"Field": "parent_id",
"Operator": "Equal",
"Value": "1"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of Region | Result array. |
Response Example
{
"ok": true,
"result": [
{
"id": 12,
"parent_id": 1,
"name": "Tashkent",
"last_update": 1712345600
}
]
}