POST api/POSOrder/CreateAndPayOrder
Request Information
URI Parameters
None.
Body Parameters
POSOrder_CreateOrderPayRequestClass| 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. |
|
| 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:
{
"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": "832b0804-6b6c-4b7d-a132-56cab1b4633c",
"PaymentGatewaySettingIDF": "01da12c8-ccc0-4c32-917f-163414f97942",
"PaymentGatewayNo": 3,
"PayAmountCash": 1.0,
"DueAmountCash": 1.0,
"ReturnAmountCash": 1.0,
"RestaurantIDF": "2459744b-edd4-45f0-bd72-fbedf2b5a6cd",
"BranchIDF": "1b02948a-8344-4ce3-8e88-d66ea7b1ff57",
"CounterIDF": "53cd4ef0-19cc-465d-92c1-90ac345be279",
"CounterBalanceHistoryIDF": "9bc5e957-a30e-4ad6-b792-6689391469d5",
"TrackingOrderID": "sample string 8",
"OrderDate": "sample string 9",
"OrderType": 10,
"OrderSource": 11,
"OrderStatus": "sample string 12",
"PaymentStatus": "sample string 13",
"SeatIDF": "d4e3e697-f468-489c-9b71-94451ab1445d",
"TableNo": "sample string 14",
"QuantityTotal": 15,
"ItemTotal": 16.0,
"ModifierTotal": 17.0,
"DiscountTotal": 18.0,
"ItemTaxTotal": 19.0,
"SubTotal": 20.0,
"TaxAmountTotal": 21.0,
"TotalAmount": 22.0,
"AdjustedAmount": 23.0,
"GrandTotal": 24.0,
"UserIDF": "25e0681a-58e8-4955-827c-03643f5bd01e",
"CustomerIDF": "c35a90e6-2857-4158-81b6-7cc18814c766",
"Name": "sample string 26",
"Email": "sample string 27",
"PhoneCountryCode": "sample string 28",
"PhoneNumber": "sample string 29",
"AdditionalNotes": "sample string 30",
"PackagingName": "sample string 31",
"EnvironmentType": 32,
"OrderMenu": [
{
"OrderDetailIDP": "ad3b8ef7-928c-42e0-bb48-37262fbc2d41",
"MenuItemIDF": "9feab898-e6d0-46e0-9679-c27797258dd5",
"VariantIDF": "77e2a58d-cad4-4140-bd6c-db65824e050c",
"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": "ad3b8ef7-928c-42e0-bb48-37262fbc2d41",
"MenuItemIDF": "9feab898-e6d0-46e0-9679-c27797258dd5",
"VariantIDF": "77e2a58d-cad4-4140-bd6c-db65824e050c",
"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": "bd0607f5-f67c-45c1-9fba-50bb913bacaa",
"MenuItemIDF": "6c1834e1-fc48-47d9-a261-a40c1f13c150",
"VariantIDF": "80dfa17b-d465-4ca7-b040-904be3894b78",
"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": "bd0607f5-f67c-45c1-9fba-50bb913bacaa",
"MenuItemIDF": "6c1834e1-fc48-47d9-a261-a40c1f13c150",
"VariantIDF": "80dfa17b-d465-4ca7-b040-904be3894b78",
"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": "0a41c11d-aa26-4b39-9f9c-70263449d5a3",
"TaxIDF": "f56c54e4-b19c-4bde-b9ed-edbc24ba967c",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
},
{
"OrderTaxIDP": "0a41c11d-aa26-4b39-9f9c-70263449d5a3",
"TaxIDF": "f56c54e4-b19c-4bde-b9ed-edbc24ba967c",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
}
]
}
application/xml, text/xml
Sample:
<POSOrder_CreateOrderPayRequestClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SQLClass">
<AdditionalNotes>sample string 30</AdditionalNotes>
<AdjustedAmount>23</AdjustedAmount>
<BranchIDF>1b02948a-8344-4ce3-8e88-d66ea7b1ff57</BranchIDF>
<CounterBalanceHistoryIDF>9bc5e957-a30e-4ad6-b792-6689391469d5</CounterBalanceHistoryIDF>
<CounterIDF>53cd4ef0-19cc-465d-92c1-90ac345be279</CounterIDF>
<CustomerIDF>c35a90e6-2857-4158-81b6-7cc18814c766</CustomerIDF>
<DiscountTotal>18</DiscountTotal>
<Email>sample string 27</Email>
<EnvironmentType>32</EnvironmentType>
<GrandTotal>24</GrandTotal>
<ItemTaxTotal>19</ItemTaxTotal>
<ItemTotal>16</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>6c1834e1-fc48-47d9-a261-a40c1f13c150</MenuItemIDF>
<OrderDetailIDP>bd0607f5-f67c-45c1-9fba-50bb913bacaa</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>80dfa17b-d465-4ca7-b040-904be3894b78</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>6c1834e1-fc48-47d9-a261-a40c1f13c150</MenuItemIDF>
<OrderDetailIDP>bd0607f5-f67c-45c1-9fba-50bb913bacaa</OrderDetailIDP>
<Quantity>5</Quantity>
<TotalItemAmount>21</TotalItemAmount>
<VariantIDF>80dfa17b-d465-4ca7-b040-904be3894b78</VariantIDF>
<VariantPrice>12</VariantPrice>
<IsCancelOrder>true</IsCancelOrder>
</POSOrder_KOTMenuItemDetailClass>
</KOTMenu>
<ModifierTotal>17</ModifierTotal>
<Name>sample string 26</Name>
<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>9feab898-e6d0-46e0-9679-c27797258dd5</MenuItemIDF>
<OrderDetailIDP>ad3b8ef7-928c-42e0-bb48-37262fbc2d41</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>77e2a58d-cad4-4140-bd6c-db65824e050c</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>9feab898-e6d0-46e0-9679-c27797258dd5</MenuItemIDF>
<OrderDetailIDP>ad3b8ef7-928c-42e0-bb48-37262fbc2d41</OrderDetailIDP>
<Quantity>4</Quantity>
<TotalItemAmount>20</TotalItemAmount>
<VariantIDF>77e2a58d-cad4-4140-bd6c-db65824e050c</VariantIDF>
<VariantPrice>11</VariantPrice>
</POSOrder_MenuItemDetailClass>
</OrderMenu>
<OrderSource>11</OrderSource>
<OrderStatus>sample string 12</OrderStatus>
<OrderTax>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>0a41c11d-aa26-4b39-9f9c-70263449d5a3</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>f56c54e4-b19c-4bde-b9ed-edbc24ba967c</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
<POSOrder_OrderTaxDetailClass>
<OrderTaxIDP>0a41c11d-aa26-4b39-9f9c-70263449d5a3</OrderTaxIDP>
<TaxAmount>5</TaxAmount>
<TaxIDF>f56c54e4-b19c-4bde-b9ed-edbc24ba967c</TaxIDF>
<TaxName>sample string 3</TaxName>
<TaxPercentage>4</TaxPercentage>
</POSOrder_OrderTaxDetailClass>
</OrderTax>
<OrderType>10</OrderType>
<PackagingName>sample string 31</PackagingName>
<PaymentStatus>sample string 13</PaymentStatus>
<PhoneCountryCode>sample string 28</PhoneCountryCode>
<PhoneNumber>sample string 29</PhoneNumber>
<QuantityTotal>15</QuantityTotal>
<RestaurantIDF>2459744b-edd4-45f0-bd72-fbedf2b5a6cd</RestaurantIDF>
<SeatIDF>d4e3e697-f468-489c-9b71-94451ab1445d</SeatIDF>
<SubTotal>20</SubTotal>
<TableNo>sample string 14</TableNo>
<TaxAmountTotal>21</TaxAmountTotal>
<TotalAmount>22</TotalAmount>
<TrackingOrderID>sample string 8</TrackingOrderID>
<UserIDF>25e0681a-58e8-4955-827c-03643f5bd01e</UserIDF>
<DueAmountCash>1</DueAmountCash>
<PayAmountCash>1</PayAmountCash>
<PaymentGatewayIDF>832b0804-6b6c-4b7d-a132-56cab1b4633c</PaymentGatewayIDF>
<PaymentGatewayNo>3</PaymentGatewayNo>
<PaymentGatewaySettingIDF>01da12c8-ccc0-4c32-917f-163414f97942</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_CreateOrderPayRequestClass>
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. |