POST api/POSOrder/CreateAndPlaceOrder

Request Information

URI Parameters

None.

Body Parameters

POSOrder_CreateOrderPlaceRequestClass
NameDescriptionTypeAdditional 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.

Email

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": "1a1606c8-5a56-4b9a-8e0a-f65984f35914",
  "BranchIDF": "bae115fb-8a06-422d-89b3-94c30fdc0c91",
  "CounterIDF": "94435a83-24f9-4b1a-9709-c67275a9fd96",
  "CounterBalanceHistoryIDF": "b9e9863f-1732-4ccd-91a2-e593959725fe",
  "TrackingOrderID": "sample string 5",
  "OrderDate": "sample string 6",
  "OrderType": 7,
  "OrderSource": 8,
  "OrderStatus": "sample string 9",
  "PaymentStatus": "sample string 10",
  "SeatIDF": "141f7ad3-5f26-4feb-9f47-0b6324e3d2c9",
  "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": "0dbc15f0-efa0-47b9-afa2-ab623e14affc",
  "CustomerIDF": "996ad39d-d3ef-4f3f-951f-f0d19668ff34",
  "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": "d8350a54-a079-4b68-af16-1d6fe7fac228",
      "MenuItemIDF": "2deb2a12-3553-4057-9b07-94f900016eed",
      "VariantIDF": "63576922-83c6-480e-baaa-3f72184a6ece",
      "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": "d8350a54-a079-4b68-af16-1d6fe7fac228",
      "MenuItemIDF": "2deb2a12-3553-4057-9b07-94f900016eed",
      "VariantIDF": "63576922-83c6-480e-baaa-3f72184a6ece",
      "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": "a5a0340f-519a-4c9f-8f07-5ed68b20ae23",
      "MenuItemIDF": "852ce408-115f-4ece-9478-49b42eda8aa3",
      "VariantIDF": "762ccbed-a294-4dc4-a378-28ed088de937",
      "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": "a5a0340f-519a-4c9f-8f07-5ed68b20ae23",
      "MenuItemIDF": "852ce408-115f-4ece-9478-49b42eda8aa3",
      "VariantIDF": "762ccbed-a294-4dc4-a378-28ed088de937",
      "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": "14b612f0-e775-4d3d-a806-1424ef4015d3",
      "TaxIDF": "88f9cd4e-78e8-442b-a5b7-a4fc06ea5893",
      "TaxName": "sample string 3",
      "TaxPercentage": 4.0,
      "TaxAmount": 5.0
    },
    {
      "OrderTaxIDP": "14b612f0-e775-4d3d-a806-1424ef4015d3",
      "TaxIDF": "88f9cd4e-78e8-442b-a5b7-a4fc06ea5893",
      "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>bae115fb-8a06-422d-89b3-94c30fdc0c91</BranchIDF>
  <CounterBalanceHistoryIDF>b9e9863f-1732-4ccd-91a2-e593959725fe</CounterBalanceHistoryIDF>
  <CounterIDF>94435a83-24f9-4b1a-9709-c67275a9fd96</CounterIDF>
  <CustomerIDF>996ad39d-d3ef-4f3f-951f-f0d19668ff34</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>852ce408-115f-4ece-9478-49b42eda8aa3</MenuItemIDF>
      <OrderDetailIDP>a5a0340f-519a-4c9f-8f07-5ed68b20ae23</OrderDetailIDP>
      <Quantity>5</Quantity>
      <TotalItemAmount>21</TotalItemAmount>
      <VariantIDF>762ccbed-a294-4dc4-a378-28ed088de937</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>852ce408-115f-4ece-9478-49b42eda8aa3</MenuItemIDF>
      <OrderDetailIDP>a5a0340f-519a-4c9f-8f07-5ed68b20ae23</OrderDetailIDP>
      <Quantity>5</Quantity>
      <TotalItemAmount>21</TotalItemAmount>
      <VariantIDF>762ccbed-a294-4dc4-a378-28ed088de937</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>2deb2a12-3553-4057-9b07-94f900016eed</MenuItemIDF>
      <OrderDetailIDP>d8350a54-a079-4b68-af16-1d6fe7fac228</OrderDetailIDP>
      <Quantity>4</Quantity>
      <TotalItemAmount>20</TotalItemAmount>
      <VariantIDF>63576922-83c6-480e-baaa-3f72184a6ece</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>2deb2a12-3553-4057-9b07-94f900016eed</MenuItemIDF>
      <OrderDetailIDP>d8350a54-a079-4b68-af16-1d6fe7fac228</OrderDetailIDP>
      <Quantity>4</Quantity>
      <TotalItemAmount>20</TotalItemAmount>
      <VariantIDF>63576922-83c6-480e-baaa-3f72184a6ece</VariantIDF>
      <VariantPrice>11</VariantPrice>
    </POSOrder_MenuItemDetailClass>
  </OrderMenu>
  <OrderSource>8</OrderSource>
  <OrderStatus>sample string 9</OrderStatus>
  <OrderTax>
    <POSOrder_OrderTaxDetailClass>
      <OrderTaxIDP>14b612f0-e775-4d3d-a806-1424ef4015d3</OrderTaxIDP>
      <TaxAmount>5</TaxAmount>
      <TaxIDF>88f9cd4e-78e8-442b-a5b7-a4fc06ea5893</TaxIDF>
      <TaxName>sample string 3</TaxName>
      <TaxPercentage>4</TaxPercentage>
    </POSOrder_OrderTaxDetailClass>
    <POSOrder_OrderTaxDetailClass>
      <OrderTaxIDP>14b612f0-e775-4d3d-a806-1424ef4015d3</OrderTaxIDP>
      <TaxAmount>5</TaxAmount>
      <TaxIDF>88f9cd4e-78e8-442b-a5b7-a4fc06ea5893</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>1a1606c8-5a56-4b9a-8e0a-f65984f35914</RestaurantIDF>
  <SeatIDF>141f7ad3-5f26-4feb-9f47-0b6324e3d2c9</SeatIDF>
  <SubTotal>17</SubTotal>
  <TableNo>sample string 11</TableNo>
  <TaxAmountTotal>18</TaxAmountTotal>
  <TotalAmount>19</TotalAmount>
  <TrackingOrderID>sample string 5</TrackingOrderID>
  <UserIDF>0dbc15f0-efa0-47b9-afa2-ab623e14affc</UserIDF>
</POSOrder_CreateOrderPlaceRequestClass>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.