Light Mode
List Branches
GET
/branchesLast modified: 7 days ago
This endpoint allows you to list all branches related to your store directly from this endpoint.
Request
Query Params
page
integer
optional
The Pagination page number
Example:
4
is_default
boolean
optional
Whether or not this branch is the default one for all operations
Example:
true
keyword
string
optional
Search using a keyword
Example:
Main Branch
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
Example
{
"status": 200,
"success": true,
"data": [
{
"id": 1846327032,
"name": "مركز الجمال",
"status": "active",
"location": {
"lat": "30.0778",
"lng": "31.2852"
},
"street": "الرحمة",
"address_description": "123 شارع الرحمة",
"additional_number": "6666",
"building_number": "6666",
"local": "omm",
"postal_code": "66666",
"contacts": {
"phone": "+966508265874",
"whatsapp": "+966508265874",
"telephone": "012526886"
},
"preparation_time": "6",
"is_open": true,
"closest_time": null,
"working_hours": [
{
"name": "السبت",
"times": [
{
"from": "09:00",
"to": "23:55"
}
]
},
{
"name": "الأحد",
"times": [
{
"from": "09:00",
"to": "23:55"
}
]
},
{
"name": "الإثنين",
"times": [
{
"from": "09:00",
"to": "23:55"
}
]
},
{
"name": "الثلاثاء",
"times": [
{
"from": "09:00",
"to": "23:55"
}
]
},
{
"name": "الأربعاء",
"times": [
{
"from": "09:00",
"to": "23:55"
}
]
},
{
"name": "الخميس",
"times": [
{
"from": "09:00",
"to": "23:55"
}
]
},
{
"name": "الجمعة",
"times": [
{
"from": "19:00",
"to": "23:55"
}
]
}
],
"is_cod_available": true,
"is_default": true,
"type": "branch",
"cod_cost": "5.00",
"country": {
"id": 1723506348,
"name": "مصر",
"name_en": "Egypt",
"code": "EG",
"mobile_code": "+20",
"capital": null
},
"city": {
"id": 1355786303,
"name": "CAIRO",
"name_en": "CAIRO",
"country_id": 1723506348
}
},
{
"id": 1005180409,
"name": "فرع مول البستان",
"status": "active",
"location": {
"lat": "30.0778",
"lng": "31.2852"
},
"street": "اكتوبر",
"address_description": "65 حي الزعفران",
"additional_number": null,
"building_number": null,
"local": "العاشر من رمضان",
"postal_code": "564325",
"contacts": {
"phone": "",
"whatsapp": "",
"telephone": ""
},
"preparation_time": "6",
"is_open": true,
"closest_time": null,
"working_hours": [
{
"name": "السبت",
"times": [
{
"from": "09:00",
"to": "18:00"
}
]
},
{
"name": "الأحد",
"times": [
{
"from": "09:00",
"to": "18:00"
}
]
},
{
"name": "الأربعاء",
"times": [
{
"from": "06:00",
"to": "22:00"
}
]
}
],
"is_cod_available": true,
"is_default": false,
"type": "branch",
"cod_cost": "5.00",
"country": {
"id": 1723506348,
"name": "مصر",
"name_en": "Egypt",
"code": "EG",
"mobile_code": "+20"
},
"city": {
"id": 1355786303,
"name": "CAIRO",
"name_en": "CAIRO",
"country_id": 1723506348
}
}
],
"pagination": {
"count": 1,
"total": 1,
"perPage": 15,
"currentPage": 1,
"totalPages": 1,
"links": []
}
}
Last modified: 7 days ago