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

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
/products/{productId}
The product details API retrieves comprehensive information about a specific product, including its ID, name, description, price, stock, and other relevant attributes.

Path Parameters#

Validation :#

FieldTypeRuleDescription
productIdstringrequiredId from Product model

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
productId
string 
required
Example:
fc0b14ae-f712-4c77-89f7-d863e60a5ba6

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/products/fc0b14ae-f712-4c77-89f7-d863e60a5ba6'

Responses

🟢200OK
application/json
Body
meta
object 
required
code
integer 
required
status
string 
required
message
string 
required
data
object 
required
id
string 
required
market_id
string 
required
branch_id
string  | null 
required
product_category_id
integer 
required
name_en
string 
required
name_ar
string 
required
description_en
string  | null 
required
description_ar
string  | null 
required
preparation_time
integer 
required
stock
integer 
required
order
integer 
required
images
array[string] | null 
required
is_active
boolean 
required
created_at
integer 
required
updated_at
integer 
required
deleted_at
integer  | null 
required
rating_amount
integer 
required
rating_avg
string 
required
sold_amount
integer 
required
sold_revenue
integer 
required
qoyod_id
string  | null 
required
options_min_total
integer  | null 
required
options_max_total
integer  | null 
required
market
object 
required
branch
object  | null 
required
category
object 
required
options
array [object] 
required
additionals
array[string]
required
Example
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Data Loaded Successfully"
  },
  "data": {
    "id": "fc0b14ae-f712-4c77-89f7-d863e60a5ba6",
    "market_id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
    "branch_id": null,
    "product_category_id": 80,
    "name_en": "Penne pasta",
    "name_ar": "بيني باستا",
    "description_en": null,
    "description_ar": null,
    "preparation_time": 10,
    "stock": 0,
    "order": 1,
    "images": [
      "https://flavours-files.s3.me-south-1.amazonaws.com/img/uploads/products/1700962519-0.JPG"
    ],
    "is_active": true,
    "created_at": 1700934146978,
    "updated_at": 1734263564644,
    "deleted_at": null,
    "rating_amount": 0,
    "rating_avg": "0.00",
    "sold_amount": 12,
    "sold_revenue": 0,
    "qoyod_id": null,
    "options_min_total": null,
    "options_max_total": null,
    "market": {
      "id": "b5d70a92-5d2e-4f89-8e52-1827cfbd01f4",
      "sector_id": 3,
      "slug": null,
      "name_en": "flavours",
      "name_ar": "فليفرز",
      "description_en": "res",
      "description_ar": "مطعم",
      "logo_img": "https://flavours-files.s3.me-south-1.amazonaws.com/img/uploads/markets/logos/1720926739.jpg",
      "cover_img": null,
      "email": "[email protected]",
      "phone_prefix": "966",
      "phone": "581157875",
      "crn": null,
      "tax_number": "10101010101020",
      "created_by": "ad3ffe2c-0986-439e-a519-2f5032af3c6c",
      "email_verified_at": null,
      "phone_verified_at": 1713453448327,
      "created_at": 1700933589182,
      "updated_at": 1741327188815,
      "deleted_at": null,
      "is_active": true,
      "merchant_id": null,
      "reseller_id": null
    },
    "branch": null,
    "category": {
      "id": 80,
      "icon": "🍝",
      "name_en": "Pasta",
      "name_ar": "باستا",
      "deleted_at": null,
      "created_at": null,
      "updated_at": null
    },
    "options": [],
    "additionals": []
  }
}
Previous
List
Next
Create
Built with