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

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
/branches

Request Body#

Validation#

FieldTypeRuleDescription
pageintegernullableRead more on the Pagination page
per_pageintegernullableRead more on the Pagination page
searchstringnullable
sortstringnullableRead more on the Sorting page
includesarraynullableRead more on the Includables page
filter.market_idstringnullableId from Market model
filter.is_activebooleannullable
Field filter.market_id required for user with SUBSCRIBER role

Request

Authorization
Add parameter in header
API-TOKEN
Example:
API-TOKEN: ********************
Query Params

Request Code 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/branches?page=1&per_page=20&search=&sort=&includes=&filter[market_id]=b5d70a92-5d2e-4f89-8e52-1827cfbd01f4&filter[is_active]=1' \
--header 'API-TOKEN: <api-key>'

Responses

🟢200OK
application/json
Body

Examples
{
    "meta": {
        "code": 200,
        "status": "success",
        "message": "Data Loaded Successfully"
    },
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": "80f58d78-00bb-4ed3-bef7-4c3b3c85d6f4",
                "market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
                "name_en": "tttt",
                "name_ar": "Testing 1a",
                "address": "38-40 Railroad Avenue, Long Island City, New York 11101, United States",
                "latitude": 40.73061,
                "longitude": -73.935242,
                "is_active": true,
                "created_at": 1729063530606,
                "updated_at": 1740478477247,
                "deleted_at": null,
                "expired_at": 1729063530666
            },
            {
                "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
            }
        ],
        "first_page_url": "https://api.flavours.sa/dev/api/v2/branches?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://api.flavours.sa/dev/api/v2/branches?page=1",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://api.flavours.sa/dev/api/v2/branches?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://api.flavours.sa/dev/api/v2/branches",
        "per_page": 20,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    }
}
🟠403Forbidden
Modified at 2025-03-26 06:26:22
Previous
Overview
Next
Detail
Built with