All Cities

curl --location --request GET 'https://www.testecommerce.vodoerp.com/api/v1/country/cities?keyword=&sort_order=id__desc&per_page=10&page=1&all_cites=&list=&country_id&state_id' \ --header 'apikey: 5f28583f26a1a' \ --header 'apiconnection: appmobile' \ --header 'secure-business-key: 140356399db2b2c32f0.25237063' \ --header 'lang: ar'

{"status":true,"message":"Cities retrieved successfully","data":{"current_page":1,"data":[{"id":3667,"name":"fsfsfssg","country":"السعودية","state":"","status":1},{"id":3652,"name":"احد المسارحة","country":"السعودية","state":"","status":0},{"id":3542,"name":"صامطة","country":"السعودية","state":"","status":0},{"id":2777,"name":"الشماسية","country":"السعودية","state":"","status":0},{"id":2630,"name":"البكيرية","country":"السعودية","state":"","status":0},{"id":2167,"name":"صفوى","country":"السعودية","state":"","status":0},{"id":1073,"name":"الدلم","country":"السعودية","state":"","status":0},{"id":1061,"name":"الخرج","country":"السعودية","state":"","status":0},{"id":80,"name":"عنيزة","country":"السعودية","state":"","status":0},{"id":67,"name":"القطيف","country":"السعودية","state":"","status":0}],"first_page_url":"http://127.0.0.1:8000/api/v1/country/cities?page=1","from":1,"last_page":3,"last_page_url":"http://127.0.0.1:8000/api/v1/country/cities?page=3","links":[{"url":null,"label":"« Previous","active":false},{"url":"http://127.0.0.1:8000/api/v1/country/cities?page=1","label":"1","active":true},{"url":"http://127.0.0.1:8000/api/v1/country/cities?page=2","label":"2","active":false},{"url":"http://127.0.0.1:8000/api/v1/country/cities?page=3","label":"3","active":false},{"url":"http://127.0.0.1:8000/api/v1/country/cities?page=2","label":"Next »","active":false}],"next_page_url":"http://127.0.0.1:8000/api/v1/country/cities?page=2","path":"http://127.0.0.1:8000/api/v1/country/cities","per_page":10,"prev_page_url":null,"to":10,"total":23}}

Request

Query Params

keyword

string

optional

Filter by keyword

sort_order

string

optional

'id_desc',
'id_asc',
'name_ar_desc',
'name_en_asc',
'country_desc',
'country_asc',
'state_desc',
'state_asc',

Example:

id__desc

per_page

string

optional

Number of items per page.

Example:

page

string

optional

Page number for pagination.

Example:

all_cites

string

optional

get all cities

list

string

optional

Show all data without pagination.

country_id

string

optional

Filter by country (APP_URL)/api/v1/country/countries

state_id

string

optional

Filter by state (APP_URL)/api/v1/country/states

Header Params

apikey

string

required

API key for authentication; contact support to obtain.

Example:

5f28583f26a1a

apiconnection

string

required

Connection type; contact support to obtain.

Example:

appmobile

secure-business-key

string

required

Business-specific key; contact support for valid values.

Example:

140356399db2b2c32f0.25237063

lang

string

optional

Language preference: ar for Arabic, en for English.

Example:

Request

Responses