Update Branch
Update an existing branch.
Authorization
default You can retrieve your token by logging in.
In: header
Path Parameters
Header Parameters
API contract version to target. See the Changelog for what changed in each version.
"2.0.0""2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Request Body
application/json
English name. Must not be greater than 191 characters.
Arabic name. Must not be greater than 191 characters.
Branch address. Must not be greater than 500 characters.
Geographic latitude. Must be between -90 and 90.
Geographic longitude. Must be between -180 and 180.
Active status.
Kitchen active status.
Enable pay later feature.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.flavours.sa/dev/api/v2/branches/animi" \ -H "X-API-Version: 2.3.0" \ -H "Content-Type: application/json" \ -d '{ "includes": [ "doloribus" ] }'{
"meta": {
"code": 200,
"status": "success",
"message": "Branch updated successfully."
},
"data": {
"id": "eae340e8-9465-4f47-a628-e39dcafc9b82",
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"name_en": "Krajcik Group",
"name_ar": "Krajcik Group",
"address": "7832 Schuster Throughway Suite 268\nSouth Noraton, NY 48529",
"latitude": -40.315436,
"longitude": 175.352946,
"is_active": false,
"created_at": 1787446686231,
"updated_at": 1787446686428,
"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": {
"id": 3,
"market_id": "848aa3f5-fc3d-42d3-8cc9-4c6edd0140d0",
"branch_id": "eae340e8-9465-4f47-a628-e39dcafc9b82",
"is_kitchen_active": false,
"is_pay_later": true,
"invoice_prefix": null,
"zatca_otp": null,
"extension": {
"has_cleartax": false,
"has_zatca": false,
"has_qoyod": false
},
"payment": {
"has_apple": true,
"has_card": true,
"has_cash": true
},
"service": {
"has_dining": true,
"has_take_away": true
},
"active_plan": null,
"active_subscription": 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": 422,
"status": "error",
"message": "The name en must be a string. (and 3 more errors)"
},
"data": [
{
"code": 0,
"message": "The name en must be a string.",
"field": "name_en"
},
{
"code": 0,
"message": "The latitude must be a number.",
"field": "latitude"
},
{
"code": 0,
"message": "The longitude must be a number.",
"field": "longitude"
},
{
"code": 0,
"message": "The is active field must be true or false.",
"field": "is_active"
}
]
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}List Branches GET
List all branches with pagination and filtering options.
Bulk Job Error Report GET
Get a temporary download URL for the error report of a bulk job. Returns a null payload when the job produced no report, 409 while the report of a job that has just finished with errors is still being rendered, and 410 once the file has been deleted by retention.