POST api/orders/hold
Request Information
URI Parameters
None.
Body Parameters
HoldOrderRequestDto| Name | Description | Type | Additional information |
|---|---|---|---|
| TranDate | date |
None. |
|
| HotelCode | string |
None. |
|
| POSCenterCode | string |
None. |
|
| POSCenterID | integer |
None. |
|
| TableNo | string |
None. |
|
| RoomNo | string |
None. |
|
| NoOfPax | integer |
None. |
|
| NameID | integer |
None. |
|
| DeliveryMethod | string |
None. |
|
| PhoneNo | string |
None. |
|
| CreatedBy | string |
None. |
|
| ServeBy | string |
None. |
|
| StartTimeStamp | date |
None. |
|
| Narration | string |
None. |
|
| Lines | Collection of OrderLineDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"TranDate": "2026-01-21T16:46:43.0711519+05:30",
"HotelCode": "sample string 2",
"POSCenterCode": "sample string 3",
"POSCenterID": 1,
"TableNo": "sample string 4",
"RoomNo": "sample string 5",
"NoOfPax": 6,
"NameID": 7,
"DeliveryMethod": "sample string 8",
"PhoneNo": "sample string 9",
"CreatedBy": "sample string 10",
"ServeBy": "sample string 11",
"StartTimeStamp": "2026-01-21T16:46:43.0711519+05:30",
"Narration": "sample string 13",
"Lines": [
{
"ItemCode": "sample string 1",
"ItemName": "sample string 2",
"Qty": 3.0,
"Price": 1.0,
"Cost": 1.0,
"Cover": "sample string 4",
"PriceGroup": "sample string 5",
"IsDummy": true,
"IsAddon": true,
"ItemID": 1
},
{
"ItemCode": "sample string 1",
"ItemName": "sample string 2",
"Qty": 3.0,
"Price": 1.0,
"Cost": 1.0,
"Cover": "sample string 4",
"PriceGroup": "sample string 5",
"IsDummy": true,
"IsAddon": true,
"ItemID": 1
}
]
}
application/xml, text/xml
Sample:
<HoldOrderRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CitrusPOS_WebAPI2">
<CreatedBy>sample string 10</CreatedBy>
<DeliveryMethod>sample string 8</DeliveryMethod>
<HotelCode>sample string 2</HotelCode>
<Lines>
<OrderLineDto>
<Cost>1</Cost>
<Cover>sample string 4</Cover>
<IsAddon>true</IsAddon>
<IsDummy>true</IsDummy>
<ItemCode>sample string 1</ItemCode>
<ItemID>1</ItemID>
<ItemName>sample string 2</ItemName>
<Price>1</Price>
<PriceGroup>sample string 5</PriceGroup>
<Qty>3</Qty>
</OrderLineDto>
<OrderLineDto>
<Cost>1</Cost>
<Cover>sample string 4</Cover>
<IsAddon>true</IsAddon>
<IsDummy>true</IsDummy>
<ItemCode>sample string 1</ItemCode>
<ItemID>1</ItemID>
<ItemName>sample string 2</ItemName>
<Price>1</Price>
<PriceGroup>sample string 5</PriceGroup>
<Qty>3</Qty>
</OrderLineDto>
</Lines>
<NameID>7</NameID>
<Narration>sample string 13</Narration>
<NoOfPax>6</NoOfPax>
<POSCenterCode>sample string 3</POSCenterCode>
<POSCenterID>1</POSCenterID>
<PhoneNo>sample string 9</PhoneNo>
<RoomNo>sample string 5</RoomNo>
<ServeBy>sample string 11</ServeBy>
<StartTimeStamp>2026-01-21T16:46:43.0711519+05:30</StartTimeStamp>
<TableNo>sample string 4</TableNo>
<TranDate>2026-01-21T16:46:43.0711519+05:30</TranDate>
</HoldOrderRequestDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.