Tip
This guide will show you how to develop a flow where user can add a tip to their order.
Before proceeding, you should have implemented:
Fetching tip configurations for order
The flow starts with fetching a list of order types enabled for the venue, and their associated configurations using api/directory/search?view=search.
Based on this, a default and maximum tip can be displayed to the user for their selected order type. Note that if the tip maximum is set to 0%, then tip has been disabled for that order type and should not be displayed.
Request
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/directory/search?view=search",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Accept": "application/json",
"Content-Type" : "application/json",
"Device-UUID" : "abc123",
"X-QB-Enabled" : true,
"X-Request-ID" : "c10b4a70-6274-490d-80a0-03e7bb826937"
},
"body": {
"latitude": "45.2439162",
"longitude": "19.8814701"
}
}
Response
{
"status": "OK",
"code": 200,
"data": {
"venues": [
{
"distance": 3367.72,
"distance_in_miles": 2.09,
"venue": {
"id": 898,
"name": "Lemon Park",
"code": "5",
"state": 1,
"timezone": {
"name": "Europe\\/Belgrade",
"offset": "+01:00"
},
"description": "",
"address": "\\u017delezni\\u010dka 7",
"city": "Novi Sad",
"zip": "21000",
"latitude": 45.251014,
"longitude": 19.83965,
"image": {
"thumbnail_small": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs280\\/2022-10-24\\/a43856f72b82d11ac61e228ebb57e483.jpeg",
"thumbnail_medium": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs720\\/2022-10-24\\/a43856f72b82d11ac61e228ebb57e483.jpeg",
"fullsize": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/2022-10-24\\/a43856f72b82d11ac61e228ebb57e483.jpeg"
},
"serving_times": [
{
"id": 68558,
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": "16:00",
"time_to": "21:00",
"delivery_at": null,
"date": "2024-01-27",
"date_to": "2024-01-27",
"working": true
},
{
"id": 68559,
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": "09:00",
"time_to": "13:00",
"delivery_at": null,
"date": "2024-01-30",
"date_to": "2024-01-30",
"working": true
},
{
"id": 68859,
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": null,
"time_to": null,
"delivery_at": null,
"date": "2024-01-31",
"date_to": "2024-01-31",
"working": false
},
{
"id": 69959,
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "09:00",
"time_to": "23:00",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"is_open": true,
"will_open": true,
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": null
},
"days_in_advance": 0,
"order_types": [
{
"id": 7840,
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 100
},
{
"id": 7843,
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 90
},
{
"id": 7845,
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 50
},
{
"id": 7846,
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 100
},
{
"id": 7847,
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7848,
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 80810,
"type_id": 10,
"reference_type": "OrderTypeCateringDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 100
}
]
}
},
{
"distance": 4032.07,
"distance_in_miles": 2.51,
"venue": {
"id": 844,
"name": "(TEST) Baneasa Mall",
"code": "1",
"state": 1,
"timezone": {
"name": "Europe\\/Belgrade",
"offset": "+01:00"
},
"description": "",
"address": "Balzakova 34",
"city": "Novi Sad",
"zip": "21000",
"latitude": 45.23777,
"longitude": 19.830717,
"image": {
"thumbnail_small": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs280\\/2022-02-10\\/6a38659210534359432829c998522893.jpeg",
"thumbnail_medium": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs720\\/2022-02-10\\/6a38659210534359432829c998522893.jpeg",
"fullsize": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/2022-02-10\\/6a38659210534359432829c998522893.jpeg"
},
"serving_times": [
{
"id": 67408,
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "07:00",
"time_to": "22:00",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"is_open": true,
"will_open": true,
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": null
},
"days_in_advance": 10,
"order_types": [
{
"id": 7357,
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7359,
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7360,
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7361,
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7362,
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 80805,
"type_id": 10,
"reference_type": "OrderTypeCateringDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
]
}
},
{
"distance": 4066.76,
"distance_in_miles": 2.53,
"venue": {
"id": 853,
"name": "Baneasa Mall",
"code": "1",
"state": 1,
"timezone": {
"name": "Europe\\/Belgrade",
"offset": "+01:00"
},
"description": "",
"address": "Balzakova 34",
"city": "Novi Sad",
"zip": "21000",
"latitude": 45.23828,
"longitude": 19.830149,
"image": {
"thumbnail_small": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs280\\/2022-03-31\\/65dfeab5db2d6b0fbed594b0461c40ac.jpeg",
"thumbnail_medium": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs720\\/2022-03-31\\/65dfeab5db2d6b0fbed594b0461c40ac.jpeg",
"fullsize": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/2022-03-31\\/65dfeab5db2d6b0fbed594b0461c40ac.jpeg"
},
"serving_times": [
{
"id": 55416,
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "00:00",
"time_to": "00:00",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
},
{
"id": 69633,
"type_id": 1,
"reference_type": "SpecialDays",
"time_from": null,
"time_to": null,
"delivery_at": null,
"date": "2024-01-26",
"date_to": "2024-01-27",
"working": true
}
],
"is_open": true,
"will_open": true,
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": null
},
"days_in_advance": 10,
"order_types": [
{
"id": 7435,
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7438,
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7440,
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7442,
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
]
}
},
{
"distance": 61320.84,
"distance_in_miles": 38.1,
"venue": {
"id": 886,
"name": "AFI Cotroceni",
"code": "3",
"state": 1,
"timezone": {
"name": "Europe\\/Belgrade",
"offset": "+01:00"
},
"description": "",
"address": "Pedje Milosavljevica 52",
"city": "belgrade",
"zip": "11000",
"latitude": 44.818506,
"longitude": 20.378029,
"image": {
"thumbnail_small": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs280\\/2022-08-03\\/4c5e4e6c2df1939fd3ef9aa39c3dde9a.jpeg",
"thumbnail_medium": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs720\\/2022-08-03\\/4c5e4e6c2df1939fd3ef9aa39c3dde9a.jpeg",
"fullsize": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/2022-08-03\\/4c5e4e6c2df1939fd3ef9aa39c3dde9a.jpeg"
},
"serving_times": [
{
"id": 58299,
"type_id": 2,
"reference_type": "WeekDays",
"time_from": null,
"time_to": null,
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"is_open": true,
"will_open": true,
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": null
},
"days_in_advance": 5,
"order_types": [
{
"id": 7732,
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 100
},
{
"id": 7735,
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 20
},
{
"id": 7737,
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 30
},
{
"id": 7738,
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 40
},
{
"id": 7739,
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7740,
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
]
}
},
{
"distance": 68781.71,
"distance_in_miles": 42.74,
"venue": {
"id": 885,
"name": "ParkLake Shopping Center",
"code": "2",
"state": 1,
"timezone": {
"name": "Europe\\/Tallinn",
"offset": "+02:00"
},
"description": "",
"address": "Presernova 28",
"city": "Beograd",
"zip": "11000",
"latitude": 44.7859999,
"longitude": 20.4697498,
"image": {
"thumbnail_small": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs280\\/2022-07-26\\/4cfbe7800bf0f359b98efdb4b79b0e07.jpeg",
"thumbnail_medium": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs720\\/2022-07-26\\/4cfbe7800bf0f359b98efdb4b79b0e07.jpeg",
"fullsize": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/2022-07-26\\/4cfbe7800bf0f359b98efdb4b79b0e07.jpeg"
},
"serving_times": [
{
"id": 69991,
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "09:00",
"time_to": "14:30",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"is_open": true,
"will_open": true,
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": null
},
"days_in_advance": 30,
"order_types": [
{
"id": 7723,
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 20
},
{
"id": 7726,
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 20
},
{
"id": 7728,
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 20
},
{
"id": 7729,
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 20
},
{
"id": 7730,
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 20
},
{
"id": 7731,
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"external_channel_only": false,
"tip_default": 10,
"tip_max": 100
}
]
}
},
{
"distance": 267658.56,
"distance_in_miles": 166.32,
"venue": {
"id": 892,
"name": "Drumul Taberelor",
"code": "4",
"state": 1,
"timezone": {
"name": "Europe\\/Belgrade",
"offset": "+01:00"
},
"description": "No Vegan menu",
"address": "Blagoja Perovica",
"city": "Nis",
"zip": "18000",
"latitude": 43.324363,
"longitude": 21.910731,
"image": {
"thumbnail_small": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs280\\/2022-09-26\\/e4f0c9a58765f3061ae5137a929e36fe.jpeg",
"thumbnail_medium": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs720\\/2022-09-26\\/e4f0c9a58765f3061ae5137a929e36fe.jpeg",
"fullsize": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/2022-09-26\\/e4f0c9a58765f3061ae5137a929e36fe.jpeg"
},
"serving_times": [
{
"id": 70048,
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "00:30",
"time_to": "22:00",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"is_open": true,
"will_open": true,
"translations": {
"description": "No Vegan menu",
"kiosk_receipt_footer": null,
"welcome_message": null
},
"days_in_advance": 10,
"order_types": [
{
"id": 7786,
"type_id": 1,
"reference_type": "OrderTypeDineIn",
"state": 1,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 20
},
{
"id": 7789,
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 7791,
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 20
},
{
"id": 7792,
"type_id": 7,
"reference_type": "OrderTypeDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 20
},
{
"id": 7793,
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"external_channel_only": false,
"tip_default": 5,
"tip_max": 20
},
{
"id": 7794,
"type_id": 9,
"reference_type": "OrderTypeFoodspot",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 80809,
"type_id": 10,
"reference_type": "OrderTypeCateringDelivery",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 50
}
]
}
},
{
"distance": 11853454.66,
"distance_in_miles": 7365.4,
"venue": {
"id": 926,
"name": "Promises venue",
"code": "6",
"state": 1,
"timezone": {
"name": "America\\/Argentina\\/Buenos_Aires",
"offset": "-03:00"
},
"description": "",
"address": "Jos\\u00e9 Antonio Cabrera 4531, C1414BGG CABA, Argentina",
"city": "Buenos aires",
"zip": "060012",
"latitude": -34.5921318,
"longitude": -58.4277183,
"image": {
"thumbnail_small": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs280\\/2022-12-08\\/db324d8cddd419d183642f8228e4199c.jpeg",
"thumbnail_medium": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/_thumbs720\\/2022-12-08\\/db324d8cddd419d183642f8228e4199c.jpeg",
"fullsize": "https:\\/\\/s3.eu-central-1.amazonaws.com\\/api.qa\\/images\\/venue_images\\/2022-12-08\\/db324d8cddd419d183642f8228e4199c.jpeg"
},
"serving_times": [
{
"id": 23557,
"type_id": 2,
"reference_type": "WeekDays",
"time_from": "09:00",
"time_to": "22:00",
"delivery_at": null,
"days": [
1,
2,
3,
4,
5,
6,
0
]
}
],
"is_open": true,
"will_open": true,
"translations": {
"description": "",
"kiosk_receipt_footer": null,
"welcome_message": null
},
"days_in_advance": 0,
"order_types": [
{
"id": 8095,
"type_id": 4,
"reference_type": "OrderTypePreorder",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 8097,
"type_id": 6,
"reference_type": "OrderTypeTakeOut",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
},
{
"id": 8099,
"type_id": 8,
"reference_type": "OrderTypeCurbside",
"state": 1,
"external_channel_only": false,
"tip_default": 0,
"tip_max": 0
}
]
}
}
]
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
id |
Integer | 7890 | UUID of order type in database |
type_id |
Integer | 1 | Order type id (see Order Types) |
reference_type |
String | "OrderTypeDineIn" | Short description of the order type |
state |
Integer | 1 | State of order type: 1 is Active, 2 is Disabled, 3 is Auto-disabled, 4 is Ordering Disabled |
external_channel_only |
Boolean | false | If order type only available for external channel |
tip_default |
Integer | 10 | Default Tip percentage for order type (as per configuration in Management Centre). |
tip_max |
Integer | 50 | Maximum tip percentage for order type(as per configuration in Management Centre). |
Tip calculations
Based on whether the user has chosen to add a tip percentage or a tip custom amount to the order, add the appropriate values in the /order/calculate request.
Percentage tip
Request
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/orders/calculate",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Accept": "application/json",
"Content-Type" : "application/json",
"Authorization" : "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXRSZWZyZXNoVFRMIjoyNjI4MDAwLCJpc3MiOiJodHRwczovL2FwaS1wdWJsaWMtcGxheWdyb3VuZC5tZW51LmFwcC9hcGkvY3VzdG9tZXJzL2xvZ2luIiwiaWF0IjoxNjkzMjA0MTQ3LCJleHAiOjE2OTMyMDc3NDcsIm5iZiI6MTY5MzIwNDE0NywianRpIjoiM0RiTngwVlB6VmpTTlJkdyIsInN1YiI6IjUwOTA5NjUiLCJwcnYiOiJjYzMyOTIxYTE1NDgwYTExN2Q5YmJjNzJjMGUxMjU2YTY4NTI0NThiIiwiYXBwbGljYXRpb25faWQiOjIwMTUsInNlc3Npb25faWQiOjI4MzQyfQ.1J3_OlydWh32BUNAySZ6Qbj1K0q-_w4KfFnra2X9FbM",
"X-QB-Enabled" : true,
"X-Request-ID" : "c10b4a70-6274-490d-80a0-03e7bb826937"
},
"body": {
"calculate_accurate_tax": true,
"discount_cards": [],
"menu_items": [
{
"comment": "",
"id": 192032,
"modifiers": [],
"price_level_id": 205155,
"quantity": 1,
"type_id": 0
}
],
"order_type": {
"customer_cash_amount": 0,
"foodspot_id": 0,
"id": 4,
"serving_time_id": 0,
"state": "2",
"tip_default": 0,
"tip_max": 0,
"type_id": "4"
},
"singular_point_id": 10217,
"tip": {
"percentage": 28
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
percentage |
Integer | 28 | Percentage tip selected by user |
Response
{
"status": "OK",
"code": 200,
"data": {
"calculations": {
"calculation_method": "inclusive",
"subtotal": 500,
"discount": 0,
"subsidy": 0,
"external_payment_amount": 0,
"service_charge": 0,
"service_charge_rate": 0,
"service_charge_tax_rate": 0,
"delivery_fee": 0,
"delivery_fee_tax": 0,
"delivery_fee_tax_rate": 0,
"minimum_surcharge": 0,
"minimum_surcharge_tax": 0,
"tip": 140,
"tip_rate": 28,
"total": 640,
"amount_for_payment": 640,
"tax": 24,
"tax_exemption": 0,
"tax_rates": {
"5": 24
},
"tax_rates_exemption": {
"5": 0
},
"items": [
{
"id": 192032,
"type_id": 1,
"price": 500,
"quantity": 1,
"subtotal": 500,
"discount": 0,
"total": 500,
"tax": 24,
"tax_exemption": 0,
"tax_rate": 5,
"tax_rates": {
"5": 24
},
"modifiers": []
}
],
"customer_account_id": 925621,
"discount_info": null,
"loyalty_info": {
"points_spent": 0,
"points_accrued": 20,
"available_loyalty_points": 20
}
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
tip |
Float | 28 | Percentage tip selected by user |
tip_rate |
Float | 140 | Calculated tip amount which will be included in total |
total |
Float | 640 | Total value of order |
Custom tip
Request
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/orders/calculate",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Accept": "application/json",
"Content-Type" : "application/json",
"Authorization" : "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXRSZWZyZXNoVFRMIjoyNjI4MDAwLCJpc3MiOiJodHRwczovL2FwaS1wdWJsaWMtcGxheWdyb3VuZC5tZW51LmFwcC9hcGkvY3VzdG9tZXJzL2xvZ2luIiwiaWF0IjoxNjkzMjA0MTQ3LCJleHAiOjE2OTMyMDc3NDcsIm5iZiI6MTY5MzIwNDE0NywianRpIjoiM0RiTngwVlB6VmpTTlJkdyIsInN1YiI6IjUwOTA5NjUiLCJwcnYiOiJjYzMyOTIxYTE1NDgwYTExN2Q5YmJjNzJjMGUxMjU2YTY4NTI0NThiIiwiYXBwbGljYXRpb25faWQiOjIwMTUsInNlc3Npb25faWQiOjI4MzQyfQ.1J3_OlydWh32BUNAySZ6Qbj1K0q-_w4KfFnra2X9FbM",
"X-QB-Enabled" : true,
"X-Request-ID" : "c10b4a70-6274-490d-80a0-03e7bb826937"
},
"body": {
"calculate_accurate_tax": true,
"discount_cards": [],
"menu_items": [
{
"comment": "",
"id": 192032,
"modifiers": [],
"price_level_id": 205155,
"quantity": 1,
"type_id": 0
}
],
"order_type": {
"customer_cash_amount": 0,
"foodspot_id": 0,
"id": 4,
"serving_time_id": 0,
"state": "2",
"tip_default": 0,
"tip_max": 0,
"type_id": "4"
},
"singular_point_id": 10217,
"tip": {
"amount": 28
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
amount |
Integer | 28 | Custom amount tip selected by user |
Response
{
"status": "OK",
"code": 200,
"data": {
"calculations": {
"calculation_method": "inclusive",
"subtotal": 44400,
"discount": 0,
"subsidy": 0,
"external_payment_amount": 0,
"service_charge": 0,
"service_charge_rate": 0,
"service_charge_tax_rate": 0,
"delivery_fee": 0,
"delivery_fee_tax": 0,
"delivery_fee_tax_rate": 0,
"minimum_surcharge": 0,
"minimum_surcharge_tax": 0,
"tip": 100,
"tip_rate": 0.22522522522522523,
"total": 44500,
"amount_for_payment": 44500,
"tax": 3826,
"tax_exemption": 0,
"tax_rates": {
"10": 3596,
"5": 230
},
"tax_rates_exemption": {
"10": 0,
"5": 0
},
"items": [
{
"id": 170864,
"type_id": 2,
"price": 20800,
"quantity": 1,
"subtotal": 20800,
"discount": 0,
"total": 20800,
"tax": 1681,
"tax_exemption": 0,
"tax_rates": {
"10": 1451,
"5": 230
},
"combo_items": [
{
"id": 2229980,
"type_id": 1,
"price": 8062,
"quantity": 1,
"subtotal": 8062,
"discount": 0,
"total": 8062,
"tax": 733,
"tax_exemption": 0,
"tax_rate": 10,
"tax_rates": {
"10": 733
},
"modifiers": []
},
{
"id": 2230000,
"type_id": 1,
"price": 7901,
"quantity": 1,
"subtotal": 7901,
"discount": 0,
"total": 7901,
"tax": 718,
"tax_exemption": 0,
"tax_rate": 10,
"tax_rates": {
"10": 718
},
"modifiers": []
},
{
"id": 2230008,
"type_id": 1,
"price": 4837,
"quantity": 1,
"subtotal": 4837,
"discount": 0,
"total": 4837,
"tax": 230,
"tax_exemption": 0,
"tax_rate": 5,
"tax_rates": {
"5": 230
},
"modifiers": []
}
]
},
{
"id": 335508,
"type_id": 1,
"price": 11900,
"quantity": 1,
"subtotal": 15000,
"discount": 0,
"total": 15000,
"tax": 1363,
"tax_exemption": 0,
"tax_rate": 10,
"tax_rates": {
"10": 1363
},
"modifiers": [
{
"price": 1500,
"quantity": 1,
"discount": 0,
"total": 1500,
"tax": 136,
"tax_rate": 10
},
{
"price": 1600,
"quantity": 1,
"discount": 0,
"total": 1600,
"tax": 145,
"tax_rate": 10
}
]
},
{
"id": 335496,
"type_id": 1,
"price": 5000,
"quantity": 1,
"subtotal": 6600,
"discount": 0,
"total": 6600,
"tax": 600,
"tax_exemption": 0,
"tax_rate": 10,
"tax_rates": {
"10": 600
},
"modifiers": [
{
"price": 1600,
"quantity": 1,
"discount": 0,
"total": 1600,
"tax": 145,
"tax_rate": 10
}
]
},
{
"id": 335565,
"type_id": 1,
"price": 2000,
"quantity": 1,
"subtotal": 2000,
"discount": 0,
"total": 2000,
"tax": 182,
"tax_exemption": 0,
"tax_rate": 10,
"tax_rates": {
"10": 182
},
"modifiers": []
}
],
"customer_account_id": null,
"discount_info": null,
"loyalty_info": {
"points_spent": 0,
"points_accrued": 0,
"available_loyalty_points": 0
}
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
tip |
Float | 100 | Calculated percentage tip for the order |
tip_rate |
Float | 0.25 | Custom tip amount selected by user |
total |
Float | 44500 | Total value of order |
Completing the order
Once the tip has been selected by user, add the appropriate tip percentage or custom amount when placing the order.
Percentage tip
Request
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/orders",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Accept": "application/json",
"Content-Type" : "application/json",
"Authorization" : "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXRSZWZyZXNoVFRMIjoyNjI4MDAwLCJpc3MiOiJodHRwczovL2FwaS1wdWJsaWMtcGxheWdyb3VuZC5tZW51LmFwcC9hcGkvY3VzdG9tZXJzL2xvZ2luIiwiaWF0IjoxNjkzMjA0MTQ3LCJleHAiOjE2OTMyMDc3NDcsIm5iZiI6MTY5MzIwNDE0NywianRpIjoiM0RiTngwVlB6VmpTTlJkdyIsInN1YiI6IjUwOTA5NjUiLCJwcnYiOiJjYzMyOTIxYTE1NDgwYTExN2Q5YmJjNzJjMGUxMjU2YTY4NTI0NThiIiwiYXBwbGljYXRpb25faWQiOjIwMTUsInNlc3Npb25faWQiOjI4MzQyfQ.1J3_OlydWh32BUNAySZ6Qbj1K0q-_w4KfFnra2X9FbM",
"X-QB-Enabled" : true,
"X-Request-ID" : "c10b4a70-6274-490d-80a0-03e7bb826937"
},
"body": {
"is_reorder": false,
"menu_items": [
{
"comment": "",
"id": 192032,
"modifiers": [],
"price_level_id": 205155,
"quantity": 1,
"type_id": 0
}
],
"order_type": {
"customer_cash_amount": 0,
"customer_phone_number": "+6568",
"foodspot_id": 0,
"id": 4,
"pickup_asap": true,
"serving_time_id": 0,
"state": "2",
"tip_default": 0,
"tip_max": 0,
"trigger_type": "1",
"type_id": "4"
},
"payment_info": {
"payment_init_hash": "c00c398b710e024ce29a892176705118"
},
"stored_payment_method_id": 237295,
"pos_items": [],
"singular_point_id": 10217,
"tip": {
"percentage": 28
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
percentage |
Integer | 28 | Percentage tip to be added to the order |
Response
{
"status": "OK",
"code": 200,
"data": {
"order": {
"id": 2911741,
"code": "GDA66",
"uuid": "7f52693a-c307-44d1-b9e5-5d42db555391",
"init_hash": "c00c398b710e024ce29a892176705118",
"external_reference": null,
"external_code": null,
"external_channel_id": null,
"ticket_id": 2942113,
"application_id": 94,
"application_info": {
"id": 94,
"uuid": null,
"type_id": 5,
"reference_type": "SpecificMobileApplication",
"brand_id": 53,
"name": "Popeyes Romania Mobile White-Label",
"key": "orderqa",
"is_dpa_signed": 0,
"created_at": "2022-02-08 09:23:32",
"updated_at": "2023-06-28 05:31:52"
},
"venue_id": 898,
"venue_info": {
"id": 898,
"name": "Lemon Park",
"address": "\u017delezni\u010dka 7",
"city": "Novi Sad",
"zip": "21000",
"latitude": 45.251014,
"longitude": 19.83965,
"phone": "727841984",
"delivery_travel_type": "driving",
"use_pos_order_number": false,
"timezone": {
"name": "Europe\/Belgrade",
"offset": "+01:00"
},
"tax_number": "RO44848887",
"pickup_time": 2,
"image": {
"thumbnail_small": "https:\/\/s3.eu-central-1.amazonaws.com\/api.qa\/images\/venue_images\/_thumbs280\/2022-10-24\/a43856f72b82d11ac61e228ebb57e483.jpeg",
"thumbnail_medium": "https:\/\/s3.eu-central-1.amazonaws.com\/api.qa\/images\/venue_images\/_thumbs720\/2022-10-24\/a43856f72b82d11ac61e228ebb57e483.jpeg",
"fullsize": "https:\/\/s3.eu-central-1.amazonaws.com\/api.qa\/images\/venue_images\/2022-10-24\/a43856f72b82d11ac61e228ebb57e483.jpeg"
},
"country": {
"id": 10,
"name": "Serbia",
"code": "RS",
"calling_code": "+381",
"currency_settings": {
"currency_space": true,
"decimal_separator": ".",
"thousands_separator": ",",
"symbol_position": "left"
}
},
"currency": {
"id": 1,
"code": "EUR",
"code_numeric": "978",
"symbol": "\u20ac",
"rounding_unit": 0.01,
"rounding_unit_tip": 0.01
},
"dispatch_legacy": true
},
"singular_point_id": 10217,
"singular_point_info": {
"id": 10217,
"parent_id": 3190,
"parent_type": "AreaQuickService",
"input_type": "ManualInput",
"input_id": null,
"input": null,
"area_info": {
"id": 3190,
"type_id": 3,
"reference_type": "AreaQuickService",
"name": "QS",
"pos_id": null
},
"created_at": null
},
"pos_ticket_id": "",
"pos_ticket_code": "",
"customer_account_id": 925621,
"customer_account_info": {
"id": 925621,
"uuid": "de3fa867-6821-40e1-86bf-10eec5822fa8",
"v2_id": null,
"v2_token": null,
"type_id": 1,
"reference_type": "CustomerAccount",
"customer_id": 884450,
"brand_id": 53,
"first_name": "Milan",
"last_name": "Mijic",
"confirmed": 0,
"phone_number": "+6568",
"locale": "en",
"state": 1,
"optin_status_email": 2,
"optin_status_pn": 2,
"optin_status_sms": 3,
"created_at": "2023-01-27 08:10:11",
"updated_at": "2023-01-27 13:00:01",
"is_dpa_signed": 0,
"email": "milan.mijic@menu.app",
"demographics": {
"birth_date": "1994-09-01",
"company_name": "haga",
"identification_number": "545436"
},
"discount_cards": []
},
"order_type": 4,
"order_type_info": {
"id": 7843,
"uuid": "f2a09622-7787-4a71-836c-f37516d65fbe",
"type_id": 4,
"reference_type": "OrderTypePreorder",
"venue_id": 898,
"state": 1,
"external_channel_only": 0,
"tip_default": 0,
"tip_max": 90,
"created_at": "2022-10-17 11:07:28",
"updated_at": "2024-01-12 15:21:59",
"is_dpa_signed": 0,
"pivot": {
"area_id": 3190,
"order_type_id": 7843
}
},
"order_type_properties": {
"type_id": 4,
"pickup_asap": true,
"pickup_at": "2024-01-17T08:32:56.292656Z",
"customer_phone_number": "+6568",
"is_scheduled": false
},
"order_additional_info": null,
"is_scheduled": false,
"trigger_type": 1,
"status": "SendDelayed",
"status_changed_by": "System",
"payment_status": "Reserved",
"fraud_detection_status": null,
"fiscal_status": null,
"fiscalization_number": null,
"tablet_status": "ON_HOLD",
"delivery_status": null,
"is_test": false,
"calculation_method": "inclusive",
"subtotal": 500,
"discount": 0,
"subsidy": 0,
"external_payment_amount": 0,
"discount_info": null,
"service_charge": 0,
"service_charge_rate": 0,
"service_charge_tax_rate": 0,
"delivery_fee_tax_rate": 0,
"delivery_fee": 0,
"delivery_fee_tax": 0,
"minimal_order_amount": 0,
"minimum_surcharge": 0,
"minimum_surcharge_tax": 0,
"tip": 140,
"tip_rate": 28,
"total": 640,
"tax": 24,
"tax_exemption": 0,
"tax_rates": {
"5": 24
},
"tax_rates_exemption": {
"5": 0
},
"refunded": 0,
"order_items": [
{
"id": 7866692,
"type_id": 1,
"reference_type": "MenuOrderItem",
"order_id": 2911741,
"menu_item_id": 192032,
"pos_id": "2004005_1",
"unpaid_item_hash": null,
"name": "Caf\u00e9 Latte",
"translations": {
"name": "Caf\u00e9 Latte"
},
"type": "Food",
"is_self_serving": false,
"quantity": 1,
"subtotal": 500,
"discount": 0,
"service_charge": 0,
"total": 500,
"tax": 24,
"tax_rate": 5,
"comment": "",
"price_level": {
"id": 7866277,
"order_item_id": 7866692,
"menu_item_price_level_id": 205155,
"pos_id": "2004005_1",
"name": null,
"translations": {
"name": null
},
"price": 500
},
"modifiers": [],
"image": {
"thumbnail_small": "https:\/\/s3.eu-central-1.amazonaws.com\/api.qa\/images\/item_images\/_thumbs280\/2022-03-29\/d91a2475a35e116e423572d298d79406.png",
"thumbnail_medium": "https:\/\/s3.eu-central-1.amazonaws.com\/api.qa\/images\/item_images\/_thumbs720\/2022-03-29\/d91a2475a35e116e423572d298d79406.png",
"fullsize": "https:\/\/s3.eu-central-1.amazonaws.com\/api.qa\/images\/item_images\/2022-03-29\/d91a2475a35e116e423572d298d79406.png"
}
}
],
"combo_meals": [],
"discounts": [],
"payments": [
{
"id": 2881834,
"type_id": 2,
"reference_type": "OrderItemPayment",
"ticket_id": 2942113,
"payment_method_id": 2,
"payment_processor_type_id": 2,
"payment_processor_id": 129,
"total": 640,
"pos_receipt_id": "",
"stored_payment_method_vault": {
"id": 237066,
"stored_payment_method_id": 237295,
"payment_processor_id": 129,
"alias": "ff0bb3dfc473ae938c11565880eaeffa",
"properties": {
"card_holder_name": "NONE",
"card_type": "MASTERCARD",
"card_label": null,
"masked_number": "555555xxxxxx4444",
"last_four_digits": "4444",
"first_six_digits": null,
"expiration_date": null,
"expiration_month": 3,
"expiration_year": 2030,
"billing_country_code": null,
"billing_zip_code": null,
"country_of_issuance": "ch",
"payment_method_id": null,
"alias": "ff0bb3dfc473ae938c11565880eaeffa",
"customer_reference": null
}
}
}
],
"refunds": [],
"send_at": "2024-01-17 08:30:57",
"pickup_at": "2024-01-17 08:32:56",
"pickup_code": null,
"ready_at": null,
"delivery_at": null,
"additional_delivery_info": null,
"delivery_delay_time": null,
"arriving_at": "2024-01-17 08:32:56",
"regret_cancel_until": "2024-01-17 08:30:57",
"is_customer_arrived": false,
"cancellation_reason_id": null,
"created_at": "2024-01-17 08:25:56",
"updated_at": "2024-01-17 08:25:57",
"delivery_job": {}
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
tip |
Float | 28 | Percentage tip added to order |
tip_rate |
Float | 140 | Tip amount added to order |
total |
Float | 640 | Total value of order |
Custom tip
Request
{
"method": "post",
"url": "https://api-public-playground.menu.app/api/orders",
"headers": {
"X-Request-ID": "69da3547-204b-4093-a225-54e084c24215",
"Application": "f3a90488ffee32c3acb6fcd0ca417cf6",
"Api-Version": 4.38.0,
"Accept": "application/json",
"Content-Type" : "application/json",
"Authorization" : "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXRSZWZyZXNoVFRMIjoyNjI4MDAwLCJpc3MiOiJodHRwczovL2FwaS1wdWJsaWMtcGxheWdyb3VuZC5tZW51LmFwcC9hcGkvY3VzdG9tZXJzL2xvZ2luIiwiaWF0IjoxNjkzMjA0MTQ3LCJleHAiOjE2OTMyMDc3NDcsIm5iZiI6MTY5MzIwNDE0NywianRpIjoiM0RiTngwVlB6VmpTTlJkdyIsInN1YiI6IjUwOTA5NjUiLCJwcnYiOiJjYzMyOTIxYTE1NDgwYTExN2Q5YmJjNzJjMGUxMjU2YTY4NTI0NThiIiwiYXBwbGljYXRpb25faWQiOjIwMTUsInNlc3Npb25faWQiOjI4MzQyfQ.1J3_OlydWh32BUNAySZ6Qbj1K0q-_w4KfFnra2X9FbM",
"X-QB-Enabled" : true,
"X-Request-ID" : "c10b4a70-6274-490d-80a0-03e7bb826937"
},
"body": {
"is_reorder": false,
"menu_items": [
{
"comment": "",
"id": 192032,
"modifiers": [],
"price_level_id": 205155,
"quantity": 1,
"type_id": 0
}
],
"order_type": {
"customer_cash_amount": 0,
"customer_phone_number": "+6568",
"foodspot_id": 0,
"id": 4,
"pickup_asap": true,
"serving_time_id": 0,
"state": "2",
"tip_default": 0,
"tip_max": 0,
"trigger_type": "1",
"type_id": "4"
},
"payment_info": {
"payment_init_hash": "c00c398b710e024ce29a892176705118"
},
"stored_payment_method_id": 237295,
"pos_items": [],
"singular_point_id": 10217,
"tip": {
"amount": 100
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
amount |
Integer | 100 | Custum tip value to be added to the order |
Response
{
"status": "OK",
"code": 200,
"data": {
"order": {
"id": 275,
"code": "XPECA",
"uuid": "52ac4ec6-5012-4e95-87f1-f1b66be4883e",
"init_hash": "d62d0a96ac521b2483707c0c30d76fff",
"external_reference": null,
"external_code": null,
"external_channel_id": null,
"ticket_id": 766791,
"application_id": 2538,
"application_info": {
"id": 2538,
"key": "074f956d0b22dcecbc2ba381b5a27429",
"name": "Postman Mobile Application",
"uuid": "344ab48c-5ddd-44a5-b997-cf6fbb5cb94d",
"type_id": 5,
"brand_id": 4,
"created_at": "2023-10-03 16:11:13",
"updated_at": "2023-10-03 16:11:13",
"is_dpa_signed": 0,
"reference_type": "SpecificMobileApplication"
},
"venue_id": 1054,
"venue_info": {
"id": 1054,
"name": "Santa Fe",
"address": "Presernova 28",
"city": "Beograd",
"zip": "11000",
"latitude": 44.813849,
"longitude": 20.457273,
"phone": "",
"delivery_travel_type": "driving",
"use_pos_order_number": false,
"timezone": {
"name": "Europe/Belgrade",
"offset": "+01:00"
},
"tax_number": "",
"pickup_time": 8,
"image": null,
"country": {
"id": 10,
"name": "Serbia",
"code": "RS",
"calling_code": "+381",
"currency_settings": {
"currency_space": true,
"decimal_separator": ".",
"thousands_separator": ".",
"symbol_position": "left"
}
},
"currency": {
"id": 1,
"code": "EUR",
"code_numeric": "978",
"symbol": "€",
"rounding_unit": 0.01,
"rounding_unit_tip": 0.01
},
"dispatch_legacy": true
},
"singular_point_id": 17795,
"singular_point_info": {
"id": 17795,
"input": null,
"input_id": null,
"area_info": {
"id": 13308,
"name": "Takeout",
"pos_id": null,
"type_id": 4,
"reference_type": "AreaTakeOut"
},
"parent_id": 13308,
"created_at": null,
"input_type": "ManualInput",
"parent_type": "AreaTakeOut"
},
"pos_ticket_id": "",
"pos_ticket_code": "XPECA",
"customer_account_id": 5089333,
"customer_account_info": {
"id": 5089333,
"uuid": "eb0b8ca7-fde0-4bb8-a1eb-66e2c9175c62",
"email": "dragan.deak@menu.app",
"state": 1,
"locale": "en",
"type_id": 1,
"brand_id": 4,
"v2_token": null,
"confirmed": 0,
"last_name": "D",
"created_at": "2023-06-01 13:02:50",
"first_name": "Dragan",
"updated_at": "2024-01-16 08:56:56",
"customer_id": 5108439,
"demographics": {
"birth_date": ""
},
"phone_number": "+381 11 666-999",
"is_dpa_signed": 0,
"discount_cards": [],
"reference_type": "CustomerAccount",
"optin_status_pn": 1,
"optin_status_sms": 1,
"optin_status_email": 2
},
"order_type": 6,
"order_type_info": {
"id": 9483,
"uuid": "f3adc92d-fc0c-4659-bed4-4162dda3e65c",
"pivot": {
"area_id": 13308,
"order_type_id": 9483
},
"state": 1,
"tip_max": 50,
"type_id": 6,
"venue_id": 1054,
"created_at": "2022-06-21 01:00:55",
"updated_at": "2023-12-05 07:46:48",
"tip_default": 4,
"is_dpa_signed": 0,
"reference_type": "OrderTypeTakeOut",
"external_channel_only": 0
},
"order_type_properties": {
"type_id": 6,
"pickup_at": "2024-01-18T16:00:00.000000Z",
"pickup_asap": false,
"is_scheduled": false,
"customer_phone_number": "+381 11 666-999"
},
"order_additional_info": {
"pos_wait_until_paid": false
},
"is_scheduled": false,
"trigger_type": 1,
"status": "SendDelayed",
"status_changed_by": "System",
"payment_status": "Paid",
"fraud_detection_status": null,
"fiscal_status": null,
"fiscalization_number": null,
"tablet_status": "ON_HOLD",
"delivery_status": null,
"is_test": false,
"calculation_method": "inclusive",
"subtotal": 44400,
"discount": 0,
"subsidy": 0,
"external_payment_amount": 0,
"discount_info": null,
"service_charge": 0,
"service_charge_rate": 0,
"service_charge_tax_rate": 0,
"delivery_fee_tax_rate": 0,
"delivery_fee": 0,
"delivery_fee_tax": 0,
"minimal_order_amount": 0,
"minimum_surcharge": 0,
"minimum_surcharge_tax": 0,
"tip": 100,
"tip_rate": 0.23,
"total": 44500,
"tax": 3826,
"tax_exemption": 0,
"tax_rates": {
"5": 230,
"10": 3596
},
"tax_rates_exemption": {
"5": 0,
"10": 0
},
"refunded": 0,
"order_items": [
{
"id": 675,
"type_id": 1,
"reference_type": "MenuOrderItem",
"order_id": 275,
"menu_item_id": 335508,
"pos_id": null,
"unpaid_item_hash": null,
"name": "BBQ Bacon Crispy King - Santa Fe",
"translations": {
"name": "BBQ Bacon Crispy King - Santa Fe"
},
"type": "Food",
"is_self_serving": false,
"quantity": 1,
"subtotal": 15000,
"discount": 0,
"service_charge": 0,
"total": 15000,
"tax": 1363,
"tax_rate": 10,
"comment": "BBQ Bacon Crispy King Pollo",
"price_level": {
"id": 675,
"order_item_id": 675,
"menu_item_price_level_id": 387380,
"pos_id": null,
"name": null,
"translations": {
"name": null
},
"price": 11900
},
"modifiers": [
{
"id": 728,
"order_item_id": 675,
"modifier_id": 202385,
"pos_id": null,
"name": "Carne Whopper",
"translations": {
"name": "Carne Whopper"
},
"price": 1500,
"discount": 0
},
{
"id": 729,
"order_item_id": 675,
"modifier_id": 202268,
"pos_id": null,
"name": "Queso Suizo",
"translations": {
"name": "Queso Suizo"
},
"price": 1600,
"discount": 0
}
],
"image": {
"thumbnail_small": "/storage/images/item_images/_thumbs280/2022-07-08/0af82b0e99c8cd38eddb860322758260.png",
"thumbnail_medium": "/storage/images/item_images/_thumbs720/2022-07-08/0af82b0e99c8cd38eddb860322758260.png",
"fullsize": "/storage/images/item_images/2022-07-08/0af82b0e99c8cd38eddb860322758260.png"
}
},
{
"id": 676,
"type_id": 1,
"reference_type": "MenuOrderItem",
"order_id": 275,
"menu_item_id": 335496,
"pos_id": null,
"unpaid_item_hash": null,
"name": "Whopper Angry - Santa Fe",
"translations": {
"name": "Whopper Angry - Santa Fe"
},
"type": "Food",
"is_self_serving": false,
"quantity": 1,
"subtotal": 6600,
"discount": 0,
"service_charge": 0,
"total": 6600,
"tax": 600,
"tax_rate": 10,
"comment": "Whopper Angry A la parrilla",
"price_level": {
"id": 676,
"order_item_id": 676,
"menu_item_price_level_id": 387368,
"pos_id": null,
"name": null,
"translations": {
"name": null
},
"price": 5000
},
"modifiers": [
{
"id": 730,
"order_item_id": 676,
"modifier_id": 202224,
"pos_id": null,
"name": "Jamón (2)",
"translations": {
"name": "Jamón (2)"
},
"price": 1600,
"discount": 0
}
],
"image": {
"thumbnail_small": "/storage/images/item_images/_thumbs280/2022-07-08/340380dd4bb1499b5703bb7762ff1111.png",
"thumbnail_medium": "/storage/images/item_images/_thumbs720/2022-07-08/340380dd4bb1499b5703bb7762ff1111.png",
"fullsize": "/storage/images/item_images/2022-07-08/340380dd4bb1499b5703bb7762ff1111.png"
}
},
{
"id": 677,
"type_id": 1,
"reference_type": "MenuOrderItem",
"order_id": 275,
"menu_item_id": 335565,
"pos_id": null,
"unpaid_item_hash": null,
"name": "Kraljica",
"translations": {
"name": "Kraljica"
},
"type": "Drink",
"is_self_serving": false,
"quantity": 1,
"subtotal": 2000,
"discount": 0,
"service_charge": 0,
"total": 2000,
"tax": 182,
"tax_rate": 10,
"comment": "Kraljica Sljivovica",
"price_level": {
"id": 677,
"order_item_id": 677,
"menu_item_price_level_id": 387457,
"pos_id": null,
"name": null,
"translations": {
"name": null
},
"price": 2000
},
"modifiers": [],
"image": {
"thumbnail_small": "/storage/images/item_images/_thumbs280/2021-05-14/eddb5aebcc21983d8b3df86419eeb639.png",
"thumbnail_medium": "/storage/images/item_images/_thumbs720/2021-05-14/eddb5aebcc21983d8b3df86419eeb639.png",
"fullsize": "/storage/images/item_images/2021-05-14/eddb5aebcc21983d8b3df86419eeb639.png"
}
}
],
"combo_meals": [
{
"id": 100,
"type_id": 1,
"reference_type": "ComboMealOrderItemGroup",
"order_id": 275,
"combo_meal_id": 170864,
"pos_id": null,
"name": "Combos regulares",
"custom_name": "Combo Whopper Angry Regular",
"translations": {
"name": "Combos regulares",
"custom_name": "Combo Whopper Angry Regular"
},
"quantity": 1,
"subtotal": 20800,
"discount": 0,
"service_charge": 0,
"total": 20800,
"tax": 1681,
"tax_rates": {
"5": 230,
"10": 1451
},
"items": [
{
"id": 678,
"type_id": 3,
"reference_type": "ComboOrderItem",
"order_id": 275,
"menu_item_id": 335496,
"pos_id": null,
"unpaid_item_hash": null,
"name": "Whopper Angry - Santa Fe",
"translations": {
"name": "Whopper Angry - Santa Fe"
},
"type": "Food",
"is_self_serving": false,
"quantity": 1,
"subtotal": 8062,
"discount": 0,
"service_charge": 0,
"total": 8062,
"tax": 733,
"tax_rate": 10,
"comment": "Whopper Angry Santa Fe",
"price_level": {
"id": 678,
"order_item_id": 678,
"menu_item_price_level_id": 387368,
"pos_id": null,
"name": null,
"translations": {
"name": null
},
"price": 8062
},
"modifiers": [],
"image": {
"thumbnail_small": "/storage/images/combo_item_images/_thumbs280/2022-07-11/64200feb7cc256928dbcb5985f2240a8.png",
"thumbnail_medium": "/storage/images/combo_item_images/_thumbs720/2022-07-11/64200feb7cc256928dbcb5985f2240a8.png",
"fullsize": "/storage/images/combo_item_images/2022-07-11/64200feb7cc256928dbcb5985f2240a8.png"
},
"combo_group": {
"id": 162,
"combo_group_id": 642658,
"order_item_id": 678,
"order_combo_meal_id": 100,
"type_id": 1,
"reference_type": "MainCoreComboGroup",
"pos_id": "",
"name": "Combos regulares",
"translations": {
"name": "Combos regulares"
}
}
},
{
"id": 679,
"type_id": 3,
"reference_type": "ComboOrderItem",
"order_id": 275,
"menu_item_id": 335530,
"pos_id": null,
"unpaid_item_hash": null,
"name": "Papas Supremas Queso",
"translations": {
"name": "Papas Supremas Queso"
},
"type": "Food",
"is_self_serving": false,
"quantity": 1,
"subtotal": 7901,
"discount": 0,
"service_charge": 0,
"total": 7901,
"tax": 718,
"tax_rate": 10,
"comment": "Papas Supremas Queso",
"price_level": {
"id": 679,
"order_item_id": 679,
"menu_item_price_level_id": 387408,
"pos_id": null,
"name": null,
"translations": {
"name": null
},
"price": 7901
},
"modifiers": [],
"image": {
"thumbnail_small": "/storage/images/item_images/_thumbs280/2022-07-08/5c001c779547365fc112ed988c8d6438.png",
"thumbnail_medium": "/storage/images/item_images/_thumbs720/2022-07-08/5c001c779547365fc112ed988c8d6438.png",
"fullsize": "/storage/images/item_images/2022-07-08/5c001c779547365fc112ed988c8d6438.png"
},
"combo_group": {
"id": 163,
"combo_group_id": 642659,
"order_item_id": 679,
"order_combo_meal_id": 100,
"type_id": 2,
"reference_type": "SideCoreComboGroup",
"pos_id": "",
"name": "Sides",
"translations": {
"name": "Sides"
}
}
},
{
"id": 680,
"type_id": 3,
"reference_type": "ComboOrderItem",
"order_id": 275,
"menu_item_id": 335563,
"pos_id": null,
"unpaid_item_hash": null,
"name": "Bourbon Cola",
"translations": {
"name": "Bourbon Cola"
},
"type": "Drink",
"is_self_serving": false,
"quantity": 1,
"subtotal": 4837,
"discount": 0,
"service_charge": 0,
"total": 4837,
"tax": 230,
"tax_rate": 5,
"comment": "Bourbon Cola",
"price_level": {
"id": 680,
"order_item_id": 680,
"menu_item_price_level_id": 387455,
"pos_id": null,
"name": "Regular",
"translations": {
"name": "Regular"
},
"price": 4837
},
"modifiers": [],
"image": {
"thumbnail_small": "/storage/images/item_images/_thumbs280/2021-05-14/c8ebd8847f9747850e5d2b07d233de29.png",
"thumbnail_medium": "/storage/images/item_images/_thumbs720/2021-05-14/c8ebd8847f9747850e5d2b07d233de29.png",
"fullsize": "/storage/images/item_images/2021-05-14/c8ebd8847f9747850e5d2b07d233de29.png"
},
"combo_group": {
"id": 164,
"combo_group_id": 642660,
"order_item_id": 680,
"order_combo_meal_id": 100,
"type_id": 2,
"reference_type": "SideCoreComboGroup",
"pos_id": "",
"name": "Bebidas",
"translations": {
"name": "Bebidas"
}
}
}
],
"image": {
"thumbnail_small": "/storage/images/combo_item_images/_thumbs280/2022-07-11/64200feb7cc256928dbcb5985f2240a8.png",
"thumbnail_medium": "/storage/images/combo_item_images/_thumbs720/2022-07-11/64200feb7cc256928dbcb5985f2240a8.png",
"fullsize": "/storage/images/combo_item_images/2022-07-11/64200feb7cc256928dbcb5985f2240a8.png"
}
}
],
"discounts": [],
"payments": [
{
"id": 697734,
"type_id": 2,
"reference_type": "OrderItemPayment",
"ticket_id": 766791,
"payment_method_id": 19,
"payment_processor_type_id": 19,
"payment_processor_id": null,
"total": 44500,
"pos_receipt_id": "",
"stored_payment_method_vault": null
}
],
"refunds": [],
"send_at": "2024-01-18 15:52:00",
"pickup_at": "2024-01-18 16:00:00",
"pickup_code": null,
"ready_at": null,
"delivery_at": null,
"additional_delivery_info": null,
"delivery_delay_time": null,
"arriving_at": "2024-01-18 16:00:00",
"regret_cancel_until": "2024-01-18 15:52:00",
"is_customer_arrived": false,
"cancellation_reason_id": null,
"created_at": "2024-01-18 09:40:32",
"updated_at": "2024-01-18 09:40:33",
"delivery_job": {}
}
}
}
| Attribute | Type | Example Value | Description |
|---|---|---|---|
tip |
Float | 100 | Percentage tip added to order |
tip_rate |
Float | 0.25 | Tip amount added to order |
total |
Float | 44500 | Total value of order |