Flavours API Documentation
  1. Branches
Flavours API Documentation
  • Readme
  • Developer Guide
  • Authorization
  • Includables
  • Pagination
  • Sorting
  • Retrieve Market Information
  • Retrieve Branch Information
  • Me
    • Overview
    • Detail
      GET
  • Branches
    • Overview
    • List
      GET
    • Detail
      GET
    • Create
      POST
    • Update
      POST
    • Delete
      DELETE
  • Orders
    • Overview
    • List
      GET
    • Detail
      GET
    • Create
      POST
    • Calculate
      POST
    • Checkout
      POST
    • Update
      POST
    • Sync
      POST
  • Customers
    • Overview
    • List
      GET
    • Detail
      GET
    • Create
      POST
    • Update
      POST
  • Products
    • Overview
    • List
    • Detail
    • Create
    • Update
    • Delete
  • Product Categories
    • Overview
    • List
    • Detail
  • Discounts
    • Overview
    • List
    • Detail
    • Verify
  • Payment Methods
    • Overview
    • List
    • Detail
  • Table
    • Overview
    • List
    • Detail
    • Create
    • Update
    • Delete
  • Printer
  • Webhook
    • Orders Webhooks
      • Webhook Events
      • Payload
    • Product Webhooks
      • Webhook Events
      • Payload
    • Loyalty Webhooks
      • Promotional Coupon
    • Customers Webhooks
      • Webhook Events
      • Payload
    • Error Webhook
      • Stay Alert to Connectivity Issues
    • Third-Party
      • Ballurh
        • Install Ballurh
      • Loyapro
        • Loyalty
          • Check Reward
          • Redeem Reward
      • Bonat
        • Check Reward
        • Redeem Reward
      • Fai
        • Register Entity
  1. Branches

Update

Developing
DEVELOPMENT
https://api.flavours.sa/dev/api/v2
DEVELOPMENT
https://api.flavours.sa/dev/api/v2
POST
https://api.flavours.sa/dev/api/v2
/branches/{branchId}

Constant#

Use the constants below according to the field names and rules for each request
ConstantValue
subscription_typeMONTHLY YEARLY

Validation#

FieldTypeRuleDescription
market_idstringnullableId from Market model
name_enstringnullable
name_arstringnullable
addressstringnullable
latitudenumericnullable
longitudenumericnullable
is_activebooleannullable
is_kitchen_activebooleannullable
is_pay_laterbooleannullable
subscription_typestringnullableFrom subscription_type constant above

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
branchId
string 
required
Example:
6d38f931-7d26-4c36-a929-cd8f37eb1554
Body Params application/json
market_id
string 
required
name_en
string 
required
name_ar
string 
required
address
string 
required
latitude
number 
required
longitude
number 
required
is_active
integer 
required
is_kitchen_active
integer 
required
is_pay_later
integer 
required
subscription_type
string 
required
Example
{
  "subscription_type": "MONTHLY",
  "is_pay_later": 0,
  "is_kitchen_active": 1,
  "is_active": 1,
  "name_ar": "East Providence",
  "name_en": "East Providence"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.flavours.sa/dev/api/v2/branches/6d38f931-7d26-4c36-a929-cd8f37eb1554' \
--header 'Content-Type: application/json' \
--data-raw '{
    "subscription_type": "MONTHLY",
    "is_pay_later": 0,
    "is_kitchen_active": 1,
    "is_active": 1,
    "name_ar": "East Providence",
    "name_en": "East Providence"
}'

Responses

🟢200OK
application/json
Body
meta
object 
required
code
integer 
required
status
string 
required
message
string 
required
data
object 
required
id
string 
required
market_id
string 
required
name_en
string 
required
name_ar
string 
required
address
string 
required
latitude
number 
required
longitude
number 
required
is_active
boolean 
required
created_at
integer 
required
updated_at
integer 
required
deleted_at
null 
required
expired_at
integer 
required
waiting_orders_count
string 
required
process_orders_count
string 
required
completed_orders_count
string 
required
canceled_orders_count
string 
required
market
object 
required
setting
object 
required
schedules
array[string]
required
out_of_stock_products
array[string]
required
Example
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Update Success"
  },
  "data": {
    "id": "6d38f931-7d26-4c36-a929-cd8f37eb1554",
    "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
    "name_en": "East Providence",
    "name_ar": "East Providence",
    "address": "2081 Sally Stravenue, Port Christinaberg",
    "latitude": 40.73061,
    "longitude": -73.935242,
    "is_active": true,
    "created_at": 1698599116117,
    "updated_at": 1698599116117,
    "deleted_at": null,
    "expired_at": 1698599116127,
    "waiting_orders_count": "0",
    "process_orders_count": "0",
    "completed_orders_count": "0",
    "canceled_orders_count": "0",
    "market": {
      "id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
      "sector_id": 1,
      "name_en": "First Restaurant",
      "name_ar": "First Restaurant",
      "description_en": "Ut maxime commodi natus id tenetur ullam. Repudiandae aut quia est perspiciatis facilis dolores repellendus ea eum. Iusto occaecati libero ea voluptas dolore qui qui maxime quod. Eum ut vel possimus sunt doloribus saepe repellendus et.",
      "description_ar": "العظمى إستيلاء الأوروبية، حين عل. هو وبعد قتيل، العالمي ولم, يونيو مساعدة التاريخ، وصل تم. بـ سكان الجو اليابان تحت, يتم لأداء تكتيكاً قُدُماً ان. نفس موالية الجنوبي ما, أضف تم غضون أسابيع وقوعها،. وبدون ميناء الأمريكية فقد عل, قتيل، معارضة ضرب عن, دول وبعض لفرنسا تزامناً ثم. أي أدوات استبدال جعل. يكن لغات مشروط من.",
      "logo_img": null,
      "cover_img": null,
      "email": "[email protected]",
      "phone_prefix": "966",
      "phone": "579112767",
      "crn": null,
      "tax_number": "12345611",
      "created_by": null,
      "email_verified_at": null,
      "phone_verified_at": null,
      "created_at": 1680271006362,
      "updated_at": 1683019078189,
      "deleted_at": null
    },
    "setting": {
      "id": 66,
      "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
      "branch_id": "6d38f931-7d26-4c36-a929-cd8f37eb1554",
      "is_kitchen_active": true,
      "subscription_type": "MONTHLY",
      "is_pay_later": false
    },
    "schedules": [],
    "out_of_stock_products": []
  }
}
Previous
Create
Next
Delete
Built with