- Readme
- Developer Guide
- Authorization
- Includables
- Pagination
- Sorting
- Retrieve Market Information
- Retrieve Branch Information
- Me
- Branches
- Orders
- Customers
- Products
- Product Categories
- Discounts
- Payment Methods
- Table
- Printer
- Webhook
Detail
Developing
DEVELOPMENT
https://api.flavours.sa/dev/api/v2
DEVELOPMENT
https://api.flavours.sa/dev/api/v2
GET
https://api.flavours.sa/dev/api/v2
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:
6b14ac8c-8f23-4473-beb5-6777116363a1
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 GET 'https://api.flavours.sa/dev/api/v2/branches/6b14ac8c-8f23-4473-beb5-6777116363a1'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 | null
optional
deleted_at
integer | null
optional
expired_at
integer | null
optional
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
location
string | null
optional
plans
array [object {16}]
required
schedules
array [object {8}]
required
out_of_stock_products
array [object {21}]
required
Example
{
"meta": {
"code": 200,
"status": "success",
"message": "Data Loaded Successfully"
},
"data": {
"id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"name_en": "Ar Rawdah, Riyadh",
"name_ar": "الروضة، الرياض",
"address": "7596 الديوان, Riyadh, Riyadh, Saudi Arabia",
"latitude": 24.774265,
"longitude": 46.738586,
"is_active": true,
"created_at": 1700933589256,
"updated_at": 1721012385150,
"deleted_at": null,
"expired_at": 1736195824688,
"waiting_orders_count": "223",
"process_orders_count": "1272",
"completed_orders_count": "248",
"canceled_orders_count": "28",
"market": {
"id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"sector_id": 3,
"slug": null,
"name_en": "flavours",
"name_ar": "فليفرز",
"description_en": "res",
"description_ar": "مطعم",
"logo_img": "https://flavours-files.s3.me-south-1.amazonaws.com/img/uploads/markets/logos/1720926739.jpg",
"cover_img": null,
"email": "[email protected]",
"phone_prefix": "966",
"phone": "581157875",
"crn": null,
"tax_number": "10101010101020",
"created_by": "ad3ffe2c-0986-439e-a519-2f5032af3c6c",
"email_verified_at": null,
"phone_verified_at": 1713453448327,
"created_at": 1700933589182,
"updated_at": 1741327188815,
"deleted_at": null,
"is_active": true,
"merchant_id": null,
"reseller_id": null,
"setting": {
"id": 371,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"balance": 0,
"income": 0,
"receipt_message_en": null,
"receipt_message_ar": null,
"currency": "SAR",
"order_num_start": 1,
"is_tax_details": true,
"is_offline_calculate": false,
"country_code": "SA",
"country_id": 109,
"subscription_key": "ADVANCED",
"subscription_option_key": "MONTHLY"
}
},
"setting": {
"id": 175,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"is_kitchen_active": true,
"is_pay_later": true,
"invoice_prefix": null,
"zatca_otp": null,
"active_subscription": {
"id": 405,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"renewal_id": "5c4e0416-7ec6-4f8b-8781-035cf30c50a6",
"subscription_key": "ADVANCED",
"subscription_option_key": "YEARLY",
"qty": 5,
"price": 0,
"discount": 0,
"tax": 0,
"subtotal": 0,
"total": 0,
"start_at": 1736670720000,
"end_at": 1894437120000,
"created_at": 1736670720000,
"updated_at": 1736670720000
}
},
"location": null,
"plans": [
{
"id": 405,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"renewal_id": "5c4e0416-7ec6-4f8b-8781-035cf30c50a6",
"subscription_key": "ADVANCED",
"subscription_option_key": "YEARLY",
"qty": 5,
"price": 0,
"discount": 0,
"tax": 0,
"subtotal": 0,
"total": 0,
"start_at": 1736670720000,
"end_at": 1894437120000,
"created_at": 1736670720000,
"updated_at": 1736670720000
}
],
"schedules": [
{
"id": 1170,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"day": "SUN",
"start_time": "00:02:00",
"end_time": "23:59:00",
"created_at": 1727827368621,
"updated_at": 1741547760452
},
{
"id": 1171,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"day": "MON",
"start_time": "00:00:00",
"end_time": "23:59:00",
"created_at": 1727827368621,
"updated_at": 1741547760452
},
{
"id": 1172,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"day": "TUE",
"start_time": "00:00:00",
"end_time": "23:59:00",
"created_at": 1727827368621,
"updated_at": 1741547760452
},
{
"id": 1173,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"day": "WED",
"start_time": "00:00:00",
"end_time": "23:59:00",
"created_at": 1727827368621,
"updated_at": 1741547760452
},
{
"id": 1174,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"day": "THU",
"start_time": "00:00:00",
"end_time": "23:59:00",
"created_at": 1727827368621,
"updated_at": 1741547760452
},
{
"id": 1175,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"day": "FRI",
"start_time": "00:00:00",
"end_time": "23:59:00",
"created_at": 1727827368621,
"updated_at": 1741547760452
},
{
"id": 1176,
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"day": "SAT",
"start_time": "00:00:00",
"end_time": "23:59:00",
"created_at": 1727827368621,
"updated_at": 1741547760452
}
],
"out_of_stock_products": [
{
"id": "0018218a-7514-487f-af3c-ec3b88fa027b",
"market_id": "57ef590a-b848-47d1-99de-d0b17817b686",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"product_category_id": 12,
"name_en": "pepsi",
"name_ar": "ببسي",
"description_en": null,
"description_ar": null,
"preparation_time": 10,
"stock": 0,
"order": 6,
"images": [
"https://flavours-files.s3.me-south-1.amazonaws.com/img/uploads/products/1718198232-0.jpeg"
],
"is_active": false,
"created_at": 1713222191921,
"updated_at": 1719490313615,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null
},
{
"id": "130d18cd-45fe-4793-ac65-0b0b26906d23",
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"product_category_id": null,
"name_en": "No Category",
"name_ar": "No Category",
"description_en": null,
"description_ar": null,
"preparation_time": null,
"stock": 0,
"order": 30,
"images": null,
"is_active": true,
"created_at": 1729600219626,
"updated_at": 1729600219626,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null
},
{
"id": "36799ceb-ebde-46bf-bd03-269c91d04410",
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"product_category_id": 1,
"name_en": "blend test",
"name_ar": "blend test",
"description_en": null,
"description_ar": null,
"preparation_time": null,
"stock": 0,
"order": 43,
"images": null,
"is_active": true,
"created_at": 1741694580098,
"updated_at": 1741772751319,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null
},
{
"id": "56439ca7-bc27-40c6-b7bc-b6136e1d1956",
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"product_category_id": 2,
"name_en": "Product Full A",
"name_ar": "Product Full B",
"description_en": "Sweat Ice Cream",
"description_ar": "Sweat Ice Cream",
"preparation_time": null,
"stock": 0,
"order": 22,
"images": [
"https://flavours-files.s3.me-south-1.amazonaws.com/img/uploads/products/1728615282-0.jpg"
],
"is_active": true,
"created_at": 1728615282060,
"updated_at": 1728616366352,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null
},
{
"id": "64e38870-c280-4194-8cd0-f2ae724aad22",
"market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
"branch_id": "6b14ac8c-8f23-4473-beb5-6777116363a1",
"product_category_id": 3,
"name_en": "Product 21",
"name_ar": "Product 21",
"description_en": null,
"description_ar": null,
"preparation_time": null,
"stock": 0,
"order": 28,
"images": null,
"is_active": true,
"created_at": 1729471838029,
"updated_at": 1729471838029,
"deleted_at": null,
"rating_amount": 0,
"rating_avg": "0.00",
"sold_amount": 0,
"sold_revenue": 0,
"qoyod_id": null
}
]
}
}