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

Detail

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/{customerId}
It is an endpoint designed to fetch detailed information about customers within a system or platform. This API allows users to retrieve specific data related to customers, such as customer ID, name, email address, phone number, physical address, registration date, account status, and other relevant details.

Path Parameters#

Validation:#

FieldTypeRuleDescription
customerIdstringrequiredId from Customer model

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
customerId
string 
required
Example:
106d3f0d-f54b-4142-80af-68591c855337

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 --request GET 'https://api.flavours.sa/dev/api/v2/users/customers/106d3f0d-f54b-4142-80af-68591c855337'

Responses

🟢200OK
application/json
Body
meta
object 
required
code
integer 
required
status
string 
required
message
string 
required
data
object 
required
id
string 
required
userable_id
string 
required
role
string 
required
name
string 
required
username
string  | null 
required
email
string  | null 
required
phone_prefix
string 
required
phone
string 
required
lang
string 
required
fcm_token
string  | null 
required
is_active
boolean 
required
email_verified_at
integer  | null 
required
phone_verified_at
integer  | null 
required
created_at
integer 
required
updated_at
integer 
required
deleted_at
integer  | null 
required
profile_img
string 
required
userable
object 
required
Example
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Data Loaded Successfully"
  },
  "data": {
    "id": "106d3f0d-f54b-4142-80af-68591c855337",
    "userable_id": "30d1305d-0cdb-4400-8619-d0b82d6d2e56",
    "role": "USER_CUSTOMER",
    "name": "Ehsan flavour",
    "username": null,
    "email": "[email protected]",
    "phone_prefix": "966",
    "phone": "557937702",
    "lang": "en",
    "fcm_token": null,
    "is_active": true,
    "email_verified_at": null,
    "phone_verified_at": null,
    "created_at": 1733896939605,
    "updated_at": 1733896939605,
    "deleted_at": null,
    "profile_img": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAASwAAAEsCAYAAAB5fY51AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAS0ElEQVR4nO3dT4wU6XnH8e+OdhVrZK+9LVaVKBE4caQMKMof2OS0rHIDnyLgZMFauexyXeRcvHPJBaKcBisXMyhSEvBxQZYiAadIMDcvI1lKmJHiA/St7FY7ymHOOdTb0Mz09N+qet+q+n4uzDQz3S9a7U/P+9RTb72DdIw8H64DG+Hbj8Kf68DpsR9bB87M+ZYvgcHY96/Gvn8BHAD9LOsNkCZ4J/YCFE+eD08AJynC6ARwKnw9HlSx9CnC7EX4+tXo6yzr9WMuTPEYWB0wVil9BJyjqIg2KEKqiQ6AfeBrYC/8uW9l1n4GVgvl+XAD+AQ4TxFSsauluvQpwusZ8HWW9XYir0clM7BaIM+HH/MmoD6h2NKpsAM8pQixp1nWO4i8Hq3AwGqgUEFdBC5gQC1qB3hEEV5WYA1jYDVEng8vApcogupk5OW0xYCi+voZ8NjqK30GVqJCo/wicDX8aRVVvcfAQ+CBDfw0GVgJMaSSYnglyMBKQJ4PzwLXgcs0d9SgrQ4owutulvUex15M1xlYkYShzWsUQdWVsYOmGwDbwB2HV+MwsGoWRhBG1ZRbvuYaVV0PYi+kSwysGoTe1DXgBlZTbTMAtoBte13VM7AqFLZ9N4DPsTfVdgfAfWAry3r7sRfTVgZWBfJ8eJI3QeW2r3tGwbUbeyFtY2CVKEygb1Js/6Qd4MdO1JfHwCqBQaUZDK6SGFgrCD2qmxRbP2mWx8ANe1zLM7CWEK76jYLKHpUWdR/YdJZrcQbWgvJ8+AXF9s+rflrFAcUQ6qY3Xc/PwJpTGPi8i3NUKteAYpt4P/ZCmsDAmiGMKGxRTKZLVdkFPnMUYjoDa4o8H35Jsf2zT6W6bFNUXG4TJzCwJginJ/wMt3+KYwBc9z7FowysMeHq3ybwZey1SMADiuDyHsXAwArCEcR38PhhpeWAYou4HXshKeh8YFlVqSGstuh4YNmrUsN0vrfV2cAKA6A38Qqgmuc2HR047Vxghfv/7lE85EFqqn3gUtfuS1yLvYA6hWn15xhWar4N4HmeDzt1QkhnKqywBdyKvQ6pAp0ZNm19YIWrgPfw1hq12y7FFrHVJ0C0OrDCfYBP8CqgumFAEVqtPSiwtT2s0K/aw7BSd5wAnuX5sLUHSrYysMJ/sGc4sqBuupPnwzuxF1GF1m0J83y4BXwRex1SAh4DV9rUjG9NYNlclyZqVTO+FYEVwuoJ8HHstUgJ6gPn2xBajQ+scCXwGZ6yIE1zAFxo+hXERgeWYSUtpPGh1dirhOHhpYaVNL914Ek4+62RGhlYY/cEGlbSYtaBR02d1WrcljCE1ROcsZJWdb1pJ5k2KrAMK6l0jQqtxgSWYSVVpjGh1YjACg325xhWUlWuNOHo5eQDy9EFqRaNGHlIOrAMK6lWyYdWsoEVbrfZw7CS6nQAnEv1rPgk57DG7g00rKR6jYZLk/x/L8nAojh1wRuZpThOUoRWche5kguscJ6VR8RIcW1Q7HKSklRghdsFPHxPSsPHqZ1cmkzTPQyGPou9DklH3Miy3u3Yi4BEAis0+PZwMFRK1fezrPc49iKiB1Zo7D3Hp9tIKTsATsc+tTSFHtY9DCspdaNxh6i7oKiBFR4f7xVBqRk2gKhN+GhbQpvsUmNFa8JHCaw8H57AE0OlpjqgeArPbt0fHGtLeA/DSmqqdeBhjH5W7YEV+laNPQRfElAUHLX3s2rdEub58CxF38p5K6kdPs2y3v26Pqy2wHLeSmqlWuez6twSbmJYSW2zTo1bw1oCKzy48cs6PktS7S7m+bCW/78r3xJ6cqjUCbWcVFpHhbWJYSW13TqwVfWHVFphhauCz6v8DElJqfQZh1UH1h422qUuOQBOZVlvUMWbV7YlDE04w0rqlkqvGlZSYXkgn9R5lRz4V1WFtYVhJXXZVhX3GpYeWOHYGM+4krptA/i87DctfUtoo11SUHoDvtQKK5zEYFhJggpms0qrsMJ+9RVwoqz3lNQKp8uagC+zwrqJYSXpqLtlvVEpFVY48vgVXhmUNNn5LOvtrPomZVVYNzGsJB3vJ2W8ycoVVp4PNyiGRCVpmpVPJy2jwtos4T0ktd/KWbFSYIXq6tqqi5DUCRt5PlwpL1atsKyuJC1ipcxYuocVbnB+tcqHS+qkK1nWe7DML65SYd1Y4XclddfS2bFUheXclaQVLTWXtWyFdQPDStLyluplLVxhec+gpJIsfI/hMhXWNQwrSatbuJe1TIXleVeSyrDweVkLVVjhNFHDSlIZ1llw8HzRLeH1BX9ekqZZKFPm3hI6yiCpInOPOCxSYV3DsJJUvrmrrEUCy+2gpCpcDju4meYKrDwfnsVmu6RqrDPnowHnrbCsriRVaa6Mmdl0d7JdUk1mTr7PU2FdxLCSVL1PZ/3APIF1tYSFSNIsM4dIp24Jw3bwNzjOIKke57Kst3vcX86qsC5iWEmqz5VpfzkrsNwOSqrT1G3hPBWWJNXlZHga10THBlaeD90OSorh2CHSaRXWpQoWIkmzHNvHOvYqYZ4PXwEnK1mOXvvf3/4ff/Xnfxt7GSv55G/+mn/593+a+XNN/7f+4pc/5zsfvB97GV3x4aSD/SZWWGEPaVhJimVi//y4LaHNdkkxXZj04nGBNfGHJakmC1VYn1S4EEma5cSk8YYjgRUeNOE4g6TYjlRZkyosqytJKTh/+IVJgXXkhyQpgiPFkxWWpFQd6WO9FVjhL+1fSUrFR+PfHK6wrK4kpeStFtXhwLJ/JSklbxVRhwPrIyQpHRvh5GNgLLDCiz57UFJqzo6+eHfsRcOqwe7+6z/yrfe/GeWz36/5c2P9W7/5La9HRXIG2IG3A8vtYIP9xV+e6czRJ136twqAc6Mv1ia9KEkJeV1MjQfWmQgLkaRZXrer1ia9KEkJWc/z4UkIgZXnwxP4OHpJ6ToDbyosj0OWlLI3FRZeIZSUtnPwJrDcDkpK2Ql4E1inIi5Ekmb5LrgllNQMZ+FNYHnPgaSk5flwfRRYzmBJSt3G2vjRDZKUsPU1rK4kNcOZ4x6kKknJWcMrhJKa4ZwVlqTGWMORBknNsL4GnI69Ckmaw5l3Z/+MmuDvrv497733XuWf87u/9yH//NN/qPxzpEkMrJb47//6n1o+59Rvf7+Wz5lm78Wv+KD37co/5xvf+B2++4d/UPnnaH7vYg9LDfPDH/yols/50z/7Ex7+x09r+SzNZX0Nz3KX1AwbjjVIagwDS1JjGFiSGsPAktQYBpakxjCwJDWGgSWpMQwsSY1hYElqjDXgZexFSNIc+u8Cg9ir0Op+8cuf850P3o+9DKlKA7eEkhrD42XUOFaT3bUGvIq9CEmaw8s17GFJagZ7WJKaYw14EXsRkjSHvTXgIPYqJGkOB2tAP/YqJGkO/bUs69l0l9QEvx413a2yJKWuPwosqyxJScuy3uuxBq8USkrZPrw5XsYtoaSUvYQ3geXtOZJS1oc3geWWUFLK9sAtoaRmeFNhZVmvjxPvktL1At4+030/0kIkaaos6711lRDg60hrkaRpdkdfjAfWXoSFSNIsry8KWmFJSt3z0RfjZ7rbw2qwvRe/4oPet6N89nvvvcv3/vhUlM9WJ7zOpteBlWW9QZ4P+8DJKEvSSn74gx9F++w/+t5Jnvznv0X7fLXe693f4SOS3RZKSkl//Aisw4H1rObFSNI0T8e/scKSlLLn49+8FVhZ1tupdy2SNNXUCgvA0JKUgoMs6+2OvzApsJ5OeE2S6nYkiyYFlo13SSk4kkVWWJJSNbvCyrLeAfaxJMV1MOki4KQKC+BRxYuRpGkeT3rxuMByWygppom99ImBFUoxn1UoKZYHk148rsICqyxJcfTDse1HvHPcb+T58DLwVWVLkqTJbmVZb3PSX0yrsCY2vSSpYsde9Ds2sMJ4g6ElqU6Dafc0T6uwAB6WvBhJmmZis31kVmBN/WVJKtnUImlqYIWT/twWSqrDIMt6U/NmVoUFbgsl1WPmjm6ewHqAj7GXVL17s35gZmC5LZRUg/48Jx7PU2EB3F1xMZI0zZ15fujYSffD8nz4G+DE0suRpOOdOu52nHHzVlgA2yssRpKO83iesILFAmuukk2SFjR3y2nuLSFAng8fARcXXo4kTTbIst6H8/7wIhUW2HyXVK6FWk0LVVhg811SqeZqto8sWmEBbC3xO5J02INFwgqWC6xtnHyXtLqFi5+FAytMvt9f9PckaczuPJPthy1TYYHbQkmrWSpDlgqsLOvtY5UlaTn7WdZbKj+WrbDAKkvScpbOjqUDK8t6u/hIe0mLWakHvkqFBfDjFX9fUrfcDA+4WcpKgRW6/FZZkuYxYMVDFFatsMAqS9J8VqquoITAClWWJ5JKmqZPCUdUlVFhAdwo6X0ktdPmqtUVlBRYzmVJmmLpuavDyqqwADbxHkNJR5W2AystsMJd1x6jLGnczqyHoy6izAoLiiprUPJ7Smquz8p8s1IDKzTVbMBLArgd+tulWfjE0Xnk+fA5cLaK95bUCAPgdDiOqjRlbwlHSi0DJTXOZtlhBRUFVrgx2ga81E27Wdar5P//qiosKHpZNuCl7rla1RtXFlihAX+9qveXlKRbZTfax1VZYZFlvQfAgyo/Q1Iy9oGbVX5ApYEVXMcJeKkLPivjfsFpKg+scKXA2Syp3baXeQrOoiqZw5okz4dfAZfr+jxJtdkHzlVdXUE9W8KR63jVUGqjq3WEFdQYWGFr6FVDqV1uhbnLWtS2JRzJ8+EW8EXdnyupdDtZ1jtf5wfWuSUc2aTY80pqrgMqHBA9Tu2BFfa6l3DUQWqyT8MZeLWKUWGNjlS2nyU10+0wFF67KIEFEM549gZpqVl2KNo6UUQLrOAGUNsVBkkrGVDjCMMktV8lPCzPhyeB58CJ2GuRNNX5OqbZp4ldYY0eXnEp9jokTXUjdlhBAoEFr58ebRNeStN2lvVux14EJBJYAOGEQpvwUlp2SOjwgug9rMPyfPgIuBh7HZLoUzxIIpmZyWQqrDFX8MqhFNuAosmeTFhBgoE1Nglf+xStJKC4C+VSjEn2WZLbEo6EcYc9YD32WqSO+X6Zj5cvU3IV1khI9wt4z6FUp+uphhUkXGGN5PnwY+AJVlpS1a5X9TzBsiRbYY2EGa0rsdchtdxm6mEFDQgsgFCiOlgqVWM7y3q3Yi9iHslvCcfl+fBz4E7sdUgtsp1lvcYUA40KLDC0pBI1KqyggYEFhpZUgsaFFTSkh3VYaA5ewZEHaRmbTQwraGiFNeLIg7Sw5EcXpml0YIGhJS2g0WEFLQgsgDwfblCE1snYa5ESdABcSXmCfV6tCCx4fe/hE2Aj9lqkhAwobmSOflpoGVoTWAB5PlynCK2PY69FSkCf4oiY5E5dWFarAmskz4d3gM9jr0OKaAe4kNp5Vqtq5FjDLOGSbTLHuko126aFYQUtrbBG8nx4EfgKryCqO26k8sCIKrQ6sMBmvDqjVc3147RySzguNBzPAfdjr0WqyA5wru1hBR2osMbl+fAL4CZuEdUetylutWldv2qSTgUWQJ4PzwIPcchUzXYAfJplvQexF1Kn1m8JD8uy3i5wGreIaq4diucFdiqsoIMV1rg8H16jOKbGLaKa4laW9TZjLyKWTgcWvL6KeAefNq207QNXww6hszofWCN5PvwS2MRqS+nZppiv6kRjfRoDa0w49WELqy2lYR/4rAvjCvMysCYIRzBvYbWleG4BN62q3mZgHSPPhycoeluXY69FnbJL0avaj72QFBlYM4T7Ebfw1h5Va0BDHmYak4E1h3DO1uc4Ja9q3KbY/g1iLyR1BtYCwjZxC7gWey1qhR2KprrbvzkZWEsIVxPv4smmWs4+xZhC489Yr5uBtYLwxJ6fAGdjr0WN0KfoU3lb2JIMrBKEW3w2sTGvyQYU/c9txxRWY2CVyODSIQZVyQysCuT58DLFmfL2uLppn+LizH2DqlwGVoVCj2sTb/Xpil1gyx5VdQysGoSrijcoxiGc42qfBxRB5T1/FTOwahTmuK4B17HP1XQDilMU7rTpQaWpM7AiCdvF6xT3Klp1Ncdj4G4XT/tMgYEVWai6LlOEl/NcaepT3Ah/32oqLgMrIaHX9SnFttGHZMQ1oOhN3bM3lQ4DK1Hh6T5XMLzqNAqph942kyYDqwFC5XWZIsDcNparT/EEpUdWUukzsBom9LwuAhfCnyfirqhxDiga58+AB/akmsXAarhQfV0EzgOfYIAddgA8pQiop1ZRzWZgtUwIsI94E2Bdm/fqUwTUc4qA6vRjsdrGwGq5cFrqWeAMcI4izDZox+zXLvCCIpz2ga89tbPdDKyOCg+QPUNxBfIcxVbyu6TX1N8HXlJUTnvhzxee0tlNBpaOCFXZqAo7E14+F/4cf230/bzbzj7F6MDIy7Hv9yj6TX3g10DfakmH/T+4m6mNNa0jsgAAAABJRU5ErkJggg==",
    "userable": {
      "id": "30d1305d-0cdb-4400-8619-d0b82d6d2e56",
      "created_by": null,
      "qoyod_id": null,
      "type": null,
      "gender": null,
      "tax_number": null,
      "zip_code": null,
      "city": null,
      "district": null,
      "street": null,
      "crn": null,
      "created_at": 1733896939727,
      "updated_at": 1733896939727,
      "creator": null
    }
  }
}
Previous
List
Next
Create
Built with