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": "5c36258d-0388-4504-9f81-b052560d447e",
"BranchIDF": "13ff7796-606e-4d42-9a5c-e4de3d5c14c3",
"CounterIDF": "3a51623a-15f5-4a19-b782-1f7614490758",
"CounterBalanceHistoryIDF": "1dd2dcce-0294-4503-aa2e-0847f68b3a2a",
"TrackingOrderID": "sample string 5",
"OrderDate": "sample string 6",
"OrderType": 7,
"OrderSource": 8,
"OrderStatus": "sample string 9",
"PaymentStatus": "sample string 10",
"SeatIDF": "01e75b37-1fb0-4f79-a888-c3cdd4dfc144",
"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": "104ba02e-4754-40b0-8a25-4576b6b3615b",
"CustomerIDF": "f26cfdbf-8a5a-4e48-9934-32326415a2ab",
"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": "22812b57-e642-4d8d-bfab-cc81f8f80494",
"MenuItemIDF": "7d312c62-4553-491d-a759-93ce6fc6b0b1",
"VariantIDF": "8eccf920-9caa-4e77-91ff-e5ea92c2662e",
"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": "22812b57-e642-4d8d-bfab-cc81f8f80494",
"MenuItemIDF": "7d312c62-4553-491d-a759-93ce6fc6b0b1",
"VariantIDF": "8eccf920-9caa-4e77-91ff-e5ea92c2662e",
"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": "83eca3ab-139c-42cc-9de0-39fce4e7830d",
"MenuItemIDF": "4743dba9-a6f0-42e8-8296-1db1af05777b",
"VariantIDF": "d741f505-bc7b-4588-b2a5-1a1f209e6122",
"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": "83eca3ab-139c-42cc-9de0-39fce4e7830d",
"MenuItemIDF": "4743dba9-a6f0-42e8-8296-1db1af05777b",
"VariantIDF": "d741f505-bc7b-4588-b2a5-1a1f209e6122",
"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": "37b04e0b-31a6-4ebe-a015-5c42e2ca1cdd",
"TaxIDF": "00cab0b6-00f0-4343-8993-33b066bc6e4d",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
},
{
"OrderTaxIDP": "37b04e0b-31a6-4ebe-a015-5c42e2ca1cdd",
"TaxIDF": "00cab0b6-00f0-4343-8993-33b066bc6e4d",
"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>13ff7796-606e-4d42-9a5c-e4de3d5c14c3</BranchIDF>
<CounterBalanceHistoryIDF>1dd2dcce-0294-4503-aa2e-0847f68b3a2a</CounterBalanceHistoryIDF>
<CounterIDF>3a51623a-15f5-4a19-b782-1f7614490758</CounterIDF>
<CustomerIDF>f26cfdbf-8a5a-4e48-9934-32326415a2ab</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>4743dba9-a6f0-42e8-8296-1db1af05777b</MenuItemIDF>
<OrderDetailIDP>83eca3ab-139c-42cc-9de0-39fce4e7830d</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>d741f505-bc7b-4588-b2a5-1a1f209e6122</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>4743dba9-a6f0-42e8-8296-1db1af05777b</MenuItemIDF>
<OrderDetailIDP>83eca3ab-139c-42cc-9de0-39fce4e7830d</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>d741f505-bc7b-4588-b2a5-1a1f209e6122</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>7d312c62-4553-491d-a759-93ce6fc6b0b1</MenuItemIDF>
<OrderDetailIDP>22812b57-e642-4d8d-bfab-cc81f8f80494</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>8eccf920-9caa-4e77-91ff-e5ea92c2662e</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>7d312c62-4553-491d-a759-93ce6fc6b0b1</MenuItemIDF>
<OrderDetailIDP>22812b57-e642-4d8d-bfab-cc81f8f80494</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>8eccf920-9caa-4e77-91ff-e5ea92c2662e</VariantIDF>
<VariantPrice>11</VariantPrice>
</POSOrder_MenuItemDetailClass>
</OrderMenu>
<OrderSource>8</OrderSource>
<OrderStatus>sample string 9</OrderStatus>
<OrderTax>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>37b04e0b-31a6-4ebe-a015-5c42e2ca1cdd</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>00cab0b6-00f0-4343-8993-33b066bc6e4d</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>37b04e0b-31a6-4ebe-a015-5c42e2ca1cdd</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>00cab0b6-00f0-4343-8993-33b066bc6e4d</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>5c36258d-0388-4504-9f81-b052560d447e</RestaurantIDF>
<SeatIDF>01e75b37-1fb0-4f79-a888-c3cdd4dfc144</SeatIDF>
<SubTotal>17</SubTotal>
<TableNo>sample string 11</TableNo>
<TaxAmountTotal>18</TaxAmountTotal>
<TotalAmount>19</TotalAmount>
<TrackingOrderID>sample string 5</TrackingOrderID>
<UserIDF>104ba02e-4754-40b0-8a25-4576b6b3615b</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. |