# Branches
The Branch in Ristecho is one of the main configuration points in the account. Within a branch, you can assign licenses, track sales and inventory transactions, manage tables, delivery zones, assign taxes and much more.
# The Branch Object
# Sample
{
"data": [
{
"tags": [
{
"id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139",
"type": 2,
"name": "Cairo Branch",
"name_localized": null,
"created_at": "2022-02-20 14:17:54",
"updated_at": "2022-02-20 14:17:54",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"tag_id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139"
}
}
],
"charges": [
{
"id": "95b6c481-84d0-47dd-9904-114ef3d54a1d",
"name": "Order Charge",
"name_localized": "OR-01",
"type": 2,
"is_auto_applied": false,
"order_types": [
1
],
"value": 8,
"is_open_charge": false,
"created_at": "2022-03-01 08:08:54",
"updated_at": "2022-05-18 22:22:31",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"charge_id": "95b6c481-84d0-47dd-9904-114ef3d54a1d"
}
}
],
"users": [
{
"pin": "*****",
"is_owner": false,
"id": "95a52612-36dd-4268-9640-e5ef0a995e44",
"name": "Jack",
"number": "2",
"email": "jack@Ristecho.com",
"phone": "010000000000",
"lang": "en",
"display_localized_names": true,
"email_verified": false,
"must_use_fingerprint": true,
"last_console_login_at": null,
"last_cashier_login_at": null,
"created_at": "2022-02-20 13:56:48",
"updated_at": "2022-05-15 13:47:26",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"user_id": "95a52612-36dd-4268-9640-e5ef0a995e44"
}
}
],
"delivery_zones": [
{
"id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9",
"name": "Cairo zone",
"name_localized": "cairozone",
"coordinates": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "LineString",
"coordinates": [
[
30.83175659179687,
30.04532159026885
],
[
31.41815185546875,
30.24364554820945
],
[
31.62002563476562,
30.053642570466103
],
[
31.52938842773437,
29.903758071027735
],
[
31.14761352539062,
29.976349445485468
],
[
30.94161987304687,
29.900186637177384
],
[
30.8331298828125,
30.033433263128995
]
]
},
"properties": []
}
]
},
"reference": "cairo1743",
"created_at": "2022-03-01 08:15:19",
"updated_at": "2022-05-18 21:58:19",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"delivery_zone_id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9"
}
}
],
"discounts": [
{
"id": "95a52911-c86b-401e-b485-822198b30aea",
"name": "Customer_Discount",
"name_localized": null,
"qualification": 1,
"amount": 10,
"minimum_product_price": 8,
"minimum_order_price": null,
"maximum_amount": 10,
"is_percentage": true,
"is_taxable": true,
"order_types": [
1,
2,
3,
4
],
"reference": "discount",
"created_at": "2022-02-20 14:05:11",
"updated_at": "2022-06-02 07:03:35",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95a52911-c86b-401e-b485-822198b30aea"
}
}
],
"timed_events": [
{
"id": "95b6cb44-d848-42c7-bbba-985d6b9327d2",
"name": "Breakfast Event",
"name_localized": null,
"type": 3,
"value": 50,
"priority": null,
"order_types": [
1,
2,
3,
4
],
"from_date": "2022-03-01",
"to_date": "2022-06-15",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"created_at": "2022-03-01 08:27:48",
"updated_at": "2022-05-26 07:31:21",
"deleted_at": null
}
],
"promotions": [
{
"id": "95c34e88-1c04-42ad-90e5-86511d7c8e93",
"name": "Promotion discount",
"name_localized": null,
"type": 1,
"priority": 1,
"from_date": "2022-03-06",
"to_date": "2022-03-10",
"from_time": 0,
"to_time": 23,
"is_sat": false,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": false,
"is_thu": false,
"is_fri": false,
"is_active": true,
"include_modifiers": true,
"target_quantity": 10,
"condition_type": 1,
"reward_type": 1,
"reward_quantity": null,
"reward_amount": 10,
"maximum_discount_amount": 50,
"order_types": [
1
],
"created_at": "2022-03-07 13:44:47",
"updated_at": "2022-05-20 23:44:47",
"deleted_at": null
}
],
"tax_group": {
"id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "Branch1",
"name_localized": null,
"reference": "vat",
"created_at": "2022-02-20 14:32:36",
"updated_at": "2022-02-20 14:32:36",
"deleted_at": null
},
"products": [
{
"pivot": {
"price": null,
"is_active": false,
"is_in_stock": true
},
"id": "9598e060-6acc-4a1b-b52c-c59cbd5a1b8c",
"sku": "sk-0001",
"barcode": null,
"name": "Pepsi",
"name_localized": null,
"description": "Pepsiii",
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": 1,
"price": 4,
"cost": null,
"calories": 300,
"created_at": "2022-02-14 11:31:59",
"updated_at": "2022-03-20 10:10:29",
"deleted_at": null
}
],
"combos": [],
"devices": [
{
"in_use": true,
"code": "*****",
"id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
"name": "Cashier 1",
"reference": "C01",
"type": 1,
"latitude": null,
"longitude": null,
"model": "iPad12,1",
"build": "273",
"app_version": "5.0.33.sandbox",
"system_version": "iOS 15.1",
"settings": {
"till_report_email": "jack@Ristecho.com",
"default_order_tags": [],
"shift_report_email": "jack@Ristecho.com",
"kitchen_print_language": "3",
"cashier_assigned_tables": [
"95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
"95ed1bc6-766d-4d68-b369-2d82faf2ea07"
],
"end_of_day_report_email": "jack@Ristecho.com",
"cashier_reset_order_number_at": 1000,
"cashier_start_order_number_at": 100,
"ahead_order_reminder_in_minutes": 0,
"print_online_order_when_received": true,
"auto_accept_and_send_online_orders_to_kitchen": true
},
"local_settings": {
"peripherals": {
"kdses": [],
"scales": [],
"cashiers": [],
"displays": [],
"printers": [],
"notifiers": [],
"payment_terminals": [],
"finger_print_scanners": []
},
"tables_configs": [
{
"table_id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
"x_coordinate": 23,
"y_coordinate": 2
},
{
"table_id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
"x_coordinate": 21,
"y_coordinate": 12
},
{
"table_id": "95ed1bc6-8d62-46eb-98ae-9ce4050ae8d9",
"x_coordinate": 13,
"y_coordinate": 2
},
{
"table_id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
"x_coordinate": 24,
"y_coordinate": 5
},
{
"table_id": "95ed1b7d-6411-4332-b14e-da966f3dc65b",
"x_coordinate": 0,
"y_coordinate": 10
},
{
"table_id": "95ed1bc6-815f-4c1d-b123-fe737be77224",
"x_coordinate": 4,
"y_coordinate": 2
},
{
"table_id": "95ed1b7d-59f1-4c4b-97d1-b694f1d2a2aa",
"x_coordinate": 10,
"y_coordinate": 11
},
{
"table_id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
"x_coordinate": 11,
"y_coordinate": 2
}
]
},
"is_online_receiver": true,
"first_activation_at": "2022-05-31 13:25:01",
"last_sync_at": "2022-06-29 21:15:01",
"last_seen_at": "2022-06-29 21:18:53",
"last_order_at": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-06-29 21:18:56",
"deleted_at": null,
"is_blocked": false
}
],
"modifier_options": [],
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null,
"sections": [
{
"id": "95ed1b7b-470d-4126-825e-94637cece995",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "open air section",
"name_localized": null,
"created_at": "2022-03-28 08:26:48",
"updated_at": "2022-03-28 08:26:48",
"deleted_at": null,
"tables": [
{
"id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 4",
"status": 1,
"seats": 4,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 08:27:05",
"deleted_at": null,
"accepts_reservations": false
},
{
"id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 2",
"status": 2,
"seats": 3,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 10:12:24",
"deleted_at": null,
"accepts_reservations": false
},
{
"id": "95ed1b7d-59f1-4c4b-97d1-b694f1d2a2aa",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 3",
"status": 1,
"seats": 5,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 08:27:13",
"deleted_at": null,
"accepts_reservations": false
},
{
"id": "95ed1b7d-6411-4332-b14e-da966f3dc65b",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 5",
"status": 1,
"seats": 2,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 08:27:17",
"deleted_at": null,
"accepts_reservations": false
},
{
"id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 1",
"status": 1,
"seats": 5,
"created_at": "2022-03-28 08:26:50",
"updated_at": "2022-03-28 10:43:36",
"deleted_at": null,
"accepts_reservations": false
}
]
},
{
"id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "In-door section",
"name_localized": null,
"created_at": "2022-03-28 08:27:36",
"updated_at": "2022-03-28 08:27:36",
"deleted_at": null,
"tables": [
{
"id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
"section_id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"name": "New Table 2",
"status": 2,
"seats": 3,
"created_at": "2022-03-28 08:27:37",
"updated_at": "2022-05-25 11:34:24",
"deleted_at": null,
"accepts_reservations": false
},
{
"id": "95ed1bc6-815f-4c1d-b123-fe737be77224",
"section_id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"name": "New Table 3",
"status": 1,
"seats": 6,
"created_at": "2022-03-28 08:27:37",
"updated_at": "2022-05-11 13:59:12",
"deleted_at": null,
"accepts_reservations": false
},
{
"id": "95ed1bc6-8d62-46eb-98ae-9ce4050ae8d9",
"section_id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"name": "New Table 1",
"status": 1,
"seats": 1,
"created_at": "2022-03-28 08:27:37",
"updated_at": "2022-05-09 10:59:09",
"deleted_at": null,
"accepts_reservations": false
}
]
}
]
}
]
}
# Attributes
| Field | Type | Rules | Description |
|---|---|---|---|
id | string | Unique identifier for the branch. | |
name* | string | updatable | Name of the branch. |
name_localized | string | nullable updatable | Localized name of the branch. |
reference* | string | updatable | User friendly unique identifier for the branch. |
latitude | string | nullable updatable | Latitude of the branch. |
longitude | string | nullable updatable | Longitude of the branch. |
phone | string | nullable updatable | Phone of the branch. |
opening_from | string | updatable | The opening hour of the branch. |
opening_to | string | updatable | The closing hour of the branch. |
accepts_reservations | boolean | updatable | True if the branch accepts reservations |
address | string | updatable nullable | Branch address |
receipt_footer | string | updatable nullable | Branch receipt footer |
receipt_header | string | updatable nullable | Branch receipt header |
reservation_duration | integer | updatable | The predefined duration for a single reservation in minutes |
reservation_times | object | updatable nullable | The details for the reservation start and end times for each week day |
settings | object | updatable | Branch settings |
Type | integer | Branch type | |
inventory_end_of_day_time | string | updatable | The time YYYY-MM-DD for inventory end of day. |
receives_online_orders | boolean | updatable | If true, branch will be able to receive online (API) orders |
tax_group | object | nullable updatable includable | The Tax Group object attached to the branch. |
products | array | updatable includable | List of Products objects attached to the branch. |
modifier_options | array | updatable includable | List of Modifier Options objects attached to the branch. |
combos | array | updatable includable | List of Combos objects attached to the branch. |
tags | array | updatable includable | List of Tag objects attached to the branch. |
users | array | updatable includable | List of User objects attached to the branch. |
delivery_zones | array | updatable includable | List of Delivery Zone objects attached to the branch. |
discounts | array | updatable includable | List of Discount objects attached to the branch. |
timed_events | array | updatable includable | List of Timed Event objects attached to the branch. |
promotions | array | updatable includable | List of Promotion objects attached to the branch. |
charges | array | includable | List of Charges objects attached to the branch. |
sections | array | includable | List of Section objects attached to the branch. |
sections.tables | array | includable | List of Tables added to a section attached to the branch. |
Devices | array | includable | List of Devices attached to the branch. |
created_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the branch was created. |
updated_at | string | sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the branch was updated. |
deleted_at | string | nullable sortable | Time YYYY-MM-DD HH-MM-SS in UTC at which the branch was deleted. |
# List Branches
GET /branches
# Scope
general.read
# Filters
idnamename_localizedreferencetax_group_idusers.idtags.iddelivery_zones.iddiscounts.idtimed_events.idpromotions.idupdated_afteris_deletedcreated_onupdated_ondeleted_on
# Response
{
"data": [
{
"tags": [
{
"id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139",
"type": 2,
"name": "Branch-01",
"name_localized": null,
"created_at": "2022-02-20 14:17:54",
"updated_at": "2022-02-20 14:17:54",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"tag_id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139"
}
}
],
"charges": [
{
"id": "95b6c481-84d0-47dd-9904-114ef3d54a1d",
"name": "Order Charge",
"name_localized": "OR-01",
"type": 2,
"is_auto_applied": false,
"order_types": [
1
],
"value": 8,
"is_open_charge": false,
"created_at": "2022-03-01 08:08:54",
"updated_at": "2022-05-18 22:22:31",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"charge_id": "95b6c481-84d0-47dd-9904-114ef3d54a1d"
}
}
],
"users": [
{
"pin": "*****",
"is_owner": false,
"id": "95a52612-36dd-4268-9640-e5ef0a995e44",
"name": "Jack",
"number": "2",
"email": "jack@Ristecho.com",
"phone": "12345678",
"lang": "en",
"display_localized_names": true,
"email_verified": false,
"must_use_fingerprint": true,
"last_console_login_at": null,
"last_cashier_login_at": null,
"created_at": "2022-02-20 13:56:48",
"updated_at": "2022-05-15 13:47:26",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"user_id": "95a52612-36dd-4268-9640-e5ef0a995e44"
}
}
],
"delivery_zones": [
{
"id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9",
"name": "Riyadh zone",
"name_localized": "riyadhzone",
"coordinates": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "LineString",
"coordinates": [
[
30.83175659179687,
30.04532159026885
],
[
31.41815185546875,
30.24364554820945
],
[
31.62002563476562,
30.053642570466103
],
[
31.52938842773437,
29.903758071027735
],
[
31.14761352539062,
29.976349445485468
],
[
30.94161987304687,
29.900186637177384
],
[
30.8331298828125,
30.033433263128995
]
]
},
"properties": []
}
]
},
"reference": "riyadh-01",
"created_at": "2022-03-01 08:15:19",
"updated_at": "2022-05-18 21:58:19",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"delivery_zone_id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9"
}
}
],
"discounts": [
{
"id": "95a52911-c86b-401e-b485-822198b30aea",
"name": "Customer_Discount",
"name_localized": null,
"qualification": 1,
"amount": 10,
"minimum_product_price": 50,
"minimum_order_price": 100,
"maximum_amount": 50,
"is_percentage": true,
"is_taxable": true,
"order_types": [
1,
2,
3,
4
],
"reference": "discount",
"created_at": "2022-02-20 14:05:11",
"updated_at": "2022-02-20 14:05:55",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95a52911-c86b-401e-b485-822198b30aea"
}
}
],
"timed_events": [
{
"id": "95b6cb44-d848-42c7-bbba-985d6b9327d2",
"name": "Breakfast Event",
"name_localized": null,
"type": 3,
"value": 50,
"priority": null,
"order_types": [
1,
2,
3,
4
],
"from_date": "2022-03-01",
"to_date": "2022-03-31",
"from_time": 9,
"to_time": 14,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"created_at": "2022-03-01 08:27:48",
"updated_at": "2022-05-19 07:40:34",
"deleted_at": null
}
],
"promotions": [
{
"id": "95c34e88-1c04-42ad-90e5-86511d7c8e93",
"name": "Promotion discount",
"name_localized": null,
"type": 2,
"priority": 1,
"from_date": "2022-03-06",
"to_date": "2022-03-10",
"from_time": 0,
"to_time": 23,
"is_sat": false,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": false,
"is_thu": false,
"is_fri": false,
"is_active": true,
"include_modifiers": true,
"target_quantity": 10,
"condition_type": 1,
"reward_type": 3,
"reward_quantity": null,
"reward_amount": 10,
"maximum_discount_amount": 50,
"order_types": [
1
],
"created_at": "2022-03-07 13:44:47",
"updated_at": "2022-05-19 14:12:47",
"deleted_at": null
}
],
"tax_group": {
"id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "Branch1",
"name_localized": null,
"reference": "vat",
"created_at": "2022-02-20 14:32:36",
"updated_at": "2022-02-20 14:32:36",
"deleted_at": null
},
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null,
"sections": [
{
"id": "95ed1b7b-470d-4126-825e-94637cece995",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "open air section",
"name_localized": null,
"created_at": "2022-03-28 08:26:48",
"updated_at": "2022-03-28 08:26:48",
"deleted_at": null,
"tables": [
{
"id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 4",
"status": 1,
"seats": 4,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 08:27:05",
"deleted_at": null,
"accepts_reservations": false
},
{
"id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 2",
"status": 2,
"seats": 3,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 10:12:24",
"deleted_at": null,
"accepts_reservations": false
}
]
},
{
"id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "In-door section",
"name_localized": null,
"created_at": "2022-03-28 08:27:36",
"updated_at": "2022-03-28 08:27:36",
"deleted_at": null,
"tables": [
{
"id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
"section_id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"name": "New Table 2",
"status": 1,
"seats": 3,
"created_at": "2022-03-28 08:27:37",
"updated_at": "2022-05-09 10:59:09",
"deleted_at": null,
"accepts_reservations": false
}
]
}
]
}
]
}
# Get Branch
GET /branches/{branchId}
# Scope
general.read
# Response
{
"data": {
"tags": [
{
"id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139",
"type": 2,
"name": "Cairo Branch",
"name_localized": null,
"created_at": "2022-02-20 14:17:54",
"updated_at": "2022-02-20 14:17:54",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"tag_id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139"
}
}
],
"charges": [
{
"id": "95b6c481-84d0-47dd-9904-114ef3d54a1d",
"name": "Order Charge",
"name_localized": "OR-01",
"type": 2,
"is_auto_applied": false,
"order_types": [
1
],
"value": 8,
"is_open_charge": false,
"created_at": "2022-03-01 08:08:54",
"updated_at": "2022-05-18 22:22:31",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"charge_id": "95b6c481-84d0-47dd-9904-114ef3d54a1d"
}
}
],
"users": [
{
"pin": "*****",
"is_owner": false,
"id": "95a52612-36dd-4268-9640-e5ef0a995e44",
"name": "jack",
"number": "2",
"email": "jack@Ristecho.com",
"phone": "010000000000",
"lang": "en",
"display_localized_names": true,
"email_verified": false,
"must_use_fingerprint": true,
"last_console_login_at": null,
"last_cashier_login_at": null,
"created_at": "2022-02-20 13:56:48",
"updated_at": "2022-05-15 13:47:26",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"user_id": "95a52612-36dd-4268-9640-e5ef0a995e44"
}
}
],
"delivery_zones": [
{
"id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9",
"name": "Cairo zone",
"name_localized": "cairozone",
"coordinates": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "LineString",
"coordinates": [
[
30.83175659179687,
30.04532159026885
],
[
31.41815185546875,
30.24364554820945
],
[
31.62002563476562,
30.053642570466103
],
[
31.52938842773437,
29.903758071027735
],
[
31.14761352539062,
29.976349445485468
],
[
30.94161987304687,
29.900186637177384
],
[
30.8331298828125,
30.033433263128995
]
]
},
"properties": []
}
]
},
"reference": "cairo1743",
"created_at": "2022-03-01 08:15:19",
"updated_at": "2022-05-18 21:58:19",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"delivery_zone_id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9"
}
}
],
"discounts": [
{
"id": "95a52911-c86b-401e-b485-822198b30aea",
"name": "Customer_Discount",
"name_localized": null,
"qualification": 1,
"amount": 10,
"minimum_product_price": 8,
"minimum_order_price": null,
"maximum_amount": 10,
"is_percentage": true,
"is_taxable": true,
"order_types": [
1,
2,
3,
4
],
"reference": "discount",
"created_at": "2022-02-20 14:05:11",
"updated_at": "2022-06-02 07:03:35",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95a52911-c86b-401e-b485-822198b30aea"
}
},
{
"id": "95a52a23-d507-42b8-b287-c64ea88a3c38",
"name": "order_discount",
"name_localized": null,
"qualification": 2,
"amount": 3,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": null,
"is_percentage": false,
"is_taxable": true,
"order_types": [
1,
2,
3,
4
],
"reference": "discount1",
"created_at": "2022-02-20 14:08:11",
"updated_at": "2022-02-20 14:08:11",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95a52a23-d507-42b8-b287-c64ea88a3c38"
}
},
{
"id": "95c35186-920f-4264-a75b-5dc7e33bade7",
"name": "new discount",
"name_localized": "d-01",
"qualification": 3,
"amount": 20,
"minimum_product_price": 40,
"minimum_order_price": 100,
"maximum_amount": 50,
"is_percentage": true,
"is_taxable": false,
"order_types": [
1
],
"reference": "id-01",
"created_at": "2022-03-07 13:53:09",
"updated_at": "2022-05-19 11:57:37",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95c35186-920f-4264-a75b-5dc7e33bade7"
}
},
{
"id": "9629db45-fc0a-4d95-aa2b-40169fd0f636",
"name": "100%discount",
"name_localized": null,
"qualification": 3,
"amount": 100,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": 1000,
"is_percentage": true,
"is_taxable": false,
"order_types": [
1,
2,
3,
4
],
"reference": null,
"created_at": "2022-04-27 13:12:46",
"updated_at": "2022-04-27 13:12:46",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "9629db45-fc0a-4d95-aa2b-40169fd0f636"
}
},
{
"id": "9671d321-eea4-4f42-837d-bde5148dd958",
"name": "Discounttt",
"name_localized": null,
"qualification": 3,
"amount": 11,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": 11,
"is_percentage": true,
"is_taxable": false,
"order_types": [
1,
2,
3,
4
],
"reference": null,
"created_at": "2022-06-02 07:49:36",
"updated_at": "2022-06-02 07:49:36",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "9671d321-eea4-4f42-837d-bde5148dd958"
}
}
],
"timed_events": [
{
"id": "95b6cb44-d848-42c7-bbba-985d6b9327d2",
"name": "Breakfast Event",
"name_localized": null,
"type": 3,
"value": 50,
"priority": null,
"order_types": [
1,
2,
3,
4
],
"from_date": "2022-03-01",
"to_date": "2022-06-15",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"created_at": "2022-03-01 08:27:48",
"updated_at": "2022-05-26 07:31:21",
"deleted_at": null
}
],
"promotions": [
{
"id": "95c34e88-1c04-42ad-90e5-86511d7c8e93",
"name": "Promotion discount",
"name_localized": null,
"type": 1,
"priority": 1,
"from_date": "2022-03-06",
"to_date": "2022-03-10",
"from_time": 0,
"to_time": 23,
"is_sat": false,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": false,
"is_thu": false,
"is_fri": false,
"is_active": true,
"include_modifiers": true,
"target_quantity": 10,
"condition_type": 1,
"reward_type": 1,
"reward_quantity": null,
"reward_amount": 10,
"maximum_discount_amount": 50,
"order_types": [
1
],
"created_at": "2022-03-07 13:44:47",
"updated_at": "2022-05-20 23:44:47",
"deleted_at": null
}
],
"tax_group": {
"id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "Branch1",
"name_localized": null,
"reference": "vat",
"created_at": "2022-02-20 14:32:36",
"updated_at": "2022-02-20 14:32:36",
"deleted_at": null
},
"products": [
{
"pivot": {
"price": null,
"is_active": false,
"is_in_stock": true
},
"id": "9598e060-6acc-4a1b-b52c-c59cbd5a1b8c",
"sku": "sk-0001",
"barcode": null,
"name": "Pepsi",
"name_localized": null,
"description": "Pepsiii",
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": 1,
"price": 4,
"cost": null,
"calories": 300,
"created_at": "2022-02-14 11:31:59",
"updated_at": "2022-03-20 10:10:29",
"deleted_at": null
},
{
"pivot": {
"price": null,
"is_active": false,
"is_in_stock": true
},
"id": "964789d3-6a21-4f50-8cf1-260768b53418",
"sku": "sk-0018",
"barcode": null,
"name": "Cheese cake",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 1,
"selling_method": 2,
"costing_method": 2,
"preparation_time": null,
"price": 10,
"cost": null,
"calories": null,
"created_at": "2022-05-12 07:19:51",
"updated_at": "2022-06-07 10:03:47",
"deleted_at": null
}
],
"combos": [],
"devices": [
{
"in_use": true,
"code": "*****",
"id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
"name": "Cashier 1",
"reference": "C01",
"type": 1,
"latitude": null,
"longitude": null,
"model": "iPad12,1",
"build": "273",
"app_version": "5.0.33.sandbox",
"system_version": "iOS 15.1",
"settings": {
"till_report_email": "jack@Ristecho.com",
"default_order_tags": [],
"shift_report_email": "jack@Ristecho.com",
"kitchen_print_language": "3",
"cashier_assigned_tables": [
"95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
"95ed1bc6-766d-4d68-b369-2d82faf2ea07"
],
"end_of_day_report_email": "jack@Ristecho.com",
"cashier_reset_order_number_at": 1000,
"cashier_start_order_number_at": 100,
"ahead_order_reminder_in_minutes": 0,
"print_online_order_when_received": true,
"auto_accept_and_send_online_orders_to_kitchen": true
},
"local_settings": {
"peripherals": {
"kdses": [],
"scales": [],
"cashiers": [],
"displays": [],
"printers": [],
"notifiers": [],
"payment_terminals": [],
"finger_print_scanners": []
},
"tables_configs": [
{
"table_id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
"x_coordinate": 23,
"y_coordinate": 2
},
{
"table_id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
"x_coordinate": 21,
"y_coordinate": 12
},
{
"table_id": "95ed1bc6-8d62-46eb-98ae-9ce4050ae8d9",
"x_coordinate": 13,
"y_coordinate": 2
},
{
"table_id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
"x_coordinate": 24,
"y_coordinate": 5
},
{
"table_id": "95ed1b7d-6411-4332-b14e-da966f3dc65b",
"x_coordinate": 0,
"y_coordinate": 10
},
{
"table_id": "95ed1bc6-815f-4c1d-b123-fe737be77224",
"x_coordinate": 4,
"y_coordinate": 2
},
{
"table_id": "95ed1b7d-59f1-4c4b-97d1-b694f1d2a2aa",
"x_coordinate": 10,
"y_coordinate": 11
},
{
"table_id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
"x_coordinate": 11,
"y_coordinate": 2
}
]
},
"is_online_receiver": true,
"first_activation_at": "2022-05-31 13:25:01",
"last_sync_at": "2022-06-29 21:15:01",
"last_seen_at": "2022-06-29 21:18:53",
"last_order_at": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-06-29 21:18:56",
"deleted_at": null,
"is_blocked": false
}
],
"modifier_options": [],
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null,
"sections": [
{
"id": "95ed1b7b-470d-4126-825e-94637cece995",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "open air section",
"name_localized": null,
"created_at": "2022-03-28 08:26:48",
"updated_at": "2022-03-28 08:26:48",
"deleted_at": null,
"tables": [
{
"id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 4",
"status": 1,
"seats": 4,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 08:27:05",
"deleted_at": null,
"accepts_reservations": false
}
]
},
{
"id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "In-door section",
"name_localized": null,
"created_at": "2022-03-28 08:27:36",
"updated_at": "2022-03-28 08:27:36",
"deleted_at": null,
"tables": [
{
"id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
"section_id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"name": "New Table 2",
"status": 2,
"seats": 3,
"created_at": "2022-03-28 08:27:37",
"updated_at": "2022-05-25 11:34:24",
"deleted_at": null,
"accepts_reservations": false
}
]
}
]
}
}
# Update Branch
POST /branches/{branchId}
# Scope
admin.write
# Request
{
"name": "Branch B01",
"name_localized": "الفرع الأول",
"reference": "B123",
"latitude": "24.28634",
"longitude": "46.126569",
"phone": "118254555",
"opening_from": "08:00",
"opening_to": "00:00",
"inventory_end_of_day_time": "03:00",
"tax_group_id": "8d161995",
"receives_online_orders": true,
"tags": [
{
"id": "8d06aaa0"
}
],
"users": [
{
"id": "8d06aaa0"
}
],
"delivery_zones": [
{
"id": "8d06aaa0"
}
],
"discounts": [
{
"id": "8d06aaa0"
}
],
"timed_events": [
{
"id": "8d06aaa0"
}
],
"promotions": [
{
"id": "8d06aaa0"
}
]
}
# Response
{
"data": {
"tags": [
{
"id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139",
"type": 2,
"name": "Cairo Branch",
"name_localized": null,
"created_at": "2022-02-20 14:17:54",
"updated_at": "2022-02-20 14:17:54",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"tag_id": "95a52d9d-6b15-4468-bbc4-ed5fc78ce139"
}
}
],
"charges": [
{
"id": "95b6c481-84d0-47dd-9904-114ef3d54a1d",
"name": "Order Charge",
"name_localized": "OR-01",
"type": 2,
"is_auto_applied": false,
"order_types": [
1
],
"value": 8,
"is_open_charge": false,
"created_at": "2022-03-01 08:08:54",
"updated_at": "2022-05-18 22:22:31",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"charge_id": "95b6c481-84d0-47dd-9904-114ef3d54a1d"
}
}
],
"users": [
{
"pin": "*****",
"is_owner": false,
"id": "95a52612-36dd-4268-9640-e5ef0a995e44",
"name": "jack",
"number": "2",
"email": "jack@Ristecho.com",
"phone": "010000000000",
"lang": "en",
"display_localized_names": true,
"email_verified": false,
"must_use_fingerprint": true,
"last_console_login_at": null,
"last_cashier_login_at": null,
"created_at": "2022-02-20 13:56:48",
"updated_at": "2022-05-15 13:47:26",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"user_id": "95a52612-36dd-4268-9640-e5ef0a995e44"
}
}
],
"delivery_zones": [
{
"id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9",
"name": "Cairo zone",
"name_localized": "cairozone",
"coordinates": {
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "LineString",
"coordinates": [
[
30.83175659179687,
30.04532159026885
],
[
31.41815185546875,
30.24364554820945
],
[
31.62002563476562,
30.053642570466103
],
[
31.52938842773437,
29.903758071027735
],
[
31.14761352539062,
29.976349445485468
],
[
30.94161987304687,
29.900186637177384
],
[
30.8331298828125,
30.033433263128995
]
]
},
"properties": []
}
]
},
"reference": "cairo1743",
"created_at": "2022-03-01 08:15:19",
"updated_at": "2022-05-18 21:58:19",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"delivery_zone_id": "95b6c6ce-0905-42a5-aa52-a1c6ab5935a9"
}
}
],
"discounts": [
{
"id": "95a52911-c86b-401e-b485-822198b30aea",
"name": "Customer_Discount",
"name_localized": null,
"qualification": 1,
"amount": 10,
"minimum_product_price": 8,
"minimum_order_price": null,
"maximum_amount": 10,
"is_percentage": true,
"is_taxable": true,
"order_types": [
1,
2,
3,
4
],
"reference": "discount",
"created_at": "2022-02-20 14:05:11",
"updated_at": "2022-06-02 07:03:35",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95a52911-c86b-401e-b485-822198b30aea"
}
},
{
"id": "95a52a23-d507-42b8-b287-c64ea88a3c38",
"name": "order_discount",
"name_localized": null,
"qualification": 2,
"amount": 3,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": null,
"is_percentage": false,
"is_taxable": true,
"order_types": [
1,
2,
3,
4
],
"reference": "discount1",
"created_at": "2022-02-20 14:08:11",
"updated_at": "2022-02-20 14:08:11",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95a52a23-d507-42b8-b287-c64ea88a3c38"
}
},
{
"id": "95c35186-920f-4264-a75b-5dc7e33bade7",
"name": "new discount",
"name_localized": "d-01",
"qualification": 3,
"amount": 20,
"minimum_product_price": 40,
"minimum_order_price": 100,
"maximum_amount": 50,
"is_percentage": true,
"is_taxable": false,
"order_types": [
1
],
"reference": "id-01",
"created_at": "2022-03-07 13:53:09",
"updated_at": "2022-05-19 11:57:37",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "95c35186-920f-4264-a75b-5dc7e33bade7"
}
},
{
"id": "9629db45-fc0a-4d95-aa2b-40169fd0f636",
"name": "100%discount",
"name_localized": null,
"qualification": 3,
"amount": 100,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": 1000,
"is_percentage": true,
"is_taxable": false,
"order_types": [
1,
2,
3,
4
],
"reference": null,
"created_at": "2022-04-27 13:12:46",
"updated_at": "2022-04-27 13:12:46",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "9629db45-fc0a-4d95-aa2b-40169fd0f636"
}
},
{
"id": "9671d321-eea4-4f42-837d-bde5148dd958",
"name": "Discounttt",
"name_localized": null,
"qualification": 3,
"amount": 11,
"minimum_product_price": null,
"minimum_order_price": null,
"maximum_amount": 11,
"is_percentage": true,
"is_taxable": false,
"order_types": [
1,
2,
3,
4
],
"reference": null,
"created_at": "2022-06-02 07:49:36",
"updated_at": "2022-06-02 07:49:36",
"deleted_at": null,
"pivot": {
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"discount_id": "9671d321-eea4-4f42-837d-bde5148dd958"
}
}
],
"timed_events": [
{
"id": "95b6cb44-d848-42c7-bbba-985d6b9327d2",
"name": "Breakfast Event",
"name_localized": null,
"type": 3,
"value": 50,
"priority": null,
"order_types": [
1,
2,
3,
4
],
"from_date": "2022-03-01",
"to_date": "2022-06-15",
"from_time": 0,
"to_time": 23,
"is_sat": true,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": true,
"is_thu": true,
"is_fri": true,
"is_active": true,
"created_at": "2022-03-01 08:27:48",
"updated_at": "2022-05-26 07:31:21",
"deleted_at": null
}
],
"promotions": [
{
"id": "95c34e88-1c04-42ad-90e5-86511d7c8e93",
"name": "Promotion discount",
"name_localized": null,
"type": 1,
"priority": 1,
"from_date": "2022-03-06",
"to_date": "2022-03-10",
"from_time": 0,
"to_time": 23,
"is_sat": false,
"is_sun": true,
"is_mon": true,
"is_tue": true,
"is_wed": false,
"is_thu": false,
"is_fri": false,
"is_active": true,
"include_modifiers": true,
"target_quantity": 10,
"condition_type": 1,
"reward_type": 1,
"reward_quantity": null,
"reward_amount": 10,
"maximum_discount_amount": 50,
"order_types": [
1
],
"created_at": "2022-03-07 13:44:47",
"updated_at": "2022-05-20 23:44:47",
"deleted_at": null
}
],
"tax_group": {
"id": "95a532df-24d7-4bdf-814b-bc78a99b1817",
"name": "Branch1",
"name_localized": null,
"reference": "vat",
"created_at": "2022-02-20 14:32:36",
"updated_at": "2022-02-20 14:32:36",
"deleted_at": null
},
"products": [
{
"pivot": {
"price": null,
"is_active": false,
"is_in_stock": true
},
"id": "9598e060-6acc-4a1b-b52c-c59cbd5a1b8c",
"sku": "sk-0001",
"barcode": null,
"name": "Pepsi",
"name_localized": null,
"description": "Pepsiii",
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": true,
"is_ready": true,
"pricing_method": 1,
"selling_method": 1,
"costing_method": 2,
"preparation_time": 1,
"price": 4,
"cost": null,
"calories": 300,
"created_at": "2022-02-14 11:31:59",
"updated_at": "2022-03-20 10:10:29",
"deleted_at": null
},
{
"pivot": {
"price": null,
"is_active": false,
"is_in_stock": true
},
"id": "964789d3-6a21-4f50-8cf1-260768b53418",
"sku": "sk-0018",
"barcode": null,
"name": "Cheese cake",
"name_localized": null,
"description": null,
"description_localized": null,
"image": null,
"is_active": true,
"is_stock_product": false,
"is_ready": true,
"pricing_method": 1,
"selling_method": 2,
"costing_method": 2,
"preparation_time": null,
"price": 10,
"cost": null,
"calories": null,
"created_at": "2022-05-12 07:19:51",
"updated_at": "2022-06-07 10:03:47",
"deleted_at": null
}
],
"combos": [],
"devices": [
{
"in_use": true,
"code": "*****",
"id": "9598b48e-2067-4983-9ef1-ccbdc527067a",
"name": "Cashier 1",
"reference": "C01",
"type": 1,
"latitude": null,
"longitude": null,
"model": "iPad12,1",
"build": "273",
"app_version": "5.0.33.sandbox",
"system_version": "iOS 15.1",
"settings": {
"till_report_email": "jack@Ristecho.com",
"default_order_tags": [],
"shift_report_email": "jack@Ristecho.com",
"kitchen_print_language": "3",
"cashier_assigned_tables": [
"95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
"95ed1bc6-766d-4d68-b369-2d82faf2ea07"
],
"end_of_day_report_email": "jack@Ristecho.com",
"cashier_reset_order_number_at": 1000,
"cashier_start_order_number_at": 100,
"ahead_order_reminder_in_minutes": 0,
"print_online_order_when_received": true,
"auto_accept_and_send_online_orders_to_kitchen": true
},
"local_settings": {
"peripherals": {
"kdses": [],
"scales": [],
"cashiers": [],
"displays": [],
"printers": [],
"notifiers": [],
"payment_terminals": [],
"finger_print_scanners": []
},
"tables_configs": [
{
"table_id": "95ed1b7d-929c-4e96-9ff4-f43747b9cebe",
"x_coordinate": 23,
"y_coordinate": 2
},
{
"table_id": "95ed1b7d-3adf-443f-b28a-a940991b6c23",
"x_coordinate": 21,
"y_coordinate": 12
},
{
"table_id": "95ed1bc6-8d62-46eb-98ae-9ce4050ae8d9",
"x_coordinate": 13,
"y_coordinate": 2
},
{
"table_id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
"x_coordinate": 24,
"y_coordinate": 5
},
{
"table_id": "95ed1b7d-6411-4332-b14e-da966f3dc65b",
"x_coordinate": 0,
"y_coordinate": 10
},
{
"table_id": "95ed1bc6-815f-4c1d-b123-fe737be77224",
"x_coordinate": 4,
"y_coordinate": 2
},
{
"table_id": "95ed1b7d-59f1-4c4b-97d1-b694f1d2a2aa",
"x_coordinate": 10,
"y_coordinate": 11
},
{
"table_id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
"x_coordinate": 11,
"y_coordinate": 2
}
]
},
"is_online_receiver": true,
"first_activation_at": "2022-05-31 13:25:01",
"last_sync_at": "2022-06-29 21:15:01",
"last_seen_at": "2022-06-29 21:18:53",
"last_order_at": null,
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-06-29 21:18:56",
"deleted_at": null,
"is_blocked": false
}
],
"modifier_options": [],
"id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "Branch 1",
"name_localized": "branch1",
"reference": "B01",
"type": 1,
"latitude": "30.033333",
"longitude": "31.233334",
"phone": null,
"opening_from": "01:00",
"opening_to": "22:00",
"inventory_end_of_day_time": "06:00",
"receipt_header": "Welcome",
"receipt_footer": "Thank you",
"settings": {
"branch_tax_number": "12345",
"branch_tax_registration_name": "tax-reg-name"
},
"created_at": "2022-02-14 09:29:27",
"updated_at": "2022-05-18 22:00:11",
"deleted_at": null,
"receives_online_orders": true,
"accepts_reservations": true,
"reservation_duration": 30,
"reservation_times": null,
"address": null,
"sections": [
{
"id": "95ed1b7b-470d-4126-825e-94637cece995",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "open air section",
"name_localized": null,
"created_at": "2022-03-28 08:26:48",
"updated_at": "2022-03-28 08:26:48",
"deleted_at": null,
"tables": [
{
"id": "95ed1b7d-146f-4ef3-a54f-9c4d83510c4e",
"section_id": "95ed1b7b-470d-4126-825e-94637cece995",
"name": "New Table 4",
"status": 1,
"seats": 4,
"created_at": "2022-03-28 08:26:49",
"updated_at": "2022-03-28 08:27:05",
"deleted_at": null,
"accepts_reservations": false
}
]
},
{
"id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"branch_id": "9598b48d-ffad-42da-bc43-46fe52b7d83a",
"name": "In-door section",
"name_localized": null,
"created_at": "2022-03-28 08:27:36",
"updated_at": "2022-03-28 08:27:36",
"deleted_at": null,
"tables": [
{
"id": "95ed1bc6-766d-4d68-b369-2d82faf2ea07",
"section_id": "95ed1bc4-e299-47fb-ac59-1061e6f76986",
"name": "New Table 2",
"status": 2,
"seats": 3,
"created_at": "2022-03-28 08:27:37",
"updated_at": "2022-05-25 11:34:24",
"deleted_at": null,
"accepts_reservations": false
}
]
}
]
}
}
# Delete Branch
DELETE /branches/{branchId}
# Scope
admin.write
The API will respond with 200 indicating that the branch has been deleted.