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. |
|
| IsCreatedFromPOSPay | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"TrackingOrderID": "sample string 1",
"RestaurantIDF": "be6ee678-c239-4aa9-b489-71a0fadd24fc",
"BranchIDF": "b8fa791c-0dce-445f-be78-90c706629f4e",
"CounterIDF": "848770aa-5d31-4250-90da-133337038186",
"CounterBalanceHistoryIDF": "e024b13f-a1da-483b-aaa1-0e189aaf1061",
"OrderDate": "sample string 6",
"OrderType": 7,
"OrderSource": 8,
"SeatIDF": "154b74b7-89ce-474c-9d2e-22c36fd48bbd",
"TableNo": "sample string 9",
"UserIDF": "0a97af98-02f2-4310-801c-bbee404c0afd",
"CustomerIDF": "fc677ac8-2775-4145-a3dd-04068a0c8132",
"OrderMenu": [
{
"OrderDetailIdP": "b4843d7b-8206-48fa-8b1f-96d3f6c4c923",
"MenuItemIDF": "927daf5d-670d-406b-a603-28b7c9d62405",
"VariantIDF": "d1b89b18-77ca-45c3-b07d-bcf7ce469a05",
"Quantity": 3,
"ItemAdditionalNotes": "sample string 4",
"OrderMenuModifiers": [
{
"ModifierIDF": "9e264463-4550-42ba-a445-1fe051b2adc2"
},
{
"ModifierIDF": "9e264463-4550-42ba-a445-1fe051b2adc2"
}
]
},
{
"OrderDetailIdP": "b4843d7b-8206-48fa-8b1f-96d3f6c4c923",
"MenuItemIDF": "927daf5d-670d-406b-a603-28b7c9d62405",
"VariantIDF": "d1b89b18-77ca-45c3-b07d-bcf7ce469a05",
"Quantity": 3,
"ItemAdditionalNotes": "sample string 4",
"OrderMenuModifiers": [
{
"ModifierIDF": "9e264463-4550-42ba-a445-1fe051b2adc2"
},
{
"ModifierIDF": "9e264463-4550-42ba-a445-1fe051b2adc2"
}
]
}
],
"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>b8fa791c-0dce-445f-be78-90c706629f4e</BranchIDF>
<CounterBalanceHistoryIDF>e024b13f-a1da-483b-aaa1-0e189aaf1061</CounterBalanceHistoryIDF>
<CounterIDF>848770aa-5d31-4250-90da-133337038186</CounterIDF>
<CustomerIDF>fc677ac8-2775-4145-a3dd-04068a0c8132</CustomerIDF>
<EnvironmentType>12</EnvironmentType>
<IsCreatedFromPOSPay>true</IsCreatedFromPOSPay>
<OrderDate>sample string 6</OrderDate>
<OrderMenu>
<POSOrderV1_OrderDetailRequest>
<ItemAdditionalNotes>sample string 4</ItemAdditionalNotes>
<MenuItemIDF>927daf5d-670d-406b-a603-28b7c9d62405</MenuItemIDF>
<OrderDetailIdP>b4843d7b-8206-48fa-8b1f-96d3f6c4c923</OrderDetailIdP>
<OrderMenuModifiers>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>9e264463-4550-42ba-a445-1fe051b2adc2</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>9e264463-4550-42ba-a445-1fe051b2adc2</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
</OrderMenuModifiers>
<Quantity>3</Quantity>
<VariantIDF>d1b89b18-77ca-45c3-b07d-bcf7ce469a05</VariantIDF>
</POSOrderV1_OrderDetailRequest>
<POSOrderV1_OrderDetailRequest>
<ItemAdditionalNotes>sample string 4</ItemAdditionalNotes>
<MenuItemIDF>927daf5d-670d-406b-a603-28b7c9d62405</MenuItemIDF>
<OrderDetailIdP>b4843d7b-8206-48fa-8b1f-96d3f6c4c923</OrderDetailIdP>
<OrderMenuModifiers>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>9e264463-4550-42ba-a445-1fe051b2adc2</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
<POSOrderV1_OrderMenuModifierRequest>
<ModifierIDF>9e264463-4550-42ba-a445-1fe051b2adc2</ModifierIDF>
</POSOrderV1_OrderMenuModifierRequest>
</OrderMenuModifiers>
<Quantity>3</Quantity>
<VariantIDF>d1b89b18-77ca-45c3-b07d-bcf7ce469a05</VariantIDF>
</POSOrderV1_OrderDetailRequest>
</OrderMenu>
<OrderSource>8</OrderSource>
<OrderType>7</OrderType>
<PackagingName>sample string 13</PackagingName>
<RedeemPoints>1</RedeemPoints>
<RestaurantIDF>be6ee678-c239-4aa9-b489-71a0fadd24fc</RestaurantIDF>
<SeatIDF>154b74b7-89ce-474c-9d2e-22c36fd48bbd</SeatIDF>
<TableNo>sample string 9</TableNo>
<TrackingOrderID>sample string 1</TrackingOrderID>
<UserIDF>0a97af98-02f2-4310-801c-bbee404c0afd</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. |