POST api/POSOrder/CreateAndPlaceOrder
Request Information
URI Parameters
None.
Body Parameters
POSOrder_CreateOrderPlaceRequestClass| Name | Description | Type | Additional information |
|---|---|---|---|
| RestaurantIDF | globally unique identifier |
None. |
|
| BranchIDF | globally unique identifier |
None. |
|
| CounterIDF | globally unique identifier |
None. |
|
| CounterBalanceHistoryIDF | globally unique identifier |
None. |
|
| TrackingOrderID | string |
None. |
|
| OrderDate | string |
None. |
|
| OrderType | integer |
None. |
|
| OrderSource | integer |
None. |
|
| OrderStatus | string |
None. |
|
| PaymentStatus | string |
None. |
|
| SeatIDF | globally unique identifier |
None. |
|
| TableNo | string |
None. |
|
| QuantityTotal | integer |
None. |
|
| ItemTotal | decimal number |
None. |
|
| ModifierTotal | decimal number |
None. |
|
| DiscountTotal | decimal number |
None. |
|
| ItemTaxTotal | decimal number |
None. |
|
| SubTotal | decimal number |
None. |
|
| TaxAmountTotal | decimal number |
None. |
|
| TotalAmount | decimal number |
None. |
|
| AdjustedAmount | decimal number |
None. |
|
| GrandTotal | decimal number |
None. |
|
| UserIDF | globally unique identifier |
None. |
|
| CustomerIDF | globally unique identifier |
None. |
|
| Name | string |
None. |
|
| string |
None. |
||
| PhoneCountryCode | string |
None. |
|
| PhoneNumber | string |
None. |
|
| AdditionalNotes | string |
None. |
|
| PackagingName | string |
None. |
|
| EnvironmentType | integer |
None. |
|
| OrderMenu | Collection of POSOrder_MenuItemDetailClass |
None. |
|
| KOTMenu | Collection of POSOrder_KOTMenuItemDetailClass |
None. |
|
| OrderTax | Collection of POSOrder_OrderTaxDetailClass |
None. |
Request Formats
application/json, text/json
Sample:
{
"RestaurantIDF": "ec1e4e7d-1ad7-4a0f-bdb3-da5abe14c017",
"BranchIDF": "becd6829-1fc1-4a8c-b654-cd5c378d0277",
"CounterIDF": "62110bde-0594-4bc4-a937-21843e096656",
"CounterBalanceHistoryIDF": "d6d5b17d-ee84-4813-9daf-a64ec56fa64c",
"TrackingOrderID": "sample string 5",
"OrderDate": "sample string 6",
"OrderType": 7,
"OrderSource": 8,
"OrderStatus": "sample string 9",
"PaymentStatus": "sample string 10",
"SeatIDF": "e3524899-1526-40f8-88de-390f222c8e10",
"TableNo": "sample string 11",
"QuantityTotal": 12,
"ItemTotal": 13.0,
"ModifierTotal": 14.0,
"DiscountTotal": 15.0,
"ItemTaxTotal": 16.0,
"SubTotal": 17.0,
"TaxAmountTotal": 18.0,
"TotalAmount": 19.0,
"AdjustedAmount": 20.0,
"GrandTotal": 21.0,
"UserIDF": "49398e3b-ef2c-4016-8397-8a9db199cc96",
"CustomerIDF": "a1623408-2363-4583-9343-421179f049f3",
"Name": "sample string 23",
"Email": "sample string 24",
"PhoneCountryCode": "sample string 25",
"PhoneNumber": "sample string 26",
"AdditionalNotes": "sample string 27",
"PackagingName": "sample string 28",
"EnvironmentType": 29,
"OrderMenu": [
{
"OrderDetailIDP": "a295123a-0b65-49f3-8365-bc479ed1cad4",
"MenuItemIDF": "ad7ef17f-d9f4-41ac-a474-eb36f210f451",
"VariantIDF": "f09ba4f5-6b4a-4969-b0d1-07f0abdaca49",
"Quantity": 4,
"DiscountPercentage": 5.0,
"ItemName": "sample string 6",
"ItemVariantName": "sample string 7",
"ItemTaxPercent": 8.0,
"AllModifierPrices": "sample string 9",
"AllModifierIDFs": "sample string 10",
"VariantPrice": 11.0,
"ItemDiscountPrice": 12.0,
"DiscountedItemAmount": 13.0,
"DiscountedItemTotalAmount": 14.0,
"ItemTaxPrice": 15.0,
"ItemTotal": 16.0,
"ItemTotalTaxPrice": 17.0,
"ItemModifierTotal": 18.0,
"ItemDiscountPriceTotal": 19.0,
"TotalItemAmount": 20.0,
"ItemAdditionalNotes": "sample string 21"
},
{
"OrderDetailIDP": "a295123a-0b65-49f3-8365-bc479ed1cad4",
"MenuItemIDF": "ad7ef17f-d9f4-41ac-a474-eb36f210f451",
"VariantIDF": "f09ba4f5-6b4a-4969-b0d1-07f0abdaca49",
"Quantity": 4,
"DiscountPercentage": 5.0,
"ItemName": "sample string 6",
"ItemVariantName": "sample string 7",
"ItemTaxPercent": 8.0,
"AllModifierPrices": "sample string 9",
"AllModifierIDFs": "sample string 10",
"VariantPrice": 11.0,
"ItemDiscountPrice": 12.0,
"DiscountedItemAmount": 13.0,
"DiscountedItemTotalAmount": 14.0,
"ItemTaxPrice": 15.0,
"ItemTotal": 16.0,
"ItemTotalTaxPrice": 17.0,
"ItemModifierTotal": 18.0,
"ItemDiscountPriceTotal": 19.0,
"TotalItemAmount": 20.0,
"ItemAdditionalNotes": "sample string 21"
}
],
"KOTMenu": [
{
"IsCancelOrder": true,
"OrderDetailIDP": "e5c4fef6-a05e-4386-b1eb-4764f749c3b9",
"MenuItemIDF": "3783f137-492f-4253-abdc-d25709ba442c",
"VariantIDF": "d75e5e1b-3ede-4dd5-b1d6-cf39d69655f6",
"Quantity": 5,
"DiscountPercentage": 6.0,
"ItemName": "sample string 7",
"ItemVariantName": "sample string 8",
"ItemTaxPercent": 9.0,
"AllModifierPrices": "sample string 10",
"AllModifierIDFs": "sample string 11",
"VariantPrice": 12.0,
"ItemDiscountPrice": 13.0,
"DiscountedItemAmount": 14.0,
"DiscountedItemTotalAmount": 15.0,
"ItemTaxPrice": 16.0,
"ItemTotal": 17.0,
"ItemTotalTaxPrice": 18.0,
"ItemModifierTotal": 19.0,
"ItemDiscountPriceTotal": 20.0,
"TotalItemAmount": 21.0,
"ItemAdditionalNotes": "sample string 22"
},
{
"IsCancelOrder": true,
"OrderDetailIDP": "e5c4fef6-a05e-4386-b1eb-4764f749c3b9",
"MenuItemIDF": "3783f137-492f-4253-abdc-d25709ba442c",
"VariantIDF": "d75e5e1b-3ede-4dd5-b1d6-cf39d69655f6",
"Quantity": 5,
"DiscountPercentage": 6.0,
"ItemName": "sample string 7",
"ItemVariantName": "sample string 8",
"ItemTaxPercent": 9.0,
"AllModifierPrices": "sample string 10",
"AllModifierIDFs": "sample string 11",
"VariantPrice": 12.0,
"ItemDiscountPrice": 13.0,
"DiscountedItemAmount": 14.0,
"DiscountedItemTotalAmount": 15.0,
"ItemTaxPrice": 16.0,
"ItemTotal": 17.0,
"ItemTotalTaxPrice": 18.0,
"ItemModifierTotal": 19.0,
"ItemDiscountPriceTotal": 20.0,
"TotalItemAmount": 21.0,
"ItemAdditionalNotes": "sample string 22"
}
],
"OrderTax": [
{
"OrderTaxIDP": "df45576e-6ace-468b-9478-7253d8f97cd4",
"TaxIDF": "a6b39a9e-dbed-4166-80e8-22b318b83014",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
},
{
"OrderTaxIDP": "df45576e-6ace-468b-9478-7253d8f97cd4",
"TaxIDF": "a6b39a9e-dbed-4166-80e8-22b318b83014",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
}
]
}
application/xml, text/xml
Sample:
<POSOrder_CreateOrderPlaceRequestClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SQLClass">
<AdditionalNotes>sample string 27</AdditionalNotes>
<AdjustedAmount>20</AdjustedAmount>
<BranchIDF>becd6829-1fc1-4a8c-b654-cd5c378d0277</BranchIDF>
<CounterBalanceHistoryIDF>d6d5b17d-ee84-4813-9daf-a64ec56fa64c</CounterBalanceHistoryIDF>
<CounterIDF>62110bde-0594-4bc4-a937-21843e096656</CounterIDF>
<CustomerIDF>a1623408-2363-4583-9343-421179f049f3</CustomerIDF>
<DiscountTotal>15</DiscountTotal>
<Email>sample string 24</Email>
<EnvironmentType>29</EnvironmentType>
<GrandTotal>21</GrandTotal>
<ItemTaxTotal>16</ItemTaxTotal>
<ItemTotal>13</ItemTotal>
<KOTMenu>
<POSOrder_KOTMenuItemDetailClass>
<AllModifierIDFs>sample string 11</AllModifierIDFs>
<AllModifierPrices>sample string 10</AllModifierPrices>
<DiscountPercentage>6</DiscountPercentage>
<DiscountedItemAmount>14</DiscountedItemAmount>
<DiscountedItemTotalAmount>15</DiscountedItemTotalAmount>
<ItemAdditionalNotes>sample string 22</ItemAdditionalNotes>
<ItemDiscountPrice>13</ItemDiscountPrice>
<ItemDiscountPriceTotal>20</ItemDiscountPriceTotal>
<ItemModifierTotal>19</ItemModifierTotal>
<ItemName>sample string 7</ItemName>
<ItemTaxPercent>9</ItemTaxPercent>
<ItemTaxPrice>16</ItemTaxPrice>
<ItemTotal>17</ItemTotal>
<ItemTotalTaxPrice>18</ItemTotalTaxPrice>
<ItemVariantName>sample string 8</ItemVariantName>
<MenuItemIDF>3783f137-492f-4253-abdc-d25709ba442c</MenuItemIDF>
<OrderDetailIDP>e5c4fef6-a05e-4386-b1eb-4764f749c3b9</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>d75e5e1b-3ede-4dd5-b1d6-cf39d69655f6</VariantIDF>
<VariantPrice>12</VariantPrice>
<IsCancelOrder>true</IsCancelOrder>
</POSOrder_KOTMenuItemDetailClass>
<POSOrder_KOTMenuItemDetailClass>
<AllModifierIDFs>sample string 11</AllModifierIDFs>
<AllModifierPrices>sample string 10</AllModifierPrices>
<DiscountPercentage>6</DiscountPercentage>
<DiscountedItemAmount>14</DiscountedItemAmount>
<DiscountedItemTotalAmount>15</DiscountedItemTotalAmount>
<ItemAdditionalNotes>sample string 22</ItemAdditionalNotes>
<ItemDiscountPrice>13</ItemDiscountPrice>
<ItemDiscountPriceTotal>20</ItemDiscountPriceTotal>
<ItemModifierTotal>19</ItemModifierTotal>
<ItemName>sample string 7</ItemName>
<ItemTaxPercent>9</ItemTaxPercent>
<ItemTaxPrice>16</ItemTaxPrice>
<ItemTotal>17</ItemTotal>
<ItemTotalTaxPrice>18</ItemTotalTaxPrice>
<ItemVariantName>sample string 8</ItemVariantName>
<MenuItemIDF>3783f137-492f-4253-abdc-d25709ba442c</MenuItemIDF>
<OrderDetailIDP>e5c4fef6-a05e-4386-b1eb-4764f749c3b9</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>d75e5e1b-3ede-4dd5-b1d6-cf39d69655f6</VariantIDF>
<VariantPrice>12</VariantPrice>
<IsCancelOrder>true</IsCancelOrder>
</POSOrder_KOTMenuItemDetailClass>
</KOTMenu>
<ModifierTotal>14</ModifierTotal>
<Name>sample string 23</Name>
<OrderDate>sample string 6</OrderDate>
<OrderMenu>
<POSOrder_MenuItemDetailClass>
<AllModifierIDFs>sample string 10</AllModifierIDFs>
<AllModifierPrices>sample string 9</AllModifierPrices>
<DiscountPercentage>5</DiscountPercentage>
<DiscountedItemAmount>13</DiscountedItemAmount>
<DiscountedItemTotalAmount>14</DiscountedItemTotalAmount>
<ItemAdditionalNotes>sample string 21</ItemAdditionalNotes>
<ItemDiscountPrice>12</ItemDiscountPrice>
<ItemDiscountPriceTotal>19</ItemDiscountPriceTotal>
<ItemModifierTotal>18</ItemModifierTotal>
<ItemName>sample string 6</ItemName>
<ItemTaxPercent>8</ItemTaxPercent>
<ItemTaxPrice>15</ItemTaxPrice>
<ItemTotal>16</ItemTotal>
<ItemTotalTaxPrice>17</ItemTotalTaxPrice>
<ItemVariantName>sample string 7</ItemVariantName>
<MenuItemIDF>ad7ef17f-d9f4-41ac-a474-eb36f210f451</MenuItemIDF>
<OrderDetailIDP>a295123a-0b65-49f3-8365-bc479ed1cad4</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>f09ba4f5-6b4a-4969-b0d1-07f0abdaca49</VariantIDF>
<VariantPrice>11</VariantPrice>
</POSOrder_MenuItemDetailClass>
<POSOrder_MenuItemDetailClass>
<AllModifierIDFs>sample string 10</AllModifierIDFs>
<AllModifierPrices>sample string 9</AllModifierPrices>
<DiscountPercentage>5</DiscountPercentage>
<DiscountedItemAmount>13</DiscountedItemAmount>
<DiscountedItemTotalAmount>14</DiscountedItemTotalAmount>
<ItemAdditionalNotes>sample string 21</ItemAdditionalNotes>
<ItemDiscountPrice>12</ItemDiscountPrice>
<ItemDiscountPriceTotal>19</ItemDiscountPriceTotal>
<ItemModifierTotal>18</ItemModifierTotal>
<ItemName>sample string 6</ItemName>
<ItemTaxPercent>8</ItemTaxPercent>
<ItemTaxPrice>15</ItemTaxPrice>
<ItemTotal>16</ItemTotal>
<ItemTotalTaxPrice>17</ItemTotalTaxPrice>
<ItemVariantName>sample string 7</ItemVariantName>
<MenuItemIDF>ad7ef17f-d9f4-41ac-a474-eb36f210f451</MenuItemIDF>
<OrderDetailIDP>a295123a-0b65-49f3-8365-bc479ed1cad4</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>f09ba4f5-6b4a-4969-b0d1-07f0abdaca49</VariantIDF>
<VariantPrice>11</VariantPrice>
</POSOrder_MenuItemDetailClass>
</OrderMenu>
<OrderSource>8</OrderSource>
<OrderStatus>sample string 9</OrderStatus>
<OrderTax>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>df45576e-6ace-468b-9478-7253d8f97cd4</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>a6b39a9e-dbed-4166-80e8-22b318b83014</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>df45576e-6ace-468b-9478-7253d8f97cd4</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>a6b39a9e-dbed-4166-80e8-22b318b83014</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
</OrderTax>
<OrderType>7</OrderType>
<PackagingName>sample string 28</PackagingName>
<PaymentStatus>sample string 10</PaymentStatus>
<PhoneCountryCode>sample string 25</PhoneCountryCode>
<PhoneNumber>sample string 26</PhoneNumber>
<QuantityTotal>12</QuantityTotal>
<RestaurantIDF>ec1e4e7d-1ad7-4a0f-bdb3-da5abe14c017</RestaurantIDF>
<SeatIDF>e3524899-1526-40f8-88de-390f222c8e10</SeatIDF>
<SubTotal>17</SubTotal>
<TableNo>sample string 11</TableNo>
<TaxAmountTotal>18</TaxAmountTotal>
<TotalAmount>19</TotalAmount>
<TrackingOrderID>sample string 5</TrackingOrderID>
<UserIDF>49398e3b-ef2c-4016-8397-8a9db199cc96</UserIDF>
</POSOrder_CreateOrderPlaceRequestClass>
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. |