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": "f214d22e-8012-4880-b7d0-a6d9ed599ed9",
"BranchIDF": "18db5da6-f246-4d5a-8cef-39535fd01269",
"CounterIDF": "4d395fb2-072f-4557-9c26-874de858913b",
"CounterBalanceHistoryIDF": "03d19629-5316-4ed6-a806-9022f4fbc9d0",
"TrackingOrderID": "sample string 5",
"OrderDate": "sample string 6",
"OrderType": 7,
"OrderSource": 8,
"OrderStatus": "sample string 9",
"PaymentStatus": "sample string 10",
"SeatIDF": "a4158e6d-fc2d-47a2-a5b1-f4dc8db3e613",
"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": "10e8b67f-d79e-4bde-bff5-c135f9cc5f9a",
"CustomerIDF": "743942eb-75c1-427d-a43c-104f7009e13f",
"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": "3e3b06f9-e815-401d-b503-a285cf84b52c",
"MenuItemIDF": "16da80a8-9384-4a68-bada-27ce046f8ae0",
"VariantIDF": "a588706c-2bf4-49ef-a046-8cf3ad173f56",
"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": "3e3b06f9-e815-401d-b503-a285cf84b52c",
"MenuItemIDF": "16da80a8-9384-4a68-bada-27ce046f8ae0",
"VariantIDF": "a588706c-2bf4-49ef-a046-8cf3ad173f56",
"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": "c1f717ce-317c-43ac-a918-d169e05ac3af",
"MenuItemIDF": "11ce4c21-aa6d-4f18-9512-539dc56b71ba",
"VariantIDF": "2cc1bc99-59b4-47f0-90c9-1996d0069c83",
"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": "c1f717ce-317c-43ac-a918-d169e05ac3af",
"MenuItemIDF": "11ce4c21-aa6d-4f18-9512-539dc56b71ba",
"VariantIDF": "2cc1bc99-59b4-47f0-90c9-1996d0069c83",
"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": "b4fe182b-55da-4b38-9f39-2e45d581c53c",
"TaxIDF": "07e4a3d4-8d8c-47b8-a208-aa84fbe44270",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
},
{
"OrderTaxIDP": "b4fe182b-55da-4b38-9f39-2e45d581c53c",
"TaxIDF": "07e4a3d4-8d8c-47b8-a208-aa84fbe44270",
"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>18db5da6-f246-4d5a-8cef-39535fd01269</BranchIDF>
<CounterBalanceHistoryIDF>03d19629-5316-4ed6-a806-9022f4fbc9d0</CounterBalanceHistoryIDF>
<CounterIDF>4d395fb2-072f-4557-9c26-874de858913b</CounterIDF>
<CustomerIDF>743942eb-75c1-427d-a43c-104f7009e13f</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>11ce4c21-aa6d-4f18-9512-539dc56b71ba</MenuItemIDF>
<OrderDetailIDP>c1f717ce-317c-43ac-a918-d169e05ac3af</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>2cc1bc99-59b4-47f0-90c9-1996d0069c83</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>11ce4c21-aa6d-4f18-9512-539dc56b71ba</MenuItemIDF>
<OrderDetailIDP>c1f717ce-317c-43ac-a918-d169e05ac3af</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>2cc1bc99-59b4-47f0-90c9-1996d0069c83</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>16da80a8-9384-4a68-bada-27ce046f8ae0</MenuItemIDF>
<OrderDetailIDP>3e3b06f9-e815-401d-b503-a285cf84b52c</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>a588706c-2bf4-49ef-a046-8cf3ad173f56</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>16da80a8-9384-4a68-bada-27ce046f8ae0</MenuItemIDF>
<OrderDetailIDP>3e3b06f9-e815-401d-b503-a285cf84b52c</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>a588706c-2bf4-49ef-a046-8cf3ad173f56</VariantIDF>
<VariantPrice>11</VariantPrice>
</POSOrder_MenuItemDetailClass>
</OrderMenu>
<OrderSource>8</OrderSource>
<OrderStatus>sample string 9</OrderStatus>
<OrderTax>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>b4fe182b-55da-4b38-9f39-2e45d581c53c</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>07e4a3d4-8d8c-47b8-a208-aa84fbe44270</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>b4fe182b-55da-4b38-9f39-2e45d581c53c</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>07e4a3d4-8d8c-47b8-a208-aa84fbe44270</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>f214d22e-8012-4880-b7d0-a6d9ed599ed9</RestaurantIDF>
<SeatIDF>a4158e6d-fc2d-47a2-a5b1-f4dc8db3e613</SeatIDF>
<SubTotal>17</SubTotal>
<TableNo>sample string 11</TableNo>
<TaxAmountTotal>18</TaxAmountTotal>
<TotalAmount>19</TotalAmount>
<TrackingOrderID>sample string 5</TrackingOrderID>
<UserIDF>10e8b67f-d79e-4bde-bff5-c135f9cc5f9a</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. |