Skip to main content

Branches

Get Branches

The Get Store Branches API allows you to retrieve a list of store branches along with their respective addresses. This information is useful for users who want to find the nearest store location.

  • Endpoint: api/customer/branches

  • Method: GET

  • Success Response:

KeyTypeDescription
typeStringThe category to which the branch group belongs.
nameStringThe name of the branch group in English.
name_arStringThe name of the branch group in Arabic.
sub_branchesArrayA collection of branches within this group. You can check more details about Branch Resource.

{
"code": 200,
"message": "Success",
"data": [
{
"type": "Stores",
"name": "Stores",
"name_ar": "Stores",
"sub_branches": [
{
"id": 1,
"shop_name": "Branch 1",
"shop_name_ar": "فرع 1",
"address": "Address 1",
"address_ar": "العنوان 1",
"area": "Area 1",
"area_ar": "المنطقة 1",
"lat": "24.713552",
"lng": "46.675296",
"phone": [
"123456789"
],
"images": [],
"email": ".",
"type": "Stores",
"order": 1,
"active": 1,
"direction_link": ""
}
]
}
]
}
info

Check the following section to learn more about the Get Branches Reference