List Cities for Country

Retrieve a list of cities for a specific country where the store operates or delivers. The list includes each city's unique ID, name, and country details. Note that a city can be labeled as 'Other', represented by an 'أخرى' or 'Other' in the 'name' field, which typically signifies a location outside of the predefined list of cities.

🔑Scopes

countries_cities.read - Countries & Cities Read

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

A list of cities is returned

Body

Example

{
    "status": "object",
    "cities": [
        {
            "id": 1,
            "national_id": 3,
            "name": "Riyadh",
            "priority": 10,
            "country_id": 184,
            "country_name": "Saudi Arabia",
            "country_code": "SA",
            "ar_name": "الرياض",
            "en_name": "Riyadh"
        },
        {
            "id": 71,
            "national_id": 18,
            "name": "Jeddah",
            "priority": 9,
            "country_id": 184,
            "country_name": "Saudi Arabia",
            "country_code": "SA",
            "ar_name": "جدة",
            "en_name": "Jeddah"
        },
        {
            "id": 76,
            "national_id": 6,
            "name": "Makkah",
            "priority": 8,
            "country_id": 184,
            "country_name": "Saudi Arabia",
            "country_code": "SA",
            "ar_name": "مكة المكرمة",
            "en_name": "Makkah"
        },
        {
            "id": 38,
            "national_id": 14,
            "name": "Madinah",
            "priority": 7,
            "country_id": 184,
            "country_name": "Saudi Arabia",
            "country_code": "SA",
            "ar_name": "المدينة المنورة",
            "en_name": "Madinah"
        }
    ],
    "message": {
        "type": "object",
        "code": null,
        "name": null,
        "description": null
    }
}

🟠401Unauthenticated