All Districts

Testing Env

https://www.testecommerce.vodoerp.com

GET

/api/user_districts/v2

Last modified:2025-04-14 00:58:10

Retrieves a list of all districts available in the VODO ERP system. This endpoint supports pagination and filtering by various parameters such as city, user, and district names in English or Arabic. It is designed to fetch district data for a specified city, with the response language customizable via headers.

Headers:

Key	Value	Description	Type
apikey	5f28583f26a1a	You must contact support to get the apikey. `Required`	string
apiconnection	appmobile	You must contact support to get the apiconnection. `Required`	string
lang	ar	ar => Arabic or en => English	string

Query Parameters:

Key	Value	Description	Type
page		The page number you want to go to	string
paginate		Display the required number on one page	string
pagination	false	Show all data without pagination	string
user_id			string
name_en			string
name_ar			string
city_id	62	Search by city: Get city from /api/user_cities	string

Use Case: Ideal for applications needing a comprehensive list of districts, such as dropdown menus in e-commerce platforms for shipping or location selection.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://www.testecommerce.vodoerp.com/api/user_districts/v2?page=&paginate=&pagination=false&user_id=&name_en=&name_ar=&city_id=62' \
--header 'apikey: 5f28583f26a1a' \
--header 'apiconnection: appmobile' \
--header 'Accept-Language: ar'

Response Example

{
    "status": true,
    "message": "success",
    "data": [
        {
            "id": 4475,
            "city_id": 62,
            "name": "طريق الرياض",
            "active": 1
        },
        {
            "id": 4474,
            "city_id": 62,
            "name": "حي الضيافه",
            "active": 1
        },
        {
            "id": 4086,
            "city_id": 62,
            "name": "مخطط الموسى",
            "active": 1
        },
        {
            "id": 4084,
            "city_id": 62,
            "name": "قمبر",
            "active": 1
        },
        {
            "id": 4082,
            "city_id": 62,
            "name": "عتود",
            "active": 1
        },
        {
            "id": 4080,
            "city_id": 62,
            "name": "طيب الاسم",
            "active": 1
        },
        {
            "id": 4078,
            "city_id": 62,
            "name": "ضمك",
            "active": 1
        },
        {
            "id": 4076,
            "city_id": 62,
            "name": "شكر",
            "active": 1
        },
        {
            "id": 4074,
            "city_id": 62,
            "name": "شباعة",
            "active": 1
        },
        {
            "id": 4072,
            "city_id": 62,
            "name": "الأسكان",
            "active": 1
        },
        {
            "id": 4070,
            "city_id": 62,
            "name": "سكن القاعدة الجوية",
            "active": 1
        },
        {
            "id": 4068,
            "city_id": 62,
            "name": "ذلالة",
            "active": 1
        },
        {
            "id": 4066,
            "city_id": 62,
            "name": "ام سرور",
            "active": 1
        },
        {
            "id": 4064,
            "city_id": 62,
            "name": "الواحة",
            "active": 1
        },
        {
            "id": 4062,
            "city_id": 62,
            "name": "الهميلة",
            "active": 1
        },
        {
            "id": 4060,
            "city_id": 62,
            "name": "الهرير",
            "active": 1
        },
        {
            "id": 4058,
            "city_id": 62,
            "name": "النهضة",
            "active": 1
        },
        {
            "id": 4056,
            "city_id": 62,
            "name": "النسيم",
            "active": 1
        },
        {
            "id": 4054,
            "city_id": 62,
            "name": "النزهة",
            "active": 1
        },
        {
            "id": 4052,
            "city_id": 62,
            "name": "النخيل",
            "active": 1
        },
        {
            "id": 4050,
            "city_id": 62,
            "name": "المنتزه",
            "active": 1
        },
        {
            "id": 4048,
            "city_id": 62,
            "name": "المعمورة",
            "active": 1
        },
        {
            "id": 4046,
            "city_id": 62,
            "name": "المعزاب",
            "active": 1
        },
        {
            "id": 4044,
            "city_id": 62,
            "name": "المثناة",
            "active": 1
        },
        {
            "id": 4042,
            "city_id": 62,
            "name": "اللواء الرابع عشر",
            "active": 1
        },
        {
            "id": 4040,
            "city_id": 62,
            "name": "القافلة",
            "active": 1
        },
        {
            "id": 4038,
            "city_id": 62,
            "name": "حي اليرموك",
            "active": 1
        },
        {
            "id": 4036,
            "city_id": 62,
            "name": "العزيزية",
            "active": 1
        },
        {
            "id": 4034,
            "city_id": 62,
            "name": "العرق الشمالي",
            "active": 1
        },
        {
            "id": 4032,
            "city_id": 62,
            "name": "العرق الجنوبي",
            "active": 1
        },
        {
            "id": 4030,
            "city_id": 62,
            "name": "الصقور",
            "active": 1
        },
        {
            "id": 4028,
            "city_id": 62,
            "name": "الشفاء",
            "active": 1
        },
        {
            "id": 4026,
            "city_id": 62,
            "name": "الشرفية",
            "active": 1
        },
        {
            "id": 4024,
            "city_id": 62,
            "name": "السلام",
            "active": 1
        },
        {
            "id": 4022,
            "city_id": 62,
            "name": "حي الوسام",
            "active": 1
        },
        {
            "id": 4020,
            "city_id": 62,
            "name": "الزهور",
            "active": 1
        },
        {
            "id": 4018,
            "city_id": 62,
            "name": "الروضة",
            "active": 1
        },
        {
            "id": 4016,
            "city_id": 62,
            "name": "حي الراقي",
            "active": 1
        },
        {
            "id": 4014,
            "city_id": 62,
            "name": "الربيع",
            "active": 1
        },
        {
            "id": 4012,
            "city_id": 62,
            "name": "الدوحة",
            "active": 1
        },
        {
            "id": 4010,
            "city_id": 62,
            "name": "الخزان",
            "active": 1
        },
        {
            "id": 4008,
            "city_id": 62,
            "name": "الخالدية",
            "active": 1
        },
        {
            "id": 4006,
            "city_id": 62,
            "name": "الجزيرة",
            "active": 1
        },
        {
            "id": 4004,
            "city_id": 62,
            "name": "البوادي",
            "active": 1
        },
        {
            "id": 1820,
            "city_id": 62,
            "name": "الصناعية",
            "active": 1
        },
        {
            "id": 196,
            "city_id": 62,
            "name": "الرحاب",
            "active": 1
        }
    ]
}

Request

Query Params

page

string

required

The page number you want to go to

paginate

string

optional

Display the required number on one page

pagination

string

optional

Show all data without pagination

Example:

false

user_id

string

optional

name_en

string

optional

name_ar

string

optional

city_id

string

required

Search by city: Get city from https://www.testecommerce.vodoerp.com/api/user_cities or https://www.ecommerce.vodoglobal.com/api/user_cities

Example:

Header Params

apikey

string

required

You must contact support to get the apikey.

Example:

5f28583f26a1a

apiconnection

string

required

You must contact support to get the apiconnection.

Example:

appmobile

Accept-Language

string

required

ar => Arabic or en => English

Example:

Responses

🟢200All Districts

application/json

Body

status

boolean

required

message

string

required

data

array [object {4}]

required

integer

required

city_id

integer

required

name

string

required

active

integer

required

Edit District

All Countries