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
page
integer 
optional
Nullable
Example:
1
per_page
integer 
optional
Nullable | Default : 20
Example:
20
search
string 
optional
Nullable
sort
string 
optional
Nullable
includes
array[string]
optional
Nullable | From "/api/constant/branch-include"
filter[market_id]
string 
optional
Nullable | Required if user role SUBSCRIBER
Example:
b5d70a92-5d2e-4f89-8e52-1827cfbd01f4
filter[is_active]
integer 
optional
Nullable | Boolean
Example:
1

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

Responses

🟠403Forbidden
application/json
Body
meta
object 
required
code
integer 
required
status
string 
required
message
string 
required
data
string 
required
Example
{
  "meta": {
    "code": 0,
    "status": "string",
    "message": "string"
  },
  "data": "string"
}
🟢200OK
Previous
Overview
Next
Detail
Built with