Branch
Detail Branch
Get details of a specific branch by its ID.
Authorization
default 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 "http://localhost:8000/api/v2/branches/quia?includes=porro" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Branch retrieved successfully."
},
"data": {
"id": "370c09a0-a777-4f9d-aab1-796e5b8ce647",
"market_id": "07928d80-350c-46eb-8786-91a40ca509a0",
"name_en": "Krajcik-Wunsch",
"name_ar": "Krajcik-Wunsch",
"address": "555 Beatty Pass Suite 082\nWest Sandy, CO 94238-0868",
"latitude": 70.213047,
"longitude": -36.245717,
"is_active": true,
"created_at": 1782824834305,
"updated_at": 1782824834305,
"deleted_at": null,
"expired_at": null,
"is_online": false,
"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": [],
"waiting_orders": [],
"process_orders": [],
"canceled_orders": [],
"completed_orders": [],
"market": {
"id": "07928d80-350c-46eb-8786-91a40ca509a0",
"sector_id": 13,
"name_en": "Donnelly-Swaniawski",
"name_ar": "Donnelly-Swaniawski",
"description_en": null,
"description_ar": null,
"logo_img": "https://via.placeholder.com/200x200.png/00ffff?text=business+logo+et",
"cover_img": "https://via.placeholder.com/200x200.png/00ee66?text=business+cover+animi",
"email": "[email protected]",
"phone_prefix": "212",
"phone_number": "4769320137",
"crn": "124-313-2863",
"tax_number": "72043015227",
"created_by": null,
"email_verified_at": 1782824824410,
"phone_verified_at": 1782824824410,
"created_at": 1782824824152,
"updated_at": 1782824824152,
"deleted_at": null,
"is_active": true,
"merchant_id": null,
"reseller_id": null,
"slug": "donnelly-swaniawski",
"code": "ENT-0000000001",
"links": {
"website": null,
"instagram": null,
"youtube": null,
"x": null,
"call_center": null
},
"phone": "4769320137",
"setting": null
},
"setting": null
}
}{
"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
}