Flavours API Documentation
  1. Table
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
    • Detail
    • Create
    • Update
  • 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
      GET
    • Detail
      GET
    • Create
      POST
    • Update
      POST
    • Delete
      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. Table

List

DEVELOPMENT
https://api.flavours.sa/dev/api/v2
DEVELOPMENT
https://api.flavours.sa/dev/api/v2
GET
https://api.flavours.sa/dev/api/v2
/tables

Request Body#

Validation#

FieldTypeRuleDescription
searchstringnullable
includes[]arraynullableRead more on the Includables page
filter[market_id]stringnullableId from Market model
filter[branch_id]stringnullableId from Branch model
pageintegernullableRead more on the Pagination page
per_pageintegernullable default:20Read more on the Pagination page
The rules on the fields will change depending on conditions, including the following
FieldRuleCondition
filter[market_id]requiredUser authentication role SUBSCRIBER
filter[branch_id]requiredUser authentication role SUBSCRIBER

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
search
string 
optional
Nullable
includes[]
array[string]
optional
Nulable
Example:
["market","branch"]
filter[market_id]
string 
optional
Nullable | Required if user role SUBSCRIBER
Example:
b5d70a92-5d2e-4f89-8e52-1827cfbd01f4
filter[branch_id]
string 
optional
Nullable | Required if user role SUBSCRIBER member
Example:
6b14ac8c-8f23-4473-beb5-6777116363a1
page
integer 
optional
Nullable
Example:
1
per_page
integer 
optional
Nullable | Default: 20
Example:
20

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/tables?search=&includes[]=market&includes[]=branch&filter[market_id]=b5d70a92-5d2e-4f89-8e52-1827cfbd01f4&filter[branch_id]=6b14ac8c-8f23-4473-beb5-6777116363a1&page=1&per_page=20'

Responses

🟢200List | 200
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 {4}] 
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
null 
required
to
integer 
required
total
integer 
required
Example
{
    "meta": {
        "code": 200,
        "status": "success",
        "message": "Data Loaded Successfully"
    },
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 20,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "594029"
            },
            {
                "id": 19,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "745684"
            },
            {
                "id": 18,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "623140"
            },
            {
                "id": 17,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "918880"
            },
            {
                "id": 16,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "336138"
            },
            {
                "id": 15,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "459322"
            },
            {
                "id": 14,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "282544"
            },
            {
                "id": 13,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "897991"
            },
            {
                "id": 12,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "720582"
            },
            {
                "id": 11,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "868932"
            },
            {
                "id": 10,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "741268"
            },
            {
                "id": 9,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "686682"
            },
            {
                "id": 8,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "765509"
            },
            {
                "id": 7,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "100771"
            },
            {
                "id": 6,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "532777"
            },
            {
                "id": 5,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "451748"
            },
            {
                "id": 4,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "649507"
            },
            {
                "id": 3,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "184436"
            },
            {
                "id": 2,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "732582"
            },
            {
                "id": 1,
                "market_id": "30499025-43e2-4a77-bc29-13066288fc3f",
                "branch_id": "8f9a2ea4-8e13-4c11-8626-c0408bbdc791",
                "code": "548025"
            }
        ],
        "first_page_url": "http://localhost:8000/api/table?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://localhost:8000/api/table?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://localhost:8000/api/table?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "http://localhost:8000/api/table",
        "per_page": 20,
        "prev_page_url": null,
        "to": 20,
        "total": 20
    }
}
🟠422List | 422
Previous
Overview
Next
Detail
Built with