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

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
/orders/{orderId}
It is an endpoint designed to fetch comprehensive information about specific orders within a system or platform. This API allows users to retrieve detailed data related to orders, such as order ID, customer information, order status, items purchased, pricing, payment details, shipping information, and timestamps

Path Parameters#

Validation :#

FieldTypeRuleDescription
orderIdstringrequiredId from Order model

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Path Params
orderId
string 
required
Example:
b09b5f32-7aba-4d83-86e4-e8fdcb354a40

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/orders/b09b5f32-7aba-4d83-86e4-e8fdcb354a40'

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 
required
number
string 
required
source
string 
required
type
string 
required
status
string 
required
table_code
null 
required
notes
null 
required
customer_id
null 
required
cashier_id
string 
required
created_at
integer 
required
updated_at
integer 
required
deleted_at
null 
required
is_product_changed
boolean 
required
table_id
null 
required
qr_img
string 
required
market
object 
required
branch
object 
required
customer
null 
required
cashier
object 
required
table
null 
required
status_logs
array [object {4}] 
required
transaction
object 
required
products
array [object {25}] 
required
return_products
array[string]
required
changed_products
array[string]
required
product_fees
array [object {14}] 
required
product_discount_fees
array[string]
required
product_tax_fees
array [object {14}] 
required
product_ratings
array[string]
required
Example
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Data Loaded Successfully"
  },
  "data": {
    "id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
    "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
    "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
    "number": "0004",
    "source": "ADMIN_WEB",
    "type": "TAKE_AWAY",
    "status": "CANCELED",
    "table_code": null,
    "notes": null,
    "customer_id": null,
    "cashier_id": "0756d11b-4a6e-4739-adf7-899e58de0885",
    "created_at": 1698176924059,
    "updated_at": 1698176924059,
    "deleted_at": null,
    "is_product_changed": true,
    "table_id": null,
    "qr_img": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAIAAACx0UUtAAAABnRSTlMA/wD/AP83WBt9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAFY0lEQVR4nO3dSW4kORBFwVaj739l9T4WrCI4xFPKbKuMQYkPIh0knV/f39//QNi/b78A/IGMUiej1MkodTJKnYxSJ6PUySh1MkqdjFIno9TJKHUySp2MUiej1MkodTJKnYxSJ6PU/bdy8dfX1673GHtsuno8d+NfH1b+wfFzN5p60LW3Gj93inGUOhmlTkapk1Hqlmqmh43tJDb+8N9Y96zceerLOffO56592FiNGUepk1HqZJQ6GaVuZ830ECkpVuqe8bUrpdu1yaGpebXxtWPnGjAaR6mTUepklDoZpe5gzdR0ruDYWDSsrDb8PMZR6mSUOhmlTkap+4Sa6dxM0sqtVgqdlQmelYmlJuModTJKnYxSJ6PUHayZzv1a31gkNdfmjf+6sQoci9RbxlHqZJQ6GaVORqnbWTNdWyS2smTu2jq3yJ2v9Qk8xzhKnYxSJ6PUySh1SzXTW/MQ12awNk4OTfkRLcCvMY5SJ6PUySh1Mkrd18qv5mttvD9+rujhrX9w/BpTt9q4rco4Sp2MUiej1MkodUs10x9ufWvbzbkNTNcOop0SOUp45VZTjKPUySh1MkqdjFJ3cJ5p4+TQtQpj44OunYd7rlFepAWfcZQ6GaVORqmTUep2zjNtLKGm7jx+0FjkeNwpG+d7mhNpD8ZR6mSUOhmlTkap29k3LzIbdG0v1FsnMK18+NoWJfuZ+EVklDoZpU5GqVuqmTbWHyu/9JuvMfWgjQsXN374WiuKMeModTJKnYxSJ6PUvbY2b+pW57YZrbzzW23lrn05b93qwThKnYxSJ6PUySh1O+eZpj688SSkFSsLzKau3Xhc07VzafWAgL8io9TJKHUySt3OvnnNNgfjO0eOp4q00Xurm/iYcZQ6GaVORqmTUeoOns/0fFLjgNSxjW0ONq76+7z24VOMo9TJKHUySp2MUlfZzxSZaLl2q4fmnaceNKZvHp9MRqmTUepklLrX5pnOdT1oHo/71pG+K87165tiHKVORqmTUepklLrombbNhXznem+fa+MdOWNphXGUOhmlTkapk1HqdvaAmBJZjXat0Dk3N3bteKopzrTlF5FR6mSUOhml7mDfvHNnnkYaKDz8iBm7H9H04cE4Sp2MUiej1MkodffmmTYWOtfOK9q46WrjX6esTIZFVkgaR6mTUepklDoZpW7pTNuHqV/cU39dOUz24dxEy8Yy6K3KZurD16asjKPUySh1MkqdjFJ3rwfEw7UFZhsb1p2b73lrWeNbu52mGEepk1HqZJQ6GaXuYM10bsnc2MaOCT/ibKeHc//+WxunjKPUySh1MkqdjFK3tDZv5Uf0uXmXjVujmgfRXlsDee1IrTHjKHUySp2MUiej1C3VTOe6ep+re6beeXyrc1NlU95aXTlmnolfREapk1HqZJS6nT0gHs5tf5kqgyJdD1ZKxqkPT30bK69xrSWEcZQ6GaVORqmTUepeO9N2ylvr65otEq5NwkWmnYyj1MkodTJKnYxSd7DX+IqVX+sb64Br26qmrj3XzW/lWj0g+L1klDoZpU5Gqds5z9Q8EfXaXNG5Y3nH1z5ca1s+xTwTn0xGqZNR6mSUuoP7mc45t97sXIVxbhpmZQPTxt1d57464yh1MkqdjFIno9T9yJppyrl5po0LCMfGa/PO0QMC/oqMUiej1MkodT+yb17kuVOdyM81rJt6q3Nbo84xjlIno9TJKHUySt3OmumtX9xvLTCbmv45V0KNXTva6tz5v8ZR6mSUOhmlTkapW+oBARcYR6mTUepklDoZpU5GqZNR6mSUOhmlTkapk1HqZJQ6GaVORqmTUepklDoZpU5GqZNR6mSUuv8BiICj3voU37IAAAAASUVORK5CYII=",
    "market": {
      "id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
      "sector_id": 1,
      "name_en": "First Restaurant",
      "name_ar": "First Restaurant",
      "description_en": "Ut maxime commodi natus id tenetur ullam. Repudiandae aut quia est perspiciatis facilis dolores repellendus ea eum. Iusto occaecati libero ea voluptas dolore qui qui maxime quod. Eum ut vel possimus sunt doloribus saepe repellendus et.",
      "description_ar": "العظمى إستيلاء الأوروبية، حين عل. هو وبعد قتيل، العالمي ولم, يونيو مساعدة التاريخ، وصل تم. بـ سكان الجو اليابان تحت, يتم لأداء تكتيكاً قُدُماً ان. نفس موالية الجنوبي ما, أضف تم غضون أسابيع وقوعها،. وبدون ميناء الأمريكية فقد عل, قتيل، معارضة ضرب عن, دول وبعض لفرنسا تزامناً ثم. أي أدوات استبدال جعل. يكن لغات مشروط من.",
      "logo_img": null,
      "cover_img": null,
      "email": "[email protected]",
      "phone_prefix": "966",
      "phone": "579112767",
      "crn": null,
      "tax_number": "12345611",
      "created_by": null,
      "email_verified_at": null,
      "phone_verified_at": null,
      "created_at": 1680271006362,
      "updated_at": 1683019078189,
      "deleted_at": null,
      "setting": {
        "id": 1,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "balance": 0,
        "income": 0,
        "receipt_message_en": null,
        "receipt_message_ar": null,
        "qoyod_api_key": null,
        "grubtech_api_key": "ZElHttueqZ40ajMQhIjOQ5WaCxC7lSVB96nB2oc9",
        "grubtech_store_id": "FLAVOURS_STORE_1",
        "currency": "OMR",
        "order_num_start": null,
        "is_qoyod_daily_update": false,
        "grubtech_integration_mode": null,
        "is_tax_details": false,
        "tap_payment_secret_key": null,
        "tap_payment_public_key": null,
        "is_offline_calculate": false
      }
    },
    "branch": {
      "id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
      "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
      "name_en": "First Branch",
      "name_ar": "First Branch",
      "address": "8541 Moore Highway, Tianna Port",
      "latitude": -60.8672,
      "longitude": -168.4564,
      "is_active": true,
      "created_at": 1680271006388,
      "updated_at": 1682927489279,
      "deleted_at": null,
      "expired_at": null
    },
    "customer": null,
    "cashier": {
      "id": "0756d11b-4a6e-4739-adf7-899e58de0885",
      "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
      "branch_id": null,
      "permission_id": 2,
      "user": {
        "id": "f64b8da0-429b-4377-9a03-19724f43465b",
        "userable_id": "0756d11b-4a6e-4739-adf7-899e58de0885",
        "role": "SUBSCRIBER",
        "name": "Subscriber 1",
        "username": "subscriber1",
        "email": "[email protected]",
        "phone_prefix": "966",
        "phone": null,
        "lang": "en",
        "fcm_token": null,
        "is_active": true,
        "email_verified_at": null,
        "phone_verified_at": null,
        "created_at": 1680271006727,
        "updated_at": 1684892194280,
        "deleted_at": null
      }
    },
    "table": null,
    "status_logs": [
      {
        "id": 131,
        "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
        "status": "WAITING",
        "created_at": 1698176924121
      },
      {
        "id": 136,
        "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
        "status": "PROCESS",
        "created_at": 1698176944796
      },
      {
        "id": 137,
        "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
        "status": "CANCELED",
        "created_at": 1698177017429
      }
    ],
    "transaction": {
      "id": 18000043767,
      "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
      "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
      "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
      "discount": 0,
      "tax": 1.96,
      "subtotal": 13.04,
      "total": 15,
      "cost": 0,
      "profit": 0,
      "created_at": 1698176924075,
      "updated_at": 1698176924075,
      "status": "UNPAID",
      "discount_id": null,
      "payment_fees": 0,
      "related_discount": null,
      "payments": [],
      "return_payments": []
    },
    "products": [
      {
        "id": 9000044898,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
        "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
        "product_category_id": 5,
        "product_id": "6f6a98b3-a3c8-4071-914f-04ca8fc8fcf2",
        "qty": 1,
        "price": 13.04,
        "discount": 0,
        "tax": 1.96,
        "subtotal": 13.04,
        "total": 15,
        "cost": 0,
        "profit": 0,
        "is_done": false,
        "created_at": 1698176924081,
        "updated_at": 1698177017253,
        "status": "RELATED",
        "product_category": {
          "id": 5,
          "icon": "🍱",
          "name_en": "Side Dishes",
          "name_ar": "اطباق جانبية",
          "deleted_at": null
        },
        "product": {
          "id": "6f6a98b3-a3c8-4071-914f-04ca8fc8fcf2",
          "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
          "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
          "product_category_id": 5,
          "name_en": "Bakso",
          "name_ar": "كرات اللحم",
          "description_en": null,
          "description_ar": null,
          "preparation_time": 20,
          "stock": null,
          "order": 4,
          "images": [
            "https://cdn-flavours.fra1.cdn.digitaloceanspaces.com/img/uploads/products/1685619367-0.jpg"
          ],
          "is_active": true,
          "created_at": 1685619367346,
          "updated_at": 1685619367346,
          "deleted_at": null,
          "rating_amount": 0,
          "rating_avg": "0.00",
          "sold_amount": 0,
          "sold_revenue": 0,
          "qoyod_id": null
        },
        "modifiers": [
          {
            "id": 2749,
            "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
            "order_product_id": 9000044898,
            "product_modifier_id": 5637,
            "weight": null,
            "price": 13.04,
            "discount": 0,
            "tax": 1.96,
            "total": 15,
            "cost": 0,
            "profit": 0,
            "modifier": {
              "id": 5637,
              "product_id": "6f6a98b3-a3c8-4071-914f-04ca8fc8fcf2",
              "name_en": "Medium",
              "name_ar": "واسطة",
              "type": "OPTION",
              "calorie": 5,
              "price": 13.04,
              "tax": 1.96,
              "total": 15,
              "cost": null,
              "profit": null,
              "is_tax_included": true,
              "deleted_at": null,
              "barcode": null,
              "barcode_img": null,
              "weight_amount": null,
              "weight_unit": null
            }
          }
        ],
        "fees": [
          {
            "id": 30318,
            "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
            "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
            "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
            "order_product_id": 9000044898,
            "feeable_id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
            "feeable_type": "TAX",
            "qty": 1,
            "amount": 1.96,
            "total": 1.96,
            "created_at": 1698177017332,
            "updated_at": 1698177017332,
            "order_product_modifier_id": null
          }
        ],
        "discount_fees": [],
        "tax_fees": [
          {
            "id": 30318,
            "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
            "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
            "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
            "order_product_id": 9000044898,
            "feeable_id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
            "feeable_type": "TAX",
            "qty": 1,
            "amount": 1.96,
            "total": 1.96,
            "created_at": 1698177017332,
            "updated_at": 1698177017332,
            "order_product_modifier_id": null
          }
        ],
        "rating": null
      }
    ],
    "return_products": [],
    "changed_products": [],
    "product_fees": [
      {
        "id": 30318,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
        "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
        "order_product_id": 9000044898,
        "feeable_id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
        "feeable_type": "TAX",
        "qty": 1,
        "amount": 1.96,
        "total": 1.96,
        "created_at": 1698177017332,
        "updated_at": 1698177017332,
        "order_product_modifier_id": null,
        "feeable": {
          "id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
          "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
          "branch_id": null,
          "name_en": "Tax",
          "name_ar": "ضريبة",
          "value": 15,
          "value_type": "PERCENT",
          "is_active": true,
          "created_at": 2023,
          "updated_at": 2023,
          "deleted_at": null,
          "is_calculate": true
        }
      }
    ],
    "product_discount_fees": [],
    "product_tax_fees": [
      {
        "id": 30318,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
        "order_id": "0d7a87b3-35dd-493f-80a4-accb90e24ab2",
        "order_product_id": 9000044898,
        "feeable_id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
        "feeable_type": "TAX",
        "qty": 1,
        "amount": 1.96,
        "total": 1.96,
        "created_at": 1698177017332,
        "updated_at": 1698177017332,
        "order_product_modifier_id": null,
        "feeable": {
          "id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
          "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
          "branch_id": null,
          "name_en": "Tax",
          "name_ar": "ضريبة",
          "value": 15,
          "value_type": "PERCENT",
          "is_active": true,
          "created_at": 2023,
          "updated_at": 2023,
          "deleted_at": null,
          "is_calculate": true
        }
      }
    ],
    "product_ratings": []
  }
}
Previous
List
Next
Create
Built with