Salla Docs
List Branches
GET/branchesThis endpoint allows you to list all branches related to your store directly from this endpoint.
Request
The Pagination page number
Whether or not this branch is the default one for all operations
Search using a keyword
Request samples
[api.label.responses]
Response status code, a numeric or alphanumeric identifier used to convey the outcome or status of a request, operation, or transaction in various systems and applications, typically indicating whether the action was successful, encountered an error, or resulted in a specific condition.
Response flag, boolean indicator used to signal a particular condition or state in the response of a system or application, often representing the presence or absence of certain conditions or outcomes.
The unique identifier of a branch.
The label given to a specific branch. 🌐 Support multi-language
The current operational condition of a location, indicating whether it is "Active" as open for business or "Inactive" as closed.
Branch's location on map in both longitude and latitude
Branch's Street Name. 🌐 Support multi-language
Branch's Address Description. 🌐 Support multi-language
Branch's Additional (alternative) phone number.
Branch's Building Number.
Branch's Local district. 🌐 Support multi-language
Branch's Postal Code. Value length is 5 characters long.
Branch's contacts details.
The time required for the branch to get an order ready for shipping or pickup.
Whether or not the branch is currently open or closed
The time when the branch will be closed based on the request time. Each request may have a different value.
Branch working hours. Required if branch.type is "branch"
Whether or not Cash on delivery available.
Whether or not this branch is the default branch for all operations.
Branch type, either a standard branch or warehouse
Cash on delivery cost value
Detailed structure of the country model object showing its fields and data types.
Detailed structure of the city model object showing its fields and data types.
For a better response behavior as well as maintain the best security level, All retrieving API endpoints use a mechanism to retrieve data in chunks called pagination. Pagination working by return only a specific number of records in each response, and through passing the page number you can navigate the different pages.
Number of returned results.
Number of all results.
Number of results per page.
Number of current page.
Number of total pages.
Array of linkes to next and previous pages.
{
"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": []
}
}