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": "a33975e9-1d97-44ff-b752-95cf178cea7e",
"OrderType": 3,
"OrderSource": 4,
"EnvironmentType": 5,
"RestaurantIDF": "3a39b6dc-ef07-49a8-82f6-9b2e8104c86d",
"BranchIDF": "2a3f9a8e-8ccf-4d3e-994d-d5f047982b48",
"SeatIDF": "ce5b5a85-a7b1-4270-838c-cbd7ec437efd",
"OrderDate": "sample string 9",
"OrderMenu": [
{
"OrderDetailIDP": "4b30fcb0-3056-475d-bc60-70088f011de4",
"MenuItemIDF": "ff2d514b-c58a-4bae-b893-54d0f57db0b0",
"VariantIDF": "7fe0fb65-ef02-4964-b1a6-213c35113e73",
"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": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 21"
},
{
"OrderDetailIDP": "4b30fcb0-3056-475d-bc60-70088f011de4",
"MenuItemIDF": "ff2d514b-c58a-4bae-b893-54d0f57db0b0",
"VariantIDF": "7fe0fb65-ef02-4964-b1a6-213c35113e73",
"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": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 21"
}
],
"KOTMenu": [
{
"IsCancelOrder": true,
"OrderDetailIDP": "753b3a95-4154-4e05-8b63-738a8dbe18db",
"MenuItemIDF": "f1e0f3d4-c6e3-4f3d-a89c-ba48d61ef09b",
"VariantIDF": "8fd95ae3-46d6-49c9-8331-0597658768eb",
"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": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 22"
},
{
"IsCancelOrder": true,
"OrderDetailIDP": "753b3a95-4154-4e05-8b63-738a8dbe18db",
"MenuItemIDF": "f1e0f3d4-c6e3-4f3d-a89c-ba48d61ef09b",
"VariantIDF": "8fd95ae3-46d6-49c9-8331-0597658768eb",
"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": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
},
{
"ModifierIDP": "51090c28-9dfd-4324-9207-186f5d37442e",
"ModifierName": "sample string 2",
"Price": 3.0
}
],
"ItemAdditionalNotes": "sample string 22"
}
],
"OrderTax": [
{
"OrderTaxIDP": "4a1beec9-e34d-4fc9-a34b-548e04497359",
"TaxIDF": "ca0e18f7-6b3b-4472-939e-47fc7d3a9f53",
"TaxName": "sample string 3",
"TaxPercentage": 4.0,
"TaxAmount": 5.0
},
{
"OrderTaxIDP": "4a1beec9-e34d-4fc9-a34b-548e04497359",
"TaxIDF": "ca0e18f7-6b3b-4472-939e-47fc7d3a9f53",
"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": "a9a04dbb-eaba-4e24-8144-c6f443755571",
"PaymentGatewaySettingID": "60c3c2aa-813c-4461-a9b3-942a22a94b3b",
"TableNo": "sample string 22",
"PackagingName": "sample string 23",
"SequentialOrderID": "sample string 24",
"PayAmountCash": 1.0,
"DueAmountCash": 1.0,
"ReturnAmountCash": 1.0,
"RefundDetails": [
{
"RefundIDP": "63e60d17-27f2-4516-b1a8-264bc439c8f5",
"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": "63e60d17-27f2-4516-b1a8-264bc439c8f5",
"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. |