POST v{version}/OnlineOrders/CalculateOnlineOrder
Sends an order to the POS to be calculated.
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
CalculateOnlineOrderV2ApiModel| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteId | integer |
Required |
|
| PriceGroupID | integer |
Specify what pricegroup you're sending the order as |
Required |
| TableNumber | integer |
Optionally send the order to a table, table numbers are available through the floorplan endpoint |
|
| Covers | integer |
Optionally send the amount of covers for the bill. Leave null if site is using Auto Covers |
|
| ServiceChargeAmount | decimal number |
If left null, then auto-service charge will apply. Set this to 0 if you do not want service charge to apply, otherwise specify your own amount. This is also known as Surcharge amount in other systems |
|
| OrderItems | Collection of CalculateOnlineOrderV2ItemApiModel |
None. |
|
| MacroItems | Collection of CalculateOnlineOrderV2MacroItemApiModel |
None. |
|
| ConfigurableDiscounts | Collection of CalculateOnlineOrderV2ConfigurableDiscountApiModel |
Configurable Discounts are pre-configured discounts that apply on a schedule, and against specific products. |
|
| ManualPromotions | Collection of CalculateOnlineOrderV2ManualPromotionApiModel |
Promotions will auto fire unless you specify override prices, or apply manual promotions. To apply manual promotions you must specify the Items inside the promotion. |
Request Formats
application/json, text/json
Sample:
{
"SiteId": 1,
"PriceGroupID": 1,
"TableNumber": 1,
"Covers": 1,
"ServiceChargeAmount": 1.0,
"OrderItems": [
{
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
},
{
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
}
],
"MacroItems": [
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
},
{
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
}
]
},
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
},
{
"PLU": "sample string 1",
"Quantity": 1,
"OverridePrice": 1.0,
"ItemRef": "sample string 2",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 1,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
{
"ItemNote": "sample string 1"
},
{
"ItemNote": "sample string 1"
}
]
}
]
}
],
"ConfigurableDiscounts": [
{
"DiscountID": 1,
"AffectedItemRefs": [
{
"ItemRef": "sample string 1"
},
{
"ItemRef": "sample string 1"
}
],
"CustomDiscount": {
"ReasonTypeID": 1,
"Value": 2.0,
"isPercent": true
}
},
{
"DiscountID": 1,
"AffectedItemRefs": [
{
"ItemRef": "sample string 1"
},
{
"ItemRef": "sample string 1"
}
],
"CustomDiscount": {
"ReasonTypeID": 1,
"Value": 2.0,
"isPercent": true
}
}
],
"ManualPromotions": [
{
"PromotionID": 1,
"AffectedItemRefs": [
{
"ItemRef": "sample string 1"
},
{
"ItemRef": "sample string 1"
}
]
},
{
"PromotionID": 1,
"AffectedItemRefs": [
{
"ItemRef": "sample string 1"
},
{
"ItemRef": "sample string 1"
}
]
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CalculateOnlineOrderV2ResponseDto| Name | Type | Description | Additional information |
|---|---|---|---|
| UID | globally unique identifier |
The UID of your calculated order. This is used to submit the order when doing Submit Calculated Order |
|
| TableNumber | integer |
None. |
|
| PriceGroupID | integer |
None. |
|
| Covers | integer |
None. |
|
| ServiceChargeAmount | decimal number |
None. |
|
| Terminal | string |
Name of the Terminal that served the request |
|
| TotalGross | decimal number |
The total amount payable for the bill |
|
| EstimatedTimeUTC | date |
This returns either the KMS Average time, or the Minimum time specified via System Settings |
|
| StandardOrderItems | Collection of CalculateOnlineOrderV2ItemResponseDto |
None. |
|
| StandardMacroItems | Collection of CalculateOnlineOrderV2MacroItemResponseDto |
None. |
|
| Promotions | Collection of CalculateOnlineOrderV2PromotionResponseDto |
None. |
|
| ConfigurableDiscounts | Collection of CalculateOnlineOrderV2ConfigurableDiscountResponseDto |
None. |
Response Formats
application/json, text/json
Sample:
{
"UID": "66593e03-fe51-450f-b923-1b46d701e54c",
"TableNumber": 1,
"PriceGroupID": 2,
"Covers": 3,
"ServiceChargeAmount": 1.0,
"Terminal": "sample string 4",
"TotalGross": 5.0,
"EstimatedTimeUTC": "2024-11-21T06:40:14.2905019+00:00",
"StandardOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
}
],
"StandardMacroItems": [
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
}
]
},
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"ExpGross": 4.0,
"ItemNotes": [
"sample string 1",
"sample string 2"
],
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"ExpGross": 4.0,
"Modifiers": []
}
]
}
]
}
],
"Promotions": [
{
"PromotionID": 1,
"ExpGross": 2.0,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"AffectedItems": [
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
},
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
}
]
},
{
"PromotionID": 1,
"ExpGross": 2.0,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"AffectedItems": [
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
},
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
}
]
}
],
"ConfigurableDiscounts": [
{
"DiscountID": 1,
"ExpGross": 2.0,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"AffectedItems": [
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
},
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
}
]
},
{
"DiscountID": 1,
"ExpGross": 2.0,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"AffectedItems": [
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
},
{
"ItemRef": "sample string 1",
"AffectedValue": 2.0
}
]
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.