Get Cities

Get Cities - Get cities by country ID

Use this endpoint to retrieve the list of cities available for a specific country.

The countryId must be taken from the Get All Countries endpoint.

Required URL parameter

countryId - Country ID returned from the Get All Countries endpoint.

When to use this endpoint

To get the cities covered for a selected country.
To populate city selection lists in your system or checkout flow.
To confirm whether Flype supports delivery in a specific city.

Important notes

Only cities available for the provided countryId are returned.
If the country is not covered by Flype, the API may return a message indicating that the country is not covered.
If the countryId is invalid, the API may return a country not found error.

Summary

Use Get Cities after calling Get All Countries to retrieve supported cities for a selected country.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Successful response

Body

Example

{
    "status": "success",
    "data": [
        {
            "id": 13,
            "name": "Adh Dhayd"
        },
        {
            "id": 18,
            "name": "Al Batayih"
        },
        {
            "id": 22,
            "name": "Al Hamriyah"
        }
    ]
}

🟠401

Get Cities - Get cities by country ID

Required URL parameter

When to use this endpoint

Important notes

Summary

Request

Request Code Samples

Responses

Get Cities

Get Cities - Get cities by country ID#

Required URL parameter#

When to use this endpoint#

Important notes#

Summary#

Request

Request Code Samples

Responses

Get Cities - Get cities by country ID

Required URL parameter

When to use this endpoint

Important notes

Summary