POST api/POSOrder/POSProcessSingleOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SequentialOrderID	string	None.
PaymentResponse	Collection of POSOrder_PaymentResponseClass	None.
PaymentGatewayIDF	globally unique identifier	None.
PaymentGatewaySettingIDF	globally unique identifier	None.
PaymentGatewayNo	integer	None.
PayAmountCash	decimal number	None.
DueAmountCash	decimal number	None.
ReturnAmountCash	decimal number	None.
RewardPoints	integer	None.
PointsSpent	integer	None.
RewardPrice	decimal number	None.
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:

{
  "SequentialOrderID": "sample string 1",
  "PaymentResponse": [
    {
      "TransactionID": "sample string 1",
      "ResponseCode": "sample string 2",
      "ResponseMessage": "sample string 3",
      "PaymentStatus": "sample string 4",
      "PaidAmount": 5.0,
      "RequestData": "sample string 6",
      "ResponseData": "sample string 7",
      "PaymentGatewayNo": "sample string 8",
      "PayAmountCash": 1.0,
      "DueAmountCash": 1.0,
      "ReturnAmountCash": 1.0
    },
    {
      "TransactionID": "sample string 1",
      "ResponseCode": "sample string 2",
      "ResponseMessage": "sample string 3",
      "PaymentStatus": "sample string 4",
      "PaidAmount": 5.0,
      "RequestData": "sample string 6",
      "ResponseData": "sample string 7",
      "PaymentGatewayNo": "sample string 8",
      "PayAmountCash": 1.0,
      "DueAmountCash": 1.0,
      "ReturnAmountCash": 1.0
    }
  ],
  "PaymentGatewayIDF": "da023b5a-a581-4681-ba3b-9c6c0e9ecf6e",
  "PaymentGatewaySettingIDF": "d62a373f-0063-4a28-a852-bacecb7ebaa8",
  "PaymentGatewayNo": 1,
  "PayAmountCash": 1.0,
  "DueAmountCash": 1.0,
  "ReturnAmountCash": 1.0,
  "RewardPoints": 1,
  "PointsSpent": 1,
  "RewardPrice": 1.0,
  "RestaurantIDF": "f8563f03-ea6f-417b-872f-00685097e151",
  "BranchIDF": "dfc79da0-ee8b-4d09-85ec-ca4d8b5735c0",
  "CounterIDF": "32b1df67-9a4d-407d-a57f-07e45649871e",
  "CounterBalanceHistoryIDF": "99c5aee4-5983-4c98-90cd-727f7758f167",
  "TrackingOrderID": "sample string 6",
  "OrderDate": "sample string 7",
  "OrderType": 8,
  "OrderSource": 9,
  "OrderStatus": "sample string 10",
  "PaymentStatus": "sample string 11",
  "SeatIDF": "7775a7a8-2ff1-4c19-b103-992e349a24e3",
  "TableNo": "sample string 12",
  "QuantityTotal": 13,
  "ItemTotal": 14.0,
  "ModifierTotal": 15.0,
  "DiscountTotal": 16.0,
  "ItemTaxTotal": 17.0,
  "SubTotal": 18.0,
  "TaxAmountTotal": 19.0,
  "TotalAmount": 20.0,
  "AdjustedAmount": 21.0,
  "GrandTotal": 22.0,
  "UserIDF": "831fd355-f8f8-4e2f-8908-1c5f620ee0e7",
  "CustomerIDF": "e924707c-0155-4dcb-9b61-152e98e25865",
  "Name": "sample string 24",
  "Email": "sample string 25",
  "PhoneCountryCode": "sample string 26",
  "PhoneNumber": "sample string 27",
  "AdditionalNotes": "sample string 28",
  "PackagingName": "sample string 29",
  "EnvironmentType": 30,
  "OrderMenu": [
    {
      "OrderDetailIDP": "66c44abe-3755-4293-abd6-212aa94471a5",
      "MenuItemIDF": "0806d8a2-012c-43aa-8fde-8175c4cbe359",
      "VariantIDF": "c861c480-dcb7-43c3-ad8e-6fdb2759d3f3",
      "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": "66c44abe-3755-4293-abd6-212aa94471a5",
      "MenuItemIDF": "0806d8a2-012c-43aa-8fde-8175c4cbe359",
      "VariantIDF": "c861c480-dcb7-43c3-ad8e-6fdb2759d3f3",
      "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": "d94aa9c2-57e7-4c59-9589-5690732cc9d3",
      "MenuItemIDF": "061f0952-3d82-4835-928e-40ce275edaa2",
      "VariantIDF": "52cd1867-e80a-4a4d-8ee6-949103a2e537",
      "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": "d94aa9c2-57e7-4c59-9589-5690732cc9d3",
      "MenuItemIDF": "061f0952-3d82-4835-928e-40ce275edaa2",
      "VariantIDF": "52cd1867-e80a-4a4d-8ee6-949103a2e537",
      "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": "42275974-ab69-4522-b4f3-5289e8a2a8b6",
      "TaxIDF": "ddf0fab9-6162-472a-b0fe-eb58fcc2734a",
      "TaxName": "sample string 3",
      "TaxPercentage": 4.0,
      "TaxAmount": 5.0
    },
    {
      "OrderTaxIDP": "42275974-ab69-4522-b4f3-5289e8a2a8b6",
      "TaxIDF": "ddf0fab9-6162-472a-b0fe-eb58fcc2734a",
      "TaxName": "sample string 3",
      "TaxPercentage": 4.0,
      "TaxAmount": 5.0
    }
  ]
}

application/xml, text/xml

Sample:

<POSOrder_ProcessSingleOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SQLClass">
  <AdditionalNotes>sample string 28</AdditionalNotes>
  <AdjustedAmount>21</AdjustedAmount>
  <BranchIDF>dfc79da0-ee8b-4d09-85ec-ca4d8b5735c0</BranchIDF>
  <CounterBalanceHistoryIDF>99c5aee4-5983-4c98-90cd-727f7758f167</CounterBalanceHistoryIDF>
  <CounterIDF>32b1df67-9a4d-407d-a57f-07e45649871e</CounterIDF>
  <CustomerIDF>e924707c-0155-4dcb-9b61-152e98e25865</CustomerIDF>
  <DiscountTotal>16</DiscountTotal>
  <Email>sample string 25</Email>
  <EnvironmentType>30</EnvironmentType>
  <GrandTotal>22</GrandTotal>
  <ItemTaxTotal>17</ItemTaxTotal>
  <ItemTotal>14</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>061f0952-3d82-4835-928e-40ce275edaa2</MenuItemIDF>
      <OrderDetailIDP>d94aa9c2-57e7-4c59-9589-5690732cc9d3</OrderDetailIDP>
      <Quantity>5</Quantity>
      <TotalItemAmount>21</TotalItemAmount>
      <VariantIDF>52cd1867-e80a-4a4d-8ee6-949103a2e537</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>061f0952-3d82-4835-928e-40ce275edaa2</MenuItemIDF>
      <OrderDetailIDP>d94aa9c2-57e7-4c59-9589-5690732cc9d3</OrderDetailIDP>
      <Quantity>5</Quantity>
      <TotalItemAmount>21</TotalItemAmount>
      <VariantIDF>52cd1867-e80a-4a4d-8ee6-949103a2e537</VariantIDF>
      <VariantPrice>12</VariantPrice>
      <IsCancelOrder>true</IsCancelOrder>
    </POSOrder_KOTMenuItemDetailClass>
  </KOTMenu>
  <ModifierTotal>15</ModifierTotal>
  <Name>sample string 24</Name>
  <OrderDate>sample string 7</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>0806d8a2-012c-43aa-8fde-8175c4cbe359</MenuItemIDF>
      <OrderDetailIDP>66c44abe-3755-4293-abd6-212aa94471a5</OrderDetailIDP>
      <Quantity>4</Quantity>
      <TotalItemAmount>20</TotalItemAmount>
      <VariantIDF>c861c480-dcb7-43c3-ad8e-6fdb2759d3f3</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>0806d8a2-012c-43aa-8fde-8175c4cbe359</MenuItemIDF>
      <OrderDetailIDP>66c44abe-3755-4293-abd6-212aa94471a5</OrderDetailIDP>
      <Quantity>4</Quantity>
      <TotalItemAmount>20</TotalItemAmount>
      <VariantIDF>c861c480-dcb7-43c3-ad8e-6fdb2759d3f3</VariantIDF>
      <VariantPrice>11</VariantPrice>
    </POSOrder_MenuItemDetailClass>
  </OrderMenu>
  <OrderSource>9</OrderSource>
  <OrderStatus>sample string 10</OrderStatus>
  <OrderTax>
    <POSOrder_OrderTaxDetailClass>
      <OrderTaxIDP>42275974-ab69-4522-b4f3-5289e8a2a8b6</OrderTaxIDP>
      <TaxAmount>5</TaxAmount>
      <TaxIDF>ddf0fab9-6162-472a-b0fe-eb58fcc2734a</TaxIDF>
      <TaxName>sample string 3</TaxName>
      <TaxPercentage>4</TaxPercentage>
    </POSOrder_OrderTaxDetailClass>
    <POSOrder_OrderTaxDetailClass>
      <OrderTaxIDP>42275974-ab69-4522-b4f3-5289e8a2a8b6</OrderTaxIDP>
      <TaxAmount>5</TaxAmount>
      <TaxIDF>ddf0fab9-6162-472a-b0fe-eb58fcc2734a</TaxIDF>
      <TaxName>sample string 3</TaxName>
      <TaxPercentage>4</TaxPercentage>
    </POSOrder_OrderTaxDetailClass>
  </OrderTax>
  <OrderType>8</OrderType>
  <PackagingName>sample string 29</PackagingName>
  <PaymentStatus>sample string 11</PaymentStatus>
  <PhoneCountryCode>sample string 26</PhoneCountryCode>
  <PhoneNumber>sample string 27</PhoneNumber>
  <QuantityTotal>13</QuantityTotal>
  <RestaurantIDF>f8563f03-ea6f-417b-872f-00685097e151</RestaurantIDF>
  <SeatIDF>7775a7a8-2ff1-4c19-b103-992e349a24e3</SeatIDF>
  <SubTotal>18</SubTotal>
  <TableNo>sample string 12</TableNo>
  <TaxAmountTotal>19</TaxAmountTotal>
  <TotalAmount>20</TotalAmount>
  <TrackingOrderID>sample string 6</TrackingOrderID>
  <UserIDF>831fd355-f8f8-4e2f-8908-1c5f620ee0e7</UserIDF>
  <DueAmountCash>1</DueAmountCash>
  <PayAmountCash>1</PayAmountCash>
  <PaymentGatewayIDF>da023b5a-a581-4681-ba3b-9c6c0e9ecf6e</PaymentGatewayIDF>
  <PaymentGatewayNo>1</PaymentGatewayNo>
  <PaymentGatewaySettingIDF>d62a373f-0063-4a28-a852-bacecb7ebaa8</PaymentGatewaySettingIDF>
  <PaymentResponse>
    <POSOrder_PaymentResponseClass>
      <DueAmountCash>1</DueAmountCash>
      <PaidAmount>5</PaidAmount>
      <PayAmountCash>1</PayAmountCash>
      <PaymentGatewayNo>sample string 8</PaymentGatewayNo>
      <PaymentStatus>sample string 4</PaymentStatus>
      <RequestData>sample string 6</RequestData>
      <ResponseCode>sample string 2</ResponseCode>
      <ResponseData>sample string 7</ResponseData>
      <ResponseMessage>sample string 3</ResponseMessage>
      <ReturnAmountCash>1</ReturnAmountCash>
      <TransactionID>sample string 1</TransactionID>
    </POSOrder_PaymentResponseClass>
    <POSOrder_PaymentResponseClass>
      <DueAmountCash>1</DueAmountCash>
      <PaidAmount>5</PaidAmount>
      <PayAmountCash>1</PayAmountCash>
      <PaymentGatewayNo>sample string 8</PaymentGatewayNo>
      <PaymentStatus>sample string 4</PaymentStatus>
      <RequestData>sample string 6</RequestData>
      <ResponseCode>sample string 2</ResponseCode>
      <ResponseData>sample string 7</ResponseData>
      <ResponseMessage>sample string 3</ResponseMessage>
      <ReturnAmountCash>1</ReturnAmountCash>
      <TransactionID>sample string 1</TransactionID>
    </POSOrder_PaymentResponseClass>
  </PaymentResponse>
  <PointsSpent>1</PointsSpent>
  <ReturnAmountCash>1</ReturnAmountCash>
  <RewardPoints>1</RewardPoints>
  <RewardPrice>1</RewardPrice>
  <SequentialOrderID>sample string 1</SequentialOrderID>
</POSOrder_ProcessSingleOrder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	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.