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

Update

Developing
DEVELOPMENT
https://api.flavours.sa/dev/api/v2
DEVELOPMENT
https://api.flavours.sa/dev/api/v2
POST
https://api.flavours.sa/dev/api/v2
/orders/{orderId}

Constant#

Use the constants below according to the field names and rules for each request
ConstantValue
sourceADMIN_APP ADMIN_WEB LANDING_APP LANDING_WEB GRUBTECH
typeTAKE_AWAY DINING DRIVE_THROUGH DELIVERY
statusWAITING PROCESS COMPLETED CANCELED DELIVERY

Validation#

FieldTypeRuleDescription
branch_idstringnullableId from Branch model
sourcestringnullableFrom source constant above
typestringnullableFrom type constant above
statusstringnullableSee valid status below
notesstringnullable
discount_idstringnullableId from Discount model
table_idintegernullableId from Table model
customer_idstringnullableId from Customer model
cashier_idstringnullableId from Cashier model
productsarraynullable
products.*.product_idstringrequiredId from Product model
products.*.qtyintegerrequired min:0
products.*.modifiersarrayrequired
products.*.modifiers.*.product_modifier_idintegerrequiredId from ProductModifier model
products.*.modifiers.*.weightnumericnullable min:0
paymentsarraynullable
payments.*.payment_method_keystringrequiredKey from PaymentMethod model
payments.*.valuenumericrequired min:0
payments.*.givennumericnullable min:0
The rules on the fields will change depending on conditions, including the following
Current StatusValid Status
WAITINGWAITING PROCESS COMPLETED CANCELED
PROCESSPROCESS COMPLETED CANCELED
COMPLETEDCOMPLETED CANCELED
CANCELEDCANCELED

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:
ad757b52-c1c7-4996-a029-83d218cacb66
Body Params application/json
market_id
string 
optional
branch_id
string 
optional
source
string 
optional
type
string 
optional
status
string 
optional
notes
string 
optional
discount_id
string 
optional
table_id
integer 
optional
customer_id
string 
optional
cashier_id
string 
optional
products
array [object {3}] 
optional
product_id
string 
required
qty
integer 
required
modifiers
array [object {2}] 
required
payments
array [object {3}] 
optional
payment_method_key
string 
required
value
number 
required
given
number 
optional
Example
{
  "products": [
    {
      "product_id": "8447de4e-740e-4181-a377-6dfa3f4d3aa2",
      "qty": 1,
      "modifiers": [
        {
          "product_modifier_id": 5626
        }
      ]
    }
  ],
  "notes": "Ea illum autem est commodi. Temporibus et quia.",
  "status": "PROCESS"
}

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 POST 'https://api.flavours.sa/dev/api/v2/orders/ad757b52-c1c7-4996-a029-83d218cacb66' \
--header 'Content-Type: application/json' \
--data-raw '{
    "products": [
        {
            "product_id": "8447de4e-740e-4181-a377-6dfa3f4d3aa2",
            "qty": 1,
            "modifiers": [
                {
                    "product_modifier_id": 5626
                }
            ]
        }
    ],
    "notes": "Ea illum autem est commodi. Temporibus et quia.",
    "status": "PROCESS"
}'

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
string 
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
customer
null 
required
cashier
object 
required
table
null 
required
status_logs
array [object {4}] 
required
transaction
object 
required
products
array [object {21}] 
required
return_products
array[string]
required
changed_products
array [object {20}] 
required
product_discount_fees
array[string]
required
product_tax_fees
array [object {14}] 
required
Example
{
  "meta": {
    "code": 200,
    "status": "success",
    "message": "Order Successfully Updated"
  },
  "data": {
    "id": "ad757b52-c1c7-4996-a029-83d218cacb66",
    "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
    "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
    "number": "0001",
    "source": "ADMIN_WEB",
    "type": "TAKE_AWAY",
    "status": "PROCESS",
    "table_code": null,
    "notes": "Ea illum autem est commodi. Temporibus et quia.",
    "customer_id": null,
    "cashier_id": "0756d11b-4a6e-4739-adf7-899e58de0885",
    "created_at": 1698586104719,
    "updated_at": 1698586104719,
    "deleted_at": null,
    "is_product_changed": true,
    "table_id": null,
    "qr_img": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAOEAAADhCAIAAACx0UUtAAAABnRSTlMA/wD/AP83WBt9AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAFbElEQVR4nO3dy47rNhBF0XSQ///lzlwD3jB8aHd7raltSTYOCBdIFr++v7//grC/334A+AMZpU5GqZNR6mSUOhmlTkapk1HqZJQ6GaVORqmTUepklDoZpU5GqZNR6mSUOhmlTkap+2flw19fX7ueY+yx6epx32uvPoy//vjKG03d6NpTje87xThKnYxSJ6PUySh1SzXTw8Z2Ehv/+E+VBStF0sqV37rRxs8+bKzGjKPUySh1MkqdjFK3s2Z62FisnLvy1LTT+MpTpdu1yaGpmbPxZ8fONWA0jlIno9TJKHUySt3Bmqnp3BTOxqJhZT3h72McpU5GqZNR6mSUut9QM23cdTR+dWU26Np6wpWJpSbjKHUySp2MUiej1B2smc79W7/WmuHx5pX7buxMsVIFTonUW8ZR6mSUOhmlTkap21kzXVskNjWVcm76Z+Mc1ZRzz9xc5mccpU5GqZNR6mSUuqWa6a15iMj8x7ltRj+iBfg1xlHqZJQ6GaVORqn7WvnXfK6fwsaVbE3nuvmde4ypS23cVmUcpU5GqZNR6mSUuuh+po1/wH/Eka/jxzjnrXOwphhHqZNR6mSUOhmlbmmeae5OyemflfOKVgq7a0dMrYi04DOOUiej1MkodTJKXaVm2rhEcOOxrW9dauVGY9cm0jZ+X+ModTJKnYxSJ6PURfvmbdzPtFIlXGsQPrayFvHh2hYl+5n4IDJKnYxSJ6PU7ewBsbGyWbnRlI0zSSs3WvmC1zZsbfzsFOModTJKnYxSJ6PU3auZHs71zZu61MY3r9i4rWpK81IPxlHqZJQ6GaVORqk7uDbvrWmJc0sEH67NUb1VyekBAf+JjFIno9TJKHX3ekBMiUwOXTsYKdJG79oqxynGUepklDoZpU5GqdtZM701z3RuNujaJqSVx5gSmTqaYhylTkapk1HqZJS6g2faTjl3iO2Klbpnqo3e483nSsa3Fj3qAcFvJqPUySh1MkrdUs30I073mSq/puaKzi2om/rsubmicy34phhHqZNR6mSUOhmlbmffvLHm+bAbNY+ajZyxtMI4Sp2MUiej1Mkodff2M43f/LDxzKFzj3HtrKNrh1c1N04ZR6mTUepklDoZpe7e2rypv/bXZjgiJxJd+zWuzRU5n4kPIqPUySh1Mkrda2vzIkcfjW3subfx1SkbZ+xWbmSeid9MRqmTUepklLqleaZzu3DOVRjXpqxWHvKtymbqzdemrIyj1MkodTJKnYxSd7DX+LmNNT+iOplyrl/fud1dY9bm8UFklDoZpU5GqTtYM721Gu3hWh+Hh7fa6G1sGLHx1RXGUepklDoZpU5Gqdu5n+lHXOqtlXvXOuO9tSfp3A9rHKVORqmTUepklLqdvcb/cKdGC/Br3SWufcGxczN24xuZZ+KDyCh1MkqdjFJ3cG3ew8bdMG/167tWrJzbsbTxK1xrCWEcpU5GqZNR6mSUunvnM614/B+fOs1o6sobXVvmd21J5MZuGlOMo9TJKHUySp2MUrdznmljlXCtB8S5z44vNTYuZd56qvFnrc3jc8kodTJKnYxSd7AHxFsnor5VQ6zM2Wz8gtf6o08xz8RvJqPUySh1Mkrdvf1MG52bK9q4Vm3lylNWNjCd67WxkXGUOhmlTkapk1HqfmTNNBY53OjcU73V6nD8qh4QfC4ZpU5GqZNR6g7WTNf+2l/bWLPxMa51W7i2Neoc4yh1MkqdjFIno9TtrJki/7jPnQ+78cjXlRWDU879GuNLTT3GmHGUOhmlTkapk1Hq7p1pC/+PcZQ6GaVORqmTUepklDoZpU5GqZNR6mSUOhmlTkapk1HqZJQ6GaVORqmTUepklDoZpU5GqfsXjA+syRXJIQUAAAAASUVORK5CYII=",
    "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
    },
    "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": 147,
        "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
        "status": "WAITING",
        "created_at": 1698586104785
      },
      {
        "id": 148,
        "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
        "status": "PROCESS",
        "created_at": 1698596703228
      }
    ],
    "transaction": {
      "id": 18000043781,
      "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
      "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
      "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
      "discount": 0,
      "tax": 0.83,
      "subtotal": 5.5,
      "total": 6.33,
      "cost": 4.5,
      "profit": 1,
      "created_at": 1698586104738,
      "updated_at": 1698586104738,
      "status": "UNPAID",
      "discount_id": null,
      "payment_fees": 0,
      "related_discount": null,
      "payments": [],
      "return_payments": []
    },
    "products": [
      {
        "id": 9000044908,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
        "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
        "product_category_id": 2,
        "product_id": "8447de4e-740e-4181-a377-6dfa3f4d3aa2",
        "qty": 1,
        "price": 5.5,
        "discount": 0,
        "tax": 0.83,
        "subtotal": 5.5,
        "total": 6.33,
        "cost": 4.5,
        "profit": 1,
        "is_done": false,
        "created_at": 1698586104742,
        "updated_at": 1698596702970,
        "status": "RELATED",
        "product": {
          "id": "8447de4e-740e-4181-a377-6dfa3f4d3aa2",
          "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
          "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
          "product_category_id": 2,
          "name_en": "Burger Deluxe",
          "name_ar": "برجر ديلوكس",
          "description_en": "Tempore recusandae vel atque voluptatibus ea et nihil. Veniam eveniet laudantium cupiditate ratione non. Asperiores rem maiores neque inventore possimus itaque eum rerum. Delectus accusantium sit facilis. Ea voluptatibus natus quas eius commodi enim enim.",
          "description_ar": "Tempore recusandae vel atque voluptatibus ea et nihil. Veniam eveniet laudantium cupiditate ratione non. Asperiores rem maiores neque inventore possimus itaque eum rerum. Delectus accusantium sit facilis. Ea voluptatibus natus quas eius commodi enim enim.",
          "preparation_time": 15,
          "stock": 765,
          "order": 2,
          "images": [
            "https://cdn-flavours.fra1.digitaloceanspaces.com/img/uploads/products/1680365973-0.jpg"
          ],
          "is_active": true,
          "created_at": 1680271006454,
          "updated_at": 1684589809294,
          "deleted_at": null,
          "rating_amount": 0,
          "rating_avg": "0.00",
          "sold_amount": 64,
          "sold_revenue": 64.5,
          "qoyod_id": null
        },
        "modifiers": [
          {
            "id": 2759,
            "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
            "order_product_id": 9000044908,
            "product_modifier_id": 5626,
            "weight": null,
            "price": 5.5,
            "discount": 0,
            "tax": 0.83,
            "total": 6.33,
            "cost": 4.5,
            "profit": 1,
            "modifier": {
              "id": 5626,
              "product_id": "8447de4e-740e-4181-a377-6dfa3f4d3aa2",
              "name_en": "Small",
              "name_ar": "صغير",
              "type": "OPTION",
              "calorie": 300,
              "price": 5.5,
              "tax": 0.83,
              "total": 6.33,
              "cost": 4.5,
              "profit": 1,
              "is_tax_included": false,
              "deleted_at": null,
              "barcode": null,
              "barcode_img": null,
              "weight_amount": null,
              "weight_unit": null
            }
          }
        ],
        "tax_fees": [
          {
            "id": 30328,
            "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
            "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
            "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
            "order_product_id": 9000044908,
            "feeable_id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
            "feeable_type": "TAX",
            "qty": 1,
            "amount": 0.83,
            "total": 0.83,
            "created_at": 1698596703124,
            "updated_at": 1698596703124,
            "order_product_modifier_id": null
          }
        ]
      }
    ],
    "return_products": [],
    "changed_products": [
      {
        "id": 9000044909,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
        "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
        "product_category_id": 2,
        "product_id": "8447de4e-740e-4181-a377-6dfa3f4d3aa2",
        "qty": -1,
        "price": 5.5,
        "discount": 0,
        "tax": 0.83,
        "subtotal": 5.5,
        "total": 6.33,
        "cost": 4.5,
        "profit": 1,
        "is_done": false,
        "created_at": 1698596702970,
        "updated_at": 1698596702970,
        "status": "CHANGED",
        "product": {
          "id": "8447de4e-740e-4181-a377-6dfa3f4d3aa2",
          "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
          "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
          "product_category_id": 2,
          "name_en": "Burger Deluxe",
          "name_ar": "برجر ديلوكس",
          "description_en": "Tempore recusandae vel atque voluptatibus ea et nihil. Veniam eveniet laudantium cupiditate ratione non. Asperiores rem maiores neque inventore possimus itaque eum rerum. Delectus accusantium sit facilis. Ea voluptatibus natus quas eius commodi enim enim.",
          "description_ar": "Tempore recusandae vel atque voluptatibus ea et nihil. Veniam eveniet laudantium cupiditate ratione non. Asperiores rem maiores neque inventore possimus itaque eum rerum. Delectus accusantium sit facilis. Ea voluptatibus natus quas eius commodi enim enim.",
          "preparation_time": 15,
          "stock": 766,
          "order": 2,
          "images": [
            "https://cdn-flavours.fra1.digitaloceanspaces.com/img/uploads/products/1680365973-0.jpg"
          ],
          "is_active": true,
          "created_at": 1680271006454,
          "updated_at": 1684589809294,
          "deleted_at": null,
          "rating_amount": 0,
          "rating_avg": "0.00",
          "sold_amount": 64,
          "sold_revenue": 64.5,
          "qoyod_id": null
        },
        "modifiers": []
      },
      {
        "id": 9000044910,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
        "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
        "product_category_id": 3,
        "product_id": "cfcdf305-4cfe-495c-9a33-c8dfc7a6b8c5",
        "qty": -1,
        "price": 11,
        "discount": 0,
        "tax": 1.65,
        "subtotal": 11,
        "total": 12.65,
        "cost": 4.5,
        "profit": 1,
        "is_done": false,
        "created_at": 1698596702970,
        "updated_at": 1698596702970,
        "status": "CHANGED",
        "product": {
          "id": "cfcdf305-4cfe-495c-9a33-c8dfc7a6b8c5",
          "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
          "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
          "product_category_id": 3,
          "name_en": "Twister Lunch Edited",
          "name_ar": "Twister Lunch",
          "description_en": "Tempore recusandae vel atque voluptatibus ea et nihil. Veniam eveniet laudantium cupiditate ratione non. Asperiores rem maiores neque inventore possimus itaque eum rerum. Delectus accusantium sit facilis. Ea voluptatibus natus quas eius commodi enim enim.",
          "description_ar": "Tempore recusandae vel atque voluptatibus ea et nihil. Veniam eveniet laudantium cupiditate ratione non. Asperiores rem maiores neque inventore possimus itaque eum rerum. Delectus accusantium sit facilis. Ea voluptatibus natus quas eius commodi enim enim.",
          "preparation_time": 20,
          "stock": 818,
          "order": 1,
          "images": [
            "https://cdn-flavours.fra1.digitaloceanspaces.com/img/uploads/products/1680366096-0.jpg"
          ],
          "is_active": true,
          "created_at": 1680271006458,
          "updated_at": 1684246940577,
          "deleted_at": null,
          "rating_amount": 0,
          "rating_avg": "0.00",
          "sold_amount": 31,
          "sold_revenue": 39.09,
          "qoyod_id": null
        },
        "modifiers": []
      }
    ],
    "product_discount_fees": [],
    "product_tax_fees": [
      {
        "id": 30328,
        "market_id": "5d4196d7-355a-48ef-9c50-add58cc440f1",
        "branch_id": "02510007-93b6-4121-93d7-c1bd79d00d0c",
        "order_id": "ad757b52-c1c7-4996-a029-83d218cacb66",
        "order_product_id": 9000044908,
        "feeable_id": "cc49a82a-ea28-4541-b4e6-8131457607a1",
        "feeable_type": "TAX",
        "qty": 1,
        "amount": 0.83,
        "total": 0.83,
        "created_at": 1698596703124,
        "updated_at": 1698596703124,
        "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
        }
      }
    ]
  }
}
Previous
Checkout
Next
Sync
Built with