POST api/POSOrder/UpdateAndPayOrder
Request Information
URI Parameters
None.
Body Parameters
POSOrder_UpdateOrderPayRequestClass| Name | Description | Type | Additional information |
|---|---|---|---|
| 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. |
|
| 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. |
|
| OrderStatus | string |
None. |
|
| PaymentStatus | 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. |
|
| AdditionalNotes | string |
None. |
|
| PackagingName | string |
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:
{
"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": "db72b56c-d45b-4a4a-af33-db4ef38ad4a8",
"PaymentGatewaySettingIDF": "0d2df700-33fb-4d6b-8136-cbe4f3f745ba",
"PaymentGatewayNo": 3,
"PayAmountCash": 1.0,
"DueAmountCash": 1.0,
"ReturnAmountCash": 1.0,
"RestaurantIDF": "dfaba644-95c1-415b-b9a8-f3708e099e4f",
"BranchIDF": "bd238aef-613d-4416-ab7b-c642eac483d4",
"CounterIDF": "669c1e57-86a4-42d9-b29a-f0456f84e334",
"CounterBalanceHistoryIDF": "8d43bfeb-5483-49eb-ae0d-9ae7754fb9f1",
"TrackingOrderID": "sample string 8",
"OrderDate": "sample string 9",
"OrderStatus": "sample string 10",
"PaymentStatus": "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": 1.0,
"GrandTotal": 20.0,
"UserIDF": "e95fe42a-ecec-48b6-99aa-8ec28572f864",
"AdditionalNotes": "sample string 22",
"PackagingName": "sample string 23",
"OrderMenu": [
{
"OrderDetailIDP": "9482771a-91ae-4ba7-9a08-15dbc91a9c47",
"MenuItemIDF": "5e44d98a-f35b-467b-ab65-417f7882a742",
"VariantIDF": "bfaa0ce2-fc09-4947-aa62-baeab3f3e5fd",
"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": "9482771a-91ae-4ba7-9a08-15dbc91a9c47",
"MenuItemIDF": "5e44d98a-f35b-467b-ab65-417f7882a742",
"VariantIDF": "bfaa0ce2-fc09-4947-aa62-baeab3f3e5fd",
"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": "4c5a84d9-f0e4-4b05-893f-cf2b9368f845",
"MenuItemIDF": "ead05a38-e857-4e81-8e94-9f6209bced46",
"VariantIDF": "b2b1c436-f176-4113-a9de-8b668278f8a6",
"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": "4c5a84d9-f0e4-4b05-893f-cf2b9368f845",
"MenuItemIDF": "ead05a38-e857-4e81-8e94-9f6209bced46",
"VariantIDF": "b2b1c436-f176-4113-a9de-8b668278f8a6",
"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": "22647f3a-a042-4a01-9431-b204cb254d69",
"TaxIDF": "4dcc2029-980e-404f-9eeb-9b47d4cbe174",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
},
{
"OrderTaxIDP": "22647f3a-a042-4a01-9431-b204cb254d69",
"TaxIDF": "4dcc2029-980e-404f-9eeb-9b47d4cbe174",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
}
]
}
application/xml, text/xml
Sample:
<POSOrder_UpdateOrderPayRequestClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SQLClass">
<AdditionalNotes>sample string 22</AdditionalNotes>
<AdjustedAmount>1</AdjustedAmount>
<BranchIDF>bd238aef-613d-4416-ab7b-c642eac483d4</BranchIDF>
<CounterBalanceHistoryIDF>8d43bfeb-5483-49eb-ae0d-9ae7754fb9f1</CounterBalanceHistoryIDF>
<CounterIDF>669c1e57-86a4-42d9-b29a-f0456f84e334</CounterIDF>
<DiscountTotal>15</DiscountTotal>
<GrandTotal>20</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>ead05a38-e857-4e81-8e94-9f6209bced46</MenuItemIDF>
<OrderDetailIDP>4c5a84d9-f0e4-4b05-893f-cf2b9368f845</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>b2b1c436-f176-4113-a9de-8b668278f8a6</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>ead05a38-e857-4e81-8e94-9f6209bced46</MenuItemIDF>
<OrderDetailIDP>4c5a84d9-f0e4-4b05-893f-cf2b9368f845</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>b2b1c436-f176-4113-a9de-8b668278f8a6</VariantIDF>
<VariantPrice>12</VariantPrice>
<IsCancelOrder>true</IsCancelOrder>
</POSOrder_KOTMenuItemDetailClass>
</KOTMenu>
<ModifierTotal>14</ModifierTotal>
<OrderDate>sample string 9</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>5e44d98a-f35b-467b-ab65-417f7882a742</MenuItemIDF>
<OrderDetailIDP>9482771a-91ae-4ba7-9a08-15dbc91a9c47</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>bfaa0ce2-fc09-4947-aa62-baeab3f3e5fd</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>5e44d98a-f35b-467b-ab65-417f7882a742</MenuItemIDF>
<OrderDetailIDP>9482771a-91ae-4ba7-9a08-15dbc91a9c47</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>bfaa0ce2-fc09-4947-aa62-baeab3f3e5fd</VariantIDF>
<VariantPrice>11</VariantPrice>
</POSOrder_MenuItemDetailClass>
</OrderMenu>
<OrderStatus>sample string 10</OrderStatus>
<OrderTax>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>22647f3a-a042-4a01-9431-b204cb254d69</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>4dcc2029-980e-404f-9eeb-9b47d4cbe174</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>22647f3a-a042-4a01-9431-b204cb254d69</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>4dcc2029-980e-404f-9eeb-9b47d4cbe174</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
</OrderTax>
<PackagingName>sample string 23</PackagingName>
<PaymentStatus>sample string 11</PaymentStatus>
<QuantityTotal>12</QuantityTotal>
<RestaurantIDF>dfaba644-95c1-415b-b9a8-f3708e099e4f</RestaurantIDF>
<SubTotal>17</SubTotal>
<TaxAmountTotal>18</TaxAmountTotal>
<TotalAmount>19</TotalAmount>
<TrackingOrderID>sample string 8</TrackingOrderID>
<UserIDF>e95fe42a-ecec-48b6-99aa-8ec28572f864</UserIDF>
<DueAmountCash>1</DueAmountCash>
<PayAmountCash>1</PayAmountCash>
<PaymentGatewayIDF>db72b56c-d45b-4a4a-af33-db4ef38ad4a8</PaymentGatewayIDF>
<PaymentGatewayNo>3</PaymentGatewayNo>
<PaymentGatewaySettingIDF>0d2df700-33fb-4d6b-8136-cbe4f3f745ba</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>
<ReturnAmountCash>1</ReturnAmountCash>
</POSOrder_UpdateOrderPayRequestClass>
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. |