POST v{version}/OnlineOrders/CancelOnlineOrder
Sends an order to the POS
Request Information
URI Parameters
| Name | Type | Description | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
CancelOnlineOrderV2ApiModel| Name | Type | Description | Additional information |
|---|---|---|---|
| SiteId | integer |
Required |
|
| UID | globally unique identifier |
The UID of the Submitted Order |
Required |
| Reason | string |
Free text field to store the partner order reference |
Required String length: inclusive between 0 and 10000 |
Request Formats
application/json, text/json
Sample:
{
"SiteId": 1,
"UID": "2fc9f484-237d-43d5-8390-7dc58d311ee7",
"Reason": "sample string 1"
}
application/xml, text/xml
Sample:
<CancelOnlineOrderV2ApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.v2.OnlineOrdersV2.APIModels"> <Reason>sample string 1</Reason> <SiteId>1</SiteId> <UID>2fc9f484-237d-43d5-8390-7dc58d311ee7</UID> </CancelOnlineOrderV2ApiModel>
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": "c1efca1b-3931-4329-8a73-4064c264935e",
"TableNumber": 1,
"PriceGroupID": 2,
"Covers": 3,
"ServiceChargeAmount": 1.0,
"Terminal": "sample string 4",
"TotalGross": 5.0,
"EstimatedTimeUTC": "2024-11-21T06:36:24.3650088+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.