POST api/Order/ProcessOrder
Request Information
URI Parameters
None.
Body Parameters
OrderDetailClass| Name | Description | Type | Additional information |
|---|---|---|---|
| TrackingOrderID | string |
None. |
|
| UserIDF | globally unique identifier |
None. |
|
| OrderType | integer |
None. |
|
| OrderSource | integer |
None. |
|
| EnvironmentType | integer |
None. |
|
| RestaurantIDF | globally unique identifier |
None. |
|
| BranchIDF | globally unique identifier |
None. |
|
| SeatIDF | globally unique identifier |
None. |
|
| OrderDate | string |
None. |
|
| OrderMenu | Collection of OrderMenuClass |
None. |
|
| KOTMenu | Collection of KOTMenuClass |
None. |
|
| OrderTax | Collection of OrderTaxClass |
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. |
|
| GrandTotal | decimal number |
None. |
|
| AdjustedAmount | decimal number |
None. |
|
| AdditionalNotes | string |
None. |
|
| GuestInfo | Collection of Object |
None. |
|
| PaymentGatewayID | globally unique identifier |
None. |
|
| PaymentGatewaySettingID | globally unique identifier |
None. |
|
| TableNo | string |
None. |
|
| PackagingName | string |
None. |
|
| SequentialOrderID | string |
None. |
|
| PayAmountCash | decimal number |
None. |
|
| DueAmountCash | decimal number |
None. |
|
| ReturnAmountCash | decimal number |
None. |
|
| RefundDetails | Collection of RefundDetailsModel |
None. |
Request Formats
application/json, text/json
Sample:
{
"TrackingOrderID": "sample string 1",
"UserIDF": "42690739-a11b-472a-b05a-b71df186e3fa",
"OrderType": 3,
"OrderSource": 4,
"EnvironmentType": 5,
"RestaurantIDF": "a37128e9-7dd6-45ba-be13-daba0315edb6",
"BranchIDF": "8864c56c-071a-4f42-bfbe-b888fcaddbde",
"SeatIDF": "7068d1a8-4def-4379-a387-756fd65e5671",
"OrderDate": "sample string 9",
"OrderMenu": [
{
"OrderDetailIDP": "20e50295-d372-497f-a651-f9bfa07a5b1e",
"MenuItemIDF": "506cbee6-bf57-471e-8ca7-a1f849bdddf3",
"VariantIDF": "c8e6ec11-644d-49d1-956f-a13da67c28a3",
"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,
"ModifierData": [
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 21"
},
{
"OrderDetailIDP": "20e50295-d372-497f-a651-f9bfa07a5b1e",
"MenuItemIDF": "506cbee6-bf57-471e-8ca7-a1f849bdddf3",
"VariantIDF": "c8e6ec11-644d-49d1-956f-a13da67c28a3",
"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,
"ModifierData": [
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 21"
}
],
"KOTMenu": [
{
"IsCancelOrder": true,
"OrderDetailIDP": "8e703116-f6df-4a2c-ac33-d193fb9e9200",
"MenuItemIDF": "8efaad4f-8167-47cc-ba24-a77b58422d8b",
"VariantIDF": "4c464072-690d-4c6a-8b3c-1ba5df772d0c",
"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,
"ModifierData": [
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 22"
},
{
"IsCancelOrder": true,
"OrderDetailIDP": "8e703116-f6df-4a2c-ac33-d193fb9e9200",
"MenuItemIDF": "8efaad4f-8167-47cc-ba24-a77b58422d8b",
"VariantIDF": "4c464072-690d-4c6a-8b3c-1ba5df772d0c",
"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,
"ModifierData": [
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "954479be-2225-4d81-a2d1-72b3da86d156",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 22"
}
],
"OrderTax": [
{
"OrderTaxIDP": "7f82b932-a4a0-47fb-802d-257afe928f4f",
"TaxIDF": "972f277d-d6b4-499a-85fb-5a6af92137f2",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
},
{
"OrderTaxIDP": "7f82b932-a4a0-47fb-802d-257afe928f4f",
"TaxIDF": "972f277d-d6b4-499a-85fb-5a6af92137f2",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
}
],
"QuantityTotal": 10,
"ItemTotal": 11.0,
"ModifierTotal": 12.0,
"DiscountTotal": 13.0,
"ItemTaxTotal": 14.0,
"SubTotal": 15.0,
"TaxAmountTotal": 16.0,
"TotalAmount": 17.0,
"GrandTotal": 18.0,
"AdjustedAmount": 1.0,
"AdditionalNotes": "sample string 19",
"GuestInfo": null,
"PaymentGatewayID": "563cc035-ee66-4743-b99e-69371d1ac4b8",
"PaymentGatewaySettingID": "471054a6-0cac-4440-9363-01c0831cae30",
"TableNo": "sample string 22",
"PackagingName": "sample string 23",
"SequentialOrderID": "sample string 24",
"PayAmountCash": 1.0,
"DueAmountCash": 1.0,
"ReturnAmountCash": 1.0,
"RefundDetails": [
{
"RefundIDP": "98b5525b-066c-4765-afd4-f9b7d8fbf7c5",
"RefundStatus": "sample string 2",
"RefundStatusText": "sample string 3",
"RefundTransactionID": "sample string 4",
"RefundResponseCode": "sample string 5",
"RefundResponseMessage": "sample string 6",
"ReasonForRefund": "sample string 7",
"RefundAmountTotal": 8.0,
"RefundedPayAmountCash": 1.0,
"RefundedDueAmountCash": 1.0,
"RefundedReturnAmountCash": 1.0,
"RefundedPaymentGatewayName": "sample string 9",
"RefundedPaymentGatewayNo": "sample string 10",
"RefundRequestDate": "sample string 11",
"RefundProcessedDate": "sample string 12",
"RefundedReferenceID": "sample string 13",
"RefundedByFullName": "sample string 14",
"RefundedByFullNameGeneralManager": "sample string 15"
},
{
"RefundIDP": "98b5525b-066c-4765-afd4-f9b7d8fbf7c5",
"RefundStatus": "sample string 2",
"RefundStatusText": "sample string 3",
"RefundTransactionID": "sample string 4",
"RefundResponseCode": "sample string 5",
"RefundResponseMessage": "sample string 6",
"ReasonForRefund": "sample string 7",
"RefundAmountTotal": 8.0,
"RefundedPayAmountCash": 1.0,
"RefundedDueAmountCash": 1.0,
"RefundedReturnAmountCash": 1.0,
"RefundedPaymentGatewayName": "sample string 9",
"RefundedPaymentGatewayNo": "sample string 10",
"RefundRequestDate": "sample string 11",
"RefundProcessedDate": "sample string 12",
"RefundedReferenceID": "sample string 13",
"RefundedByFullName": "sample string 14",
"RefundedByFullNameGeneralManager": "sample string 15"
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.
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. |