POST api/POSOrderV1/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. |
Request Formats
application/json, text/json
Sample:
{
"TrackingOrderID": "sample string 1",
"RestaurantIDF": "340b70b9-f9ba-4e22-a7ab-5c074b5b3451",
"BranchIDF": "694b4fb3-f4fd-4800-ab18-9cde6574fb3e",
"CounterIDF": "0e7a9807-7659-4f09-88f4-211cbca83bb8",
"CounterBalanceHistoryIDF": "e7f69fe4-eac9-4cbf-9dbc-6cefa3a7d771",
"OrderDate": "sample string 6",
"OrderType": 7,
"OrderSource": 8,
"SeatIDF": "8cdb43d6-3986-4cfe-a3ca-c0632196208e",
"TableNo": "sample string 9",
"UserIDF": "69e9722f-342d-4fd4-a3d4-3a763332d7ed",
"CustomerIDF": "5b8963f8-d1ba-4eeb-b4db-a7bf4d64b68a",
"OrderMenu": [
{
"OrderDetailIdP": "7fb64552-07a6-4291-b055-03605cdd5381",
"MenuItemIDF": "e1dfe713-c2dd-4b69-95c6-229ef0b9df81",
"VariantIDF": "d039ad72-e31d-4c3a-9383-eca25101eba1",
"Quantity": 3,
"ItemAdditionalNotes": "sample string 4",
"OrderMenuModifiers": [
{
"ModifierIDF": "14f60346-7dcb-49ae-8e96-bec71f229d33"
},
{
"ModifierIDF": "14f60346-7dcb-49ae-8e96-bec71f229d33"
}
]
},
{
"OrderDetailIdP": "7fb64552-07a6-4291-b055-03605cdd5381",
"MenuItemIDF": "e1dfe713-c2dd-4b69-95c6-229ef0b9df81",
"VariantIDF": "d039ad72-e31d-4c3a-9383-eca25101eba1",
"Quantity": 3,
"ItemAdditionalNotes": "sample string 4",
"OrderMenuModifiers": [
{
"ModifierIDF": "14f60346-7dcb-49ae-8e96-bec71f229d33"
},
{
"ModifierIDF": "14f60346-7dcb-49ae-8e96-bec71f229d33"
}
]
}
],
"AdditionalNotes": "sample string 11",
"EnvironmentType": 12,
"PackagingName": "sample string 13",
"RedeemPoints": 1
}
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>694b4fb3-f4fd-4800-ab18-9cde6574fb3e</BranchIDF>
<CounterBalanceHistoryIDF>e7f69fe4-eac9-4cbf-9dbc-6cefa3a7d771</CounterBalanceHistoryIDF>
<CounterIDF>0e7a9807-7659-4f09-88f4-211cbca83bb8</CounterIDF>
<CustomerIDF>5b8963f8-d1ba-4eeb-b4db-a7bf4d64b68a</CustomerIDF>
<EnvironmentType>12</EnvironmentType>
<OrderDate>sample string 6</OrderDate>
<OrderMenu>
<POSOrderV1_OrderDetailRequest>
<ItemAdditionalNotes>sample string 4</ItemAdditionalNotes>
<MenuItemIDF>e1dfe713-c2dd-4b69-95c6-229ef0b9df81</MenuItemIDF>
<OrderDetailIdP>7fb64552-07a6-4291-b055-03605cdd5381</OrderDetailIdP>
<OrderMenuModifiers>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>14f60346-7dcb-49ae-8e96-bec71f229d33</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>14f60346-7dcb-49ae-8e96-bec71f229d33</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
</OrderMenuModifiers>
<Quantity>3</Quantity>
<VariantIDF>d039ad72-e31d-4c3a-9383-eca25101eba1</VariantIDF>
</POSOrderV1_OrderDetailRequest>
<POSOrderV1_OrderDetailRequest>
<ItemAdditionalNotes>sample string 4</ItemAdditionalNotes>
<MenuItemIDF>e1dfe713-c2dd-4b69-95c6-229ef0b9df81</MenuItemIDF>
<OrderDetailIdP>7fb64552-07a6-4291-b055-03605cdd5381</OrderDetailIdP>
<OrderMenuModifiers>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>14f60346-7dcb-49ae-8e96-bec71f229d33</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>14f60346-7dcb-49ae-8e96-bec71f229d33</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
</OrderMenuModifiers>
<Quantity>3</Quantity>
<VariantIDF>d039ad72-e31d-4c3a-9383-eca25101eba1</VariantIDF>
</POSOrderV1_OrderDetailRequest>
</OrderMenu>
<OrderSource>8</OrderSource>
<OrderType>7</OrderType>
<PackagingName>sample string 13</PackagingName>
<RedeemPoints>1</RedeemPoints>
<RestaurantIDF>340b70b9-f9ba-4e22-a7ab-5c074b5b3451</RestaurantIDF>
<SeatIDF>8cdb43d6-3986-4cfe-a3ca-c0632196208e</SeatIDF>
<TableNo>sample string 9</TableNo>
<TrackingOrderID>sample string 1</TrackingOrderID>
<UserIDF>69e9722f-342d-4fd4-a3d4-3a763332d7ed</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. |