Flavours API
Branch

Detail Branch

GET
/api/v2/branches/{branchId}

Get details of a specific branch by its ID.

AuthorizationBearer <token>

You can retrieve your token by logging in.

In: header

Path Parameters

branchId*string

Query Parameters

includes*array<>

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.flavours.sa/dev/api/v2/branches/animi?includes=qui" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Branch retrieved successfully."
  },
  "data": {
    "id": "eae340e8-9465-4f47-a628-e39dcafc9b82",
    "market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
    "name_en": "Kilback Ltd",
    "name_ar": "Kilback Ltd",
    "address": "225 Evelyn Groves\nLindberg, VA 36666",
    "latitude": 82.740279,
    "longitude": 39.163517,
    "is_active": true,
    "created_at": 1787446686231,
    "updated_at": 1787446686231,
    "deleted_at": null,
    "expired_at": null,
    "is_online": false,
    "code": "BR-591808",
    "level": null,
    "shift": null,
    "days": {
      "SUN": 0,
      "MON": 0,
      "TUE": 0,
      "WED": 0,
      "THU": 0,
      "FRI": 0,
      "SAT": 0
    },
    "location": null,
    "plans": [],
    "schedules": [],
    "out_of_stock_products": [],
    "market": {
      "id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
      "sector_id": 10,
      "name_en": "Kunde Ltd",
      "name_ar": "Kunde Ltd",
      "description_en": null,
      "description_ar": null,
      "logo_img": "https://via.placeholder.com/200x200.png/006655?text=business+logo+quidem",
      "cover_img": "https://via.placeholder.com/200x200.png/00cc77?text=business+cover+dolorem",
      "email": "[email protected]",
      "phone_prefix": "973",
      "phone_number": "7148591204",
      "crn": "030-077-7963",
      "tax_number": "90476326386",
      "created_by": null,
      "email_verified_at": 1787446674909,
      "phone_verified_at": 1787446674909,
      "created_at": 1787446674760,
      "updated_at": 1787446674760,
      "deleted_at": null,
      "is_active": true,
      "merchant_id": null,
      "reseller_id": null,
      "slug": "kunde-ltd",
      "code": "ENT-0000000001",
      "links": {
        "website": null,
        "instagram": null,
        "youtube": null,
        "x": null,
        "call_center": null
      },
      "phone": "7148591204",
      "setting": null
    },
    "setting": null,
    "waiting_orders": [],
    "process_orders": [],
    "canceled_orders": [],
    "completed_orders": []
  }
}
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}