POST Reservation/SyncReservationsDocumentation
This endpoint does nothing and exists solely for the Auto Generated Documentation
Request Information
URI Parameters
None.
Body Parameters
The POS will send the following query command, to receive specific reservations
SyncReservationsRequest| Name | Type | Description | Additional information |
|---|---|---|---|
| State | OpenTableReservationStatusEnum |
Nullable: Status of the Table |
|
| ScheduledTimeFromUtc | date |
Nullable: Time when the ticket was scheduled from |
|
| ScheduledTimeToUtc | date |
Nullable: Time when the ticket was scheduled to |
|
| UpdatedAfterUtc | date |
Nullable: Time when the ticket was updated after |
Request Formats
application/json, text/json
Sample:
{
"State": 1,
"ScheduledTimeFromUtc": "2024-11-21T06:26:36.5648738+00:00",
"ScheduledTimeToUtc": "2024-11-21T06:26:36.5648738+00:00",
"UpdatedAfterUtc": "2024-11-21T06:26:36.5648738+00:00"
}
application/xml, text/xml
Sample:
<SyncReservationsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.Reservation"> <ScheduledTimeFromUtc>2024-11-21T06:26:36.5648738+00:00</ScheduledTimeFromUtc> <ScheduledTimeToUtc>2024-11-21T06:26:36.5648738+00:00</ScheduledTimeToUtc> <State>NotConfirmed</State> <UpdatedAfterUtc>2024-11-21T06:26:36.5648738+00:00</UpdatedAfterUtc> </SyncReservationsRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The POS expects back this model, containing a list of ReservationCommands
SyncReservationsResponse| Name | Type | Description | Additional information |
|---|---|---|---|
| SyncReservations | Collection of ReservationRequestCommand |
None. |
Response Formats
application/json, text/json
Sample:
{
"SyncReservations": [
{
"ReservationID": "sample string 1",
"State": 0,
"TableNumber": [
1,
2
],
"Origin": "sample string 2",
"ScheduledTimeUtc": "2024-11-21T06:26:36.580608+00:00",
"CreatedDateUtc": "2024-11-21T06:26:36.580608+00:00",
"Duration": 1,
"BookingReference": "sample string 5",
"BookingType": "sample string 6",
"Covers": 7,
"GuestNotes": "sample string 8",
"RestaurantNotes": "sample string 9",
"Cancelled": true,
"RestaurantID": "sample string 11",
"Guest": {
"GuestID": "sample string 1",
"CustomerName": "sample string 2",
"PhoneNo": "sample string 3",
"Email": "sample string 4"
},
"SubmitCalculatedOnlineOrderV2RequestCommand": {
"UID": "f4c30115-72e5-4f51-83ea-954169ee793f",
"CRMMemberID": "sample string 2",
"RequestedDeliveryTimeUTC": "2024-11-21T06:26:36.580608+00:00",
"GratuityAmount": 1.0,
"DeliveryChargeAmount": 1.0,
"ThirdPartyOrigin": "sample string 3",
"ThirdPartyTransactionID": "sample string 4",
"ThirdPartyReference": "sample string 5",
"OrderParams": "sample string 6",
"MergeOnToExistingBill": true,
"CalculateOrderCommand": {
"Origin": "sample string 1",
"UID": "4adce68e-d931-40fd-a584-953902aa5e5e",
"PriceGroupID": 3,
"TableNumber": 1,
"Covers": 1,
"ServiceChargeAmount": 1.0,
"StandardOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
}
],
"StandardMacroItems": [
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
}
]
},
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
}
]
}
],
"ConfigurableDiscounts": [
{
"DiscountID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"CustomDiscount": {
"ReasonTypeID": 1,
"Value": 2.0,
"isPercent": true
}
},
{
"DiscountID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"CustomDiscount": {
"ReasonTypeID": 1,
"Value": 2.0,
"isPercent": true
}
}
],
"ManualPromotions": [
{
"PromotionID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
]
},
{
"PromotionID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
]
}
]
},
"CustomerInfo": {
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Line1": "sample string 3",
"Line2": "sample string 4",
"City": "sample string 5",
"PostCode": "sample string 6",
"ContactNumber": "sample string 7",
"ContactAccessCode": "sample string 8",
"AdditionalDetails": {
"SaftCompanyName": "sample string 1",
"SaftCompanyAddress": "sample string 2",
"SaftTaxId": "sample string 3"
}
},
"Tenders": [
{
"TenderTypeID": 1,
"PLU": "sample string 2",
"Amount": 3.0
},
{
"TenderTypeID": 1,
"PLU": "sample string 2",
"Amount": 3.0
}
]
},
"PrePayments": [
{
"TenderTypeID": 1,
"Amount": 2.0
},
{
"TenderTypeID": 1,
"Amount": 2.0
}
]
},
{
"ReservationID": "sample string 1",
"State": 0,
"TableNumber": [
1,
2
],
"Origin": "sample string 2",
"ScheduledTimeUtc": "2024-11-21T06:26:36.580608+00:00",
"CreatedDateUtc": "2024-11-21T06:26:36.580608+00:00",
"Duration": 1,
"BookingReference": "sample string 5",
"BookingType": "sample string 6",
"Covers": 7,
"GuestNotes": "sample string 8",
"RestaurantNotes": "sample string 9",
"Cancelled": true,
"RestaurantID": "sample string 11",
"Guest": {
"GuestID": "sample string 1",
"CustomerName": "sample string 2",
"PhoneNo": "sample string 3",
"Email": "sample string 4"
},
"SubmitCalculatedOnlineOrderV2RequestCommand": {
"UID": "f4c30115-72e5-4f51-83ea-954169ee793f",
"CRMMemberID": "sample string 2",
"RequestedDeliveryTimeUTC": "2024-11-21T06:26:36.580608+00:00",
"GratuityAmount": 1.0,
"DeliveryChargeAmount": 1.0,
"ThirdPartyOrigin": "sample string 3",
"ThirdPartyTransactionID": "sample string 4",
"ThirdPartyReference": "sample string 5",
"OrderParams": "sample string 6",
"MergeOnToExistingBill": true,
"CalculateOrderCommand": {
"Origin": "sample string 1",
"UID": "4adce68e-d931-40fd-a584-953902aa5e5e",
"PriceGroupID": 3,
"TableNumber": 1,
"Covers": 1,
"ServiceChargeAmount": 1.0,
"StandardOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
}
],
"StandardMacroItems": [
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
}
]
},
{
"ParentOrderItem": {
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
"ChildrenOrderItems": [
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
},
{
"PLU": "sample string 1",
"Quantity": 2,
"OverridePrice": 1.0,
"ItemRef": "sample string 3",
"Modifiers": [
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
},
{
"OptionGroupID": 1,
"OptionItemID": 2,
"IsRemove": true,
"OverridePrice": 1.0,
"Modifiers": []
}
],
"ItemNotes": [
"sample string 1",
"sample string 2"
]
}
]
}
],
"ConfigurableDiscounts": [
{
"DiscountID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"CustomDiscount": {
"ReasonTypeID": 1,
"Value": 2.0,
"isPercent": true
}
},
{
"DiscountID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
],
"CustomDiscount": {
"ReasonTypeID": 1,
"Value": 2.0,
"isPercent": true
}
}
],
"ManualPromotions": [
{
"PromotionID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
]
},
{
"PromotionID": 1,
"AffectedItemRefs": [
"sample string 1",
"sample string 2"
]
}
]
},
"CustomerInfo": {
"FirstName": "sample string 1",
"LastName": "sample string 2",
"Line1": "sample string 3",
"Line2": "sample string 4",
"City": "sample string 5",
"PostCode": "sample string 6",
"ContactNumber": "sample string 7",
"ContactAccessCode": "sample string 8",
"AdditionalDetails": {
"SaftCompanyName": "sample string 1",
"SaftCompanyAddress": "sample string 2",
"SaftTaxId": "sample string 3"
}
},
"Tenders": [
{
"TenderTypeID": 1,
"PLU": "sample string 2",
"Amount": 3.0
},
{
"TenderTypeID": 1,
"PLU": "sample string 2",
"Amount": 3.0
}
]
},
"PrePayments": [
{
"TenderTypeID": 1,
"Amount": 2.0
},
{
"TenderTypeID": 1,
"Amount": 2.0
}
]
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.