Flavours Partner API
Branch

Create Branch

POST
/api/v2/branches

Create a new branch for a market.

Authorization

API-TOKEN
API-TOKEN<token>

Your partner API key. Send it in the API-TOKEN header on every request.

In: header

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"

Request Body

application/json

includes*array<>
market_id*string

Market ID. Must match an existing stored value.

name_en*string

English name. Must not be greater than 191 characters.

name_ar?|

Arabic name. Must not be greater than 191 characters.

address*string

Branch address. Must not be greater than 500 characters.

latitude*number

Geographic latitude. Must be between -90 and 90.

longitude*number

Geographic longitude. Must be between -180 and 180.

timezone?|

IANA timezone of the branch (e.g. Asia/Riyadh), the clock used for its schedule and workday. Omitted or null keeps the current value (Asia/Riyadh for a new branch). Returned as setting.timezone. Must be a valid time zone, such as Africa/Accra.

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" \  -H "X-API-Version: 2.3.0" \  -H "Content-Type: application/json" \  -d '{    "includes": [      "dolores"    ],    "market_id": "uuid",    "name_en": "Downtown Branch",    "address": "123 Main Street, Riyadh",    "latitude": 24.7136,    "longitude": 46.6753  }'
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Branch created successfully."
  },
  "data": {
    "id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
    "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
    "name_en": "Runolfsson, Champlin and Wolff",
    "name_ar": "Runolfsson, Champlin and Wolff",
    "address": "990 Brianne Road Suite 287\nMuellerport, IL 12133-3100",
    "latitude": -80.355666,
    "longitude": 98.36019,
    "is_active": false,
    "created_at": 1792593332323,
    "updated_at": 1792593332323,
    "deleted_at": null,
    "expired_at": null,
    "is_online": false,
    "code": "BR-890538",
    "level": null,
    "shift": {
      "day": "WED",
      "min": 1792540800000,
      "max": 1792627199000,
      "open_at": 1792540200000,
      "lock_at": 1792630799000,
      "timezone": "Asia/Riyadh",
      "is_workday": false,
      "workday": "2026-10-21",
      "overtime_end_at": null,
      "auto_close_at": null,
      "next_opening_at": null
    },
    "days": {
      "SUN": 1,
      "MON": 1,
      "TUE": 1,
      "WED": 1,
      "THU": 1,
      "FRI": 1,
      "SAT": 1
    },
    "location": null,
    "plans": [],
    "schedules": [
      {
        "id": 22,
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
        "day": "SUN",
        "start_time": "00:00:00",
        "close_time": "23:59:59",
        "created_at": 1792593332323,
        "updated_at": 1792593332323,
        "open_type": null,
        "open_value": null,
        "lock_type": null,
        "lock_value": null,
        "end_time": "23:59:59"
      },
      {
        "id": 23,
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
        "day": "MON",
        "start_time": "00:00:00",
        "close_time": "23:59:59",
        "created_at": 1792593332323,
        "updated_at": 1792593332323,
        "open_type": null,
        "open_value": null,
        "lock_type": null,
        "lock_value": null,
        "end_time": "23:59:59"
      },
      {
        "id": 24,
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
        "day": "TUE",
        "start_time": "00:00:00",
        "close_time": "23:59:59",
        "created_at": 1792593332323,
        "updated_at": 1792593332323,
        "open_type": null,
        "open_value": null,
        "lock_type": null,
        "lock_value": null,
        "end_time": "23:59:59"
      },
      {
        "id": 25,
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
        "day": "WED",
        "start_time": "00:00:00",
        "close_time": "23:59:59",
        "created_at": 1792593332323,
        "updated_at": 1792593332323,
        "open_type": null,
        "open_value": null,
        "lock_type": null,
        "lock_value": null,
        "end_time": "23:59:59"
      },
      {
        "id": 26,
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
        "day": "THU",
        "start_time": "00:00:00",
        "close_time": "23:59:59",
        "created_at": 1792593332323,
        "updated_at": 1792593332323,
        "open_type": null,
        "open_value": null,
        "lock_type": null,
        "lock_value": null,
        "end_time": "23:59:59"
      },
      {
        "id": 27,
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
        "day": "FRI",
        "start_time": "00:00:00",
        "close_time": "23:59:59",
        "created_at": 1792593332323,
        "updated_at": 1792593332323,
        "open_type": null,
        "open_value": null,
        "lock_type": null,
        "lock_value": null,
        "end_time": "23:59:59"
      },
      {
        "id": 28,
        "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
        "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
        "day": "SAT",
        "start_time": "00:00:00",
        "close_time": "23:59:59",
        "created_at": 1792593332323,
        "updated_at": 1792593332323,
        "open_type": null,
        "open_value": null,
        "lock_type": null,
        "lock_value": null,
        "end_time": "23:59:59"
      }
    ],
    "out_of_stock_products": [],
    "market": {
      "id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
      "sector_id": 15,
      "name_en": "Wisoky-Feest",
      "name_ar": "Wisoky-Feest",
      "description_en": null,
      "description_ar": null,
      "logo_img": "https://via.placeholder.com/200x200.png/009955?text=business+logo+facilis",
      "cover_img": "https://via.placeholder.com/200x200.png/009999?text=business+cover+amet",
      "email": "[email protected]",
      "phone_prefix": "967",
      "phone_number": "7856586642",
      "crn": "033-466-2828",
      "tax_number": "66596607090",
      "created_by": null,
      "email_verified_at": 1792593329562,
      "phone_verified_at": 1792593329562,
      "created_at": 1792593329465,
      "updated_at": 1792593329465,
      "deleted_at": null,
      "is_active": true,
      "merchant_id": null,
      "reseller_id": null,
      "slug": "wisoky-feest",
      "code": "ENT-0000000001",
      "links": {
        "website": null,
        "instagram": null,
        "youtube": null,
        "x": null,
        "call_center": null
      },
      "phone": "7856586642",
      "setting": null
    },
    "setting": {
      "id": 10,
      "market_id": "eef0da10-dd19-4a4c-ab3d-23dd1b548801",
      "branch_id": "eb09f5d5-6276-4788-82ab-0cc4f181a212",
      "is_kitchen_active": true,
      "is_pay_later": false,
      "invoice_prefix": null,
      "zatca_otp": null,
      "seating": {
        "order": {
          "statuses": [
            "COMPLETED"
          ],
          "transaction": {
            "status": "PAID"
          }
        }
      },
      "kitchen": {
        "complete_on_last_bump": true,
        "courses_enabled": false,
        "courses": [],
        "kitchen_can_fire": false,
        "fire_by_prep_time": false,
        "fallback_print_delay_seconds": 60,
        "ack_warning_seconds": 15,
        "warn_ratio": 0.75,
        "late_ratio": 1,
        "recall_window_seconds": 900,
        "completed_tab_window_seconds": 1800,
        "print_owner": "TILL",
        "legacy_board": "ON",
        "customer_notification": {
          "channel": "OFF",
          "language": "AR",
          "message_en": "Order {order_number} is ready at {branch_name}.",
          "message_ar": "طلبك رقم {order_number} جاهز في {branch_name}."
        },
        "customer_screen": {
          "ready_display_seconds": 90,
          "number_size": "MEDIUM",
          "preparing_tone": "WARNING",
          "ready_tone": "SUCCESS",
          "layout": "SPLIT",
          "hide_sidebar": false,
          "hide_back": false,
          "hide_branch": false,
          "hide_toolbar": false
        }
      },
      "config_version": 0,
      "waiter": {
        "require_guest_count": false,
        "ownership_rule": "SECTION",
        "table_warn_minutes": 45,
        "table_late_minutes": 90,
        "allow_merge": true,
        "allow_transfer": true,
        "seats": "OPTIONAL",
        "override_policy": "MANAGER_PIN",
        "tips": {
          "enabled": false,
          "presets": [
            5,
            10,
            15
          ],
          "allow_custom": true
        },
        "service_charge_display": "SEPARATE",
        "partial_settlement": false,
        "pay_at_table_provider": null,
        "qr": {
          "enabled": false,
          "auto_accept": false,
          "reject_reasons": [],
          "pending_minutes": 15
        },
        "table_service": "FULL",
        "pin_lockout": {
          "attempts": 5,
          "seconds": 60
        }
      },
      "waiter_config_version": 0,
      "waiter_catalog_version": 1,
      "timezone": "Asia/Riyadh",
      "extension": {
        "has_cleartax": false,
        "has_zatca": false,
        "has_qoyod": false
      },
      "payment": {
        "has_apple": false,
        "has_card": false,
        "has_cash": false,
        "has_postpay": true
      },
      "service": {
        "has_dining": false,
        "has_take_away": false
      },
      "qflavours": {
        "configured": false,
        "api_key": null
      },
      "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 selected market id is invalid. (and 4 more errors)"
  },
  "data": [
    {
      "code": 0,
      "message": "The selected market is invalid.",
      "field": "market"
    },
    {
      "code": 0,
      "message": "The Name (English) must be a string.",
      "field": "name_en"
    },
    {
      "code": 0,
      "message": "The address field is required.",
      "field": "address"
    },
    {
      "code": 0,
      "message": "The latitude must be a number.",
      "field": "latitude"
    },
    {
      "code": 0,
      "message": "The longitude must be a number.",
      "field": "longitude"
    }
  ]
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

Changelog

Version history for the Flavours API — new endpoints, request/response changes, deprecations, and breaking changes.

Delete Branch DELETE

Delete a specific branch by its ID.