- 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
List
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 Body#
Validation :#
| Field | Type | Rule | Description |
|---|---|---|---|
page | integer | nullable min:1 | Read more on the Pagination page |
per_page | integer | nullable min:1 | Read more on the Pagination page |
search | string | nullable | |
sort | string | nullable | Read more on the Sorting page |
includes | array | nullable | Read more on the Includables page |
filter.sector_id | integer | nullable | Id from Sector model |
filter.market_id | string | nullable | Id from Market model |
filter.branch_id | string | nullable | Id from Branch model |
filter.product_categories_ids | array | nullable | Array of id from ProductCategory model |
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Query Params
page
integer
optional
Example:
1
per_page
integer
optional
Example:
20
search
string
optional
sort
string
optional
includes
array[string]
optional
filter[sector_id]
integer
optional
filter[market_id]
string
optional
filter[branch_id]
string
optional
filter[product_categories_ids]
array[string]
optional
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 -g --request GET 'https://api.flavours.sa/dev/api/v2/product-categories?page=1&per_page=20&search=&sort=&includes=&filter[sector_id]=&filter[market_id]=&filter[branch_id]=&filter[product_categories_ids]='Responses
🟢200OK
application/json
Body
meta
object
required
code
integer
required
status
string
required
message
string
required
data
object
required
current_page
integer
required
data
array [object {10}]
required
first_page_url
string
required
from
integer
required
last_page
integer
required
last_page_url
string
required
links
array [object {3}]
required
next_page_url
string | null
required
path
string
required
per_page
integer
required
prev_page_url
string | null
required
to
integer
required
total
integer
required
Example
{
"meta": {
"code": 200,
"status": "success",
"message": "Data Loaded Successfully"
},
"data": {
"current_page": 1,
"data": [
{
"id": 73,
"icon": "🥗",
"name_en": "Salads",
"name_ar": "السلطات",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "23",
"products_inactive_count": "2"
},
{
"id": 1,
"icon": "🥤",
"name_en": "Mojito",
"name_ar": "موهيتو",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "119",
"products_inactive_count": "1"
},
{
"id": 2,
"icon": "🥩",
"name_en": "Steak",
"name_ar": "ستيك",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "22",
"products_inactive_count": "1"
},
{
"id": 11,
"icon": "🍔",
"name_en": "Burger",
"name_ar": "برغر",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "71",
"products_inactive_count": "3"
},
{
"id": 3,
"icon": "🌯",
"name_en": "Sandwiches",
"name_ar": "ساندويتشات",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "180",
"products_inactive_count": "19"
},
{
"id": 6,
"icon": "🍦",
"name_en": "Ice cream",
"name_ar": "ايس كريم",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "11",
"products_inactive_count": "0"
},
{
"id": 19,
"icon": "🍢",
"name_en": "Grills",
"name_ar": "مشاوي",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "24",
"products_inactive_count": "0"
},
{
"id": 21,
"icon": "🍽",
"name_en": "Meals",
"name_ar": "وجبات",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "418",
"products_inactive_count": "9"
},
{
"id": 77,
"icon": "🍮",
"name_en": "candies",
"name_ar": "حلويات",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "276",
"products_inactive_count": "27"
},
{
"id": 80,
"icon": "🍝",
"name_en": "Pasta",
"name_ar": "باستا",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "27",
"products_inactive_count": "1"
},
{
"id": 88,
"icon": "🥔",
"name_en": "potato",
"name_ar": "بطاطس",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "27",
"products_inactive_count": "1"
},
{
"id": 89,
"icon": "🍷",
"name_en": "soft drink",
"name_ar": "مشروب غازي",
"deleted_at": null,
"created_at": null,
"updated_at": null,
"products_active_count": "25",
"products_inactive_count": "1"
}
],
"first_page_url": "https://api.flavours.sa/dev/api/v2/product-categories?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "https://api.flavours.sa/dev/api/v2/product-categories?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "https://api.flavours.sa/dev/api/v2/product-categories?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "https://api.flavours.sa/dev/api/v2/product-categories",
"per_page": 20,
"prev_page_url": null,
"to": 12,
"total": 12
}
}