Flavours API Documentation
  1. Customers
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. Customers

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
/users/customers

Request Body#

Validation#

FieldTypeRuleDescription
pageintegernullable min:1Read more on the Pagination page
per_pageintegernullable min:1Read more on the Pagination page
searchstringnullable
sortstringnullableRead more on the Sorting page
includesarraynullableRead more on the Includables page
filter.market_idstringnullableId from Market model
The rules on the fields will change depending on conditions, including the following
FieldRuleCondition
filter.market_idrequiredUser authentication role SUBSCRIBER

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
key_by
string 
optional
includes
array[string]
optional
Example:
["userable"]
filter[market_id]
string 
optional
Example:
b5d70a92-5d2e-4f89-8e52-1827cfbd01f4

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/users/customers?page=1&per_page=20&search&sort&key_by=&includes=userable&filter[market_id]=b5d70a92-5d2e-4f89-8e52-1827cfbd01f4'

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 {18}] 
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": "f1508dc9-3841-41ce-b976-16ee4482c9dc",
                "userable_id": "2a6f3d74-e584-42c5-9853-f7ec4b8226f1",
                "role": "USER_CUSTOMER",
                "name": "Ehsan",
                "username": null,
                "email": "[email protected]",
                "phone_prefix": "966",
                "phone": "557937703",
                "lang": "en",
                "fcm_token": null,
                "is_active": true,
                "email_verified_at": null,
                "phone_verified_at": null,
                "created_at": 1733897804445,
                "updated_at": 1733897804445,
                "deleted_at": null,
                "profile_img": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAS2UlEQVR4nO3dP4wc53nH8a8OUnNIZGtBYRIEII04xYlNEp6SShTS6VwFJJHCEGWkkdiKdgDBuiYNFbsIjkaa8IgASUh31gmuSFYBxOssHmAg4R0QF+IGATL2Yh2kuDrFvEsu7/b278y878x8P83dLe92X8PQD8/7zDPvvIJ0hjwfrgMb4ce3w9d14K2xX1sHLs75ll8Dg7Gfn439/BQ4BvpZ1hsgTfBK7AUonjwfngPOU4TROeBC+H48qGLpU4TZ0/D9s9H3Wdbrx1yY4jGwOmCsUnob2KSoiDYoQqqJjoEj4CvgMHw9sjJrPwOrhfJ8uAG8C1ymCKnY1VJd+hTh9Rj4Kst6+5HXo5IZWC2Q58N3eBFQ71Js6VTYB76kCLEvs6x3HHk9WoGB1UChgtoC3sOAWtQ+8IAivKzAGsbAaog8H24BVyiC6nzk5bTFgKL6+inw0OorfQZWokKjfAt4P3y1iqreQ+ALYM8GfpoMrIQYUkkxvBJkYCUgz4eXgBvAVZo7atBWxxThdTfLeg9jL6brDKxIwtDmdYqg6srYQdMNgF3gjsOrcRhYNQsjCKNqyi1fc42qrr3YC+kSA6sGoTd1HbiJ1VTbDIAdYNdeV/UMrAqFbd9N4CPsTbXdMXAf2Mmy3lHsxbSVgVWBPB+e50VQue3rnlFwHcReSNsYWCUKE+jbFNs/aR/4oRP15TGwSmBQaQaDqyQG1gpCj+oWxdZPmuUhcNMe1/IMrCWEq36joLJHpUXdB7ad5VqcgbWgPB9+TLH986qfVnFMMYS67U3X8zOw5hQGPu/iHJXKNaDYJt6PvZAmMLBmCCMKOxST6VJVDoAPHYWYzsCaIs+Hn1Js/+xTqS67FBWX28QJDKwJwukJP8Xtn+IYADe8T/E0A2tMuPq3DXwaey0SsEcRXN6jGBhYQTiC+A4eP6y0HFNsEXdjLyQFnQ8sqyo1hNUWHQ8se1VqmM73tjobWGEA9BZeAVTz3KajA6edC6xw/989ioc8SE11BFzp2n2Ja7EXUKcwrf4Ew0rNtwE8yfNhp04I6UyFFbaAO7HXIVWgM8OmrQ+scBXwHt5ao3Y7oNgitvoEiFYHVrgP8BFeBVQ3DChCq7UHBba2hxX6VYcYVuqOc8DjPB+29kDJVgZW+D/sMY4sqJvu5PnwTuxFVKF1W8I8H+4AH8deh5SAh8C1NjXjWxNYNteliVrVjG9FYIWwegS8E3stUoL6wOU2hFbjAytcCXyMpyxI0xwD7zX9CmKjA8uwkhbS+NBq7FXC8PBSw0qa3zrwKJz91kiNDKyxewINK2kx68CDps5qNW5LGMLqEc5YSau60bSTTBsVWIaVVLpGhVZjAsuwkirTmNBqRGCFBvsTDCupKteacPRy8oHl6IJUi0aMPCQdWIaVVKvkQyvZwAq32xxiWEl1OgY2Uz0rPsk5rLF7Aw0rqV6j4dIk/9tLMrAoTl3wRmYpjvMUoZXcRa7kAiucZ+URMVJcGxS7nKQkFVjhdgEP35PS8E5qJ5cm03QPg6GPY69D0ik3s6x3O/YiIJHACg2+QxwMlVL1nSzrPYy9iOiBFRp7T/DpNlLKjoG3Yp9amkIP6x6GlZS60bhD1F1Q1MAKj4/3iqDUDBtA1CZ8tC2hTXapsaI14aMEVp4Pz+GJoVJTHVM8heeg7g+OtSW8h2ElNdU68EWMflbtgRX6Vo09BF8SUBQctfezat0S5vnwEkXfynkrqR0+yLLe/bo+rLbAct5KaqVa57Pq3BJuY1hJbbNOjVvDWgIrPLjx0zo+S1LttvJ8WMt/35VvCT05VOqEWk4qraPC2sawktpuHdip+kMqrbDCVcEnVX6GpKRU+ozDqgPrEBvtUpccAxeyrDeo4s0r2xKGJpxhJXVLpVcNK6mwPJBP6rxKDvyrqsLawbCSumyninsNSw+scGyMZ1xJ3bYBfFT2m5a+JbTRLikovQFfaoUVTmIwrCRBBbNZpVVYYb/6DDhX1ntKaoW3ypqAL7PCuoVhJem0u2W9USkVVjjy+BleGZQ02eUs6+2v+iZlVVi3MKwkne0nZbzJyhVWng83KIZEJWmalU8nLaPC2i7hPSS138pZsVJgherq+qqLkNQJG3k+XCkvVq2wrK4kLWKlzFi6hxVucH62yodL6qRrWdbbW+YPV6mwbq7wt5K6a+nsWKrCcu5K0oqWmstatsK6iWElaXlL9bIWrrC8Z1BSSRa+x3CZCus6hpWk1S3cy1qmwvK8K0llWPi8rIUqrHCaqGElqQzrLDh4vuiW8MaCvy9J0yyUKXNvCR1lkFSRuUccFqmwrmNYSSrf3FXWIoHldlBSFa6GHdxMcwVWng8vYbNdUjXWmfPRgPNWWFZXkqo0V8bMbLo72S6pJjMn3+epsLYwrCRV74NZvzBPYL1fwkIkaZaZQ6RTt4RhO/gbHGeQVI/NLOsdnPWPsyqsLQwrSfW5Nu0fZwWW20FJdZq6LZynwpKkupwPT+Oa6MzAyvOh20FJMZw5RDqtwrpSwUIkaZYz+1hnXiXM8+Ez4Hwly+mg//3t//Fnf/yXsZexknf/4s/5p3/98czfK+t/6y9++XO++cbrK7/PNHs/e8Qn3//RSu9x9a+2+PHff1LSihS8Oelgv4kVVthDGlaSYpnYPz9rS2izXVJM70168azAmvjLklSThSqsdytciCTNcm7SeMOpwAoPmnCcQVJsp6qsSRWW1ZWkFFw++cKkwDr1S5IUwaniyQpLUqpO9bFeCqzwj/avJKXi7fEfTlZYVleSUvJSi+pkYNm/kpSSl4qok4H1NpKUjo1w8jEwFljhRZ89KCk1l0bfvDr2omHVAHf/+e/43dd/J8pnvx7pc9V5F4F9eDmw3A42wJ/86cXKj1yRErM5+mZt0ouSlJDnxdR4YF2MsBBJmuV5u2pt0ouSlJD1PB+ehxBYeT48h4+jl5Sui/CiwvI4ZEkpe1Fh4RVCSWnbhBeB5XZQUsrOwYvAuhBxIZI0y7fALaGkZrgELwLLM7AkJS3Ph+ujwHIGS1LqNtbGj26QpIStr2F1JakZLp71IFVJSs4aXiGU1AybVliSGmMNRxokNcP6GvBW7FVI0hwuvjr7d5SSv37/b3jttdcq/5zf+/03+Yd//NvKP2eaw6e/4o3eNyr9jP/+r/+p9P1VLgOrYf7j3/+zls+58Ns/qOVzpvned38QewlKjD0sSU2xvoZnuUtqhg3HGiQ1hoElqTEMLEmNYWBJagwDS1JjGFiSGsPAktQYBpakxjCwJDXGGvB17EVI0hz6rwKD2KvQ/H7xy5/zzTdej70MKYaBpzUoWXWE897PHvHJ939U6WeoPPawJDXGGvAs9iIkaQ5fr2EPS1IzDNwSSmqMNeBp7EVI0hwO14Dj2KuQpDkcrwH92KuQpDn017KsZ9NdUhP8etR0t8qSlLr+KLCssiQlLct6z8cavFIoKWVH8OLWHLeEklL2NbwILG/PkZSyPrwILLeEklJ2CG4JJTXDiwory3p9nHiXlK6n8PJ5WEeRFiJJU2VZ76WrhABfRVqLJE1zMPpmPLAOIyxEkmZ5flHQCktS6p6Mvhl/CIU9rAY4fPor3uh9I8pnv/baq3z7jy5E+Wx12vNseh5YWdYb5PmwD5yPsiTN5Xvf/UG0z/7Db5/n0b/9S7TPV2c93/2dPCLZbaGklPTHj8A6GViPa16MJE3z5fgPVliSUvZk/IeXAivLevv1rkWSpppaYQEYWpJScJxlvYPxFyYF1pcTXpOkup3KokmBZeNdUgpOZZEVlqRUza6wsqx3jH0sSXEdT7oIOKnCAnhQ8WIkaZqHk148K7DcFkqKaWIvfWJghVLMZxVKimVv0otnVVhglSUpjn44tv2UV876izwfXgU+r2xJkjTZZ1nW2570D9MqrIlNL0mq2JkX/c4MrDDeYGhJqtNg2j3N0yosgC9KXowkTTOx2T4yK7Cm/rEklWxqkTQ1sMJJf24LJ
Modified at 2025-03-25 05:22:20
Previous
Overview
Next
Detail
Built with