POST api/POSOrderV2/POSPlaceOrder
Request Information
URI Parameters
None.
Body Parameters
POSOrderV1_PlaceOrderRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| TrackingOrderID | string |
None. |
|
| RestaurantIDF | globally unique identifier |
None. |
|
| BranchIDF | globally unique identifier |
None. |
|
| CounterIDF | globally unique identifier |
None. |
|
| CounterBalanceHistoryIDF | globally unique identifier |
None. |
|
| OrderDate | string |
None. |
|
| OrderType | integer |
None. |
|
| OrderSource | integer |
None. |
|
| SeatIDF | globally unique identifier |
None. |
|
| TableNo | string |
None. |
|
| UserIDF | globally unique identifier |
None. |
|
| CustomerIDF | globally unique identifier |
None. |
|
| OrderMenu | Collection of POSOrderV1_OrderDetailRequest |
None. |
|
| AdditionalNotes | string |
None. |
|
| EnvironmentType | integer |
None. |
|
| PackagingName | string |
None. |
|
| RedeemPoints | integer |
None. |
|
| IsCreatedFromPOSPay | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"TrackingOrderID": "sample string 1",
"RestaurantIDF": "e63aa254-fd4e-4f7d-b8cc-49ee4fae98bf",
"BranchIDF": "edb83e4a-576e-43fa-a0c1-1288e60512db",
"CounterIDF": "72fed4de-2ed3-428a-ad67-236fc95c6c32",
"CounterBalanceHistoryIDF": "abad7cd8-cd58-481e-8278-19c38c6852f5",
"OrderDate": "sample string 6",
"OrderType": 7,
"OrderSource": 8,
"SeatIDF": "6084e9fe-a62e-415f-bb00-0afcbf0bb6d6",
"TableNo": "sample string 9",
"UserIDF": "e5975e90-1a8e-474f-885e-a45558b83709",
"CustomerIDF": "4612007e-eaf8-4828-9814-41cd13e0a49d",
"OrderMenu": [
{
"OrderDetailIdP": "6fa9676f-b569-467b-ab05-13774cc14934",
"MenuItemIDF": "98208cda-68a0-4aef-bd71-d55c62ea41b6",
"VariantIDF": "e0df6bef-51a5-4230-9ce1-631863986d4f",
"Quantity": 3,
"ItemAdditionalNotes": "sample string 4",
"OrderMenuModifiers": [
{
"ModifierIDF": "8fd6065b-336d-4c83-8150-d34b9c385962"
},
{
"ModifierIDF": "8fd6065b-336d-4c83-8150-d34b9c385962"
}
]
},
{
"OrderDetailIdP": "6fa9676f-b569-467b-ab05-13774cc14934",
"MenuItemIDF": "98208cda-68a0-4aef-bd71-d55c62ea41b6",
"VariantIDF": "e0df6bef-51a5-4230-9ce1-631863986d4f",
"Quantity": 3,
"ItemAdditionalNotes": "sample string 4",
"OrderMenuModifiers": [
{
"ModifierIDF": "8fd6065b-336d-4c83-8150-d34b9c385962"
},
{
"ModifierIDF": "8fd6065b-336d-4c83-8150-d34b9c385962"
}
]
}
],
"AdditionalNotes": "sample string 11",
"EnvironmentType": 12,
"PackagingName": "sample string 13",
"RedeemPoints": 1,
"IsCreatedFromPOSPay": true
}
application/xml, text/xml
Sample:
<POSOrderV1_PlaceOrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SQLClass">
<AdditionalNotes>sample string 11</AdditionalNotes>
<BranchIDF>edb83e4a-576e-43fa-a0c1-1288e60512db</BranchIDF>
<CounterBalanceHistoryIDF>abad7cd8-cd58-481e-8278-19c38c6852f5</CounterBalanceHistoryIDF>
<CounterIDF>72fed4de-2ed3-428a-ad67-236fc95c6c32</CounterIDF>
<CustomerIDF>4612007e-eaf8-4828-9814-41cd13e0a49d</CustomerIDF>
<EnvironmentType>12</EnvironmentType>
<IsCreatedFromPOSPay>true</IsCreatedFromPOSPay>
<OrderDate>sample string 6</OrderDate>
<OrderMenu>
<POSOrderV1_OrderDetailRequest>
<ItemAdditionalNotes>sample string 4</ItemAdditionalNotes>
<MenuItemIDF>98208cda-68a0-4aef-bd71-d55c62ea41b6</MenuItemIDF>
<OrderDetailIdP>6fa9676f-b569-467b-ab05-13774cc14934</OrderDetailIdP>
<OrderMenuModifiers>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>8fd6065b-336d-4c83-8150-d34b9c385962</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>8fd6065b-336d-4c83-8150-d34b9c385962</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
</OrderMenuModifiers>
<Quantity>3</Quantity>
<VariantIDF>e0df6bef-51a5-4230-9ce1-631863986d4f</VariantIDF>
</POSOrderV1_OrderDetailRequest>
<POSOrderV1_OrderDetailRequest>
<ItemAdditionalNotes>sample string 4</ItemAdditionalNotes>
<MenuItemIDF>98208cda-68a0-4aef-bd71-d55c62ea41b6</MenuItemIDF>
<OrderDetailIdP>6fa9676f-b569-467b-ab05-13774cc14934</OrderDetailIdP>
<OrderMenuModifiers>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>8fd6065b-336d-4c83-8150-d34b9c385962</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>8fd6065b-336d-4c83-8150-d34b9c385962</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
</OrderMenuModifiers>
<Quantity>3</Quantity>
<VariantIDF>e0df6bef-51a5-4230-9ce1-631863986d4f</VariantIDF>
</POSOrderV1_OrderDetailRequest>
</OrderMenu>
<OrderSource>8</OrderSource>
<OrderType>7</OrderType>
<PackagingName>sample string 13</PackagingName>
<RedeemPoints>1</RedeemPoints>
<RestaurantIDF>e63aa254-fd4e-4f7d-b8cc-49ee4fae98bf</RestaurantIDF>
<SeatIDF>6084e9fe-a62e-415f-bb00-0afcbf0bb6d6</SeatIDF>
<TableNo>sample string 9</TableNo>
<TrackingOrderID>sample string 1</TrackingOrderID>
<UserIDF>e5975e90-1a8e-474f-885e-a45558b83709</UserIDF>
</POSOrderV1_PlaceOrderRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |