POST api/Order/OrderList
Request Information
URI Parameters
None.
Body Parameters
ApiRequestOfOrderRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| data | OrderRequest |
None. |
Request Formats
application/json, text/json
Sample:
{
"data": {
"authorizationCode": "sample string 1",
"firebaseDeviceToken": "sample string 2",
"languageCode": "sample string 3",
"orderID": 1,
"bookingDateTime": "sample string 4"
}
}
text/html
Sample:
{"data":{"authorizationCode":"sample string 1","firebaseDeviceToken":"sample string 2","languageCode":"sample string 3","orderID":1,"bookingDateTime":"sample string 4"}}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResponseOfOrderListResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| data | OrderListResponse |
None. |
|
| errors | Collection of ApiError |
None. |
Response Formats
application/json, text/json
Sample:
{
"data": {
"orderList": [
{
"orderID": 1,
"branchID": 2,
"merchantBranchName": "sample string 3",
"tableTypeName": "sample string 4",
"tablePax": 5,
"bookingDateTime": "sample string 6",
"createdDateTime": "sample string 7",
"orderStatus": "sample string 8",
"orderStatusCode": "sample string 9",
"remark": "sample string 10",
"showCountdown": true,
"isUpcoming": true,
"isPaid": true,
"currencyCode": "sample string 14",
"totalAmount": 15.0,
"refundAmount": 16.0,
"serviceChargePerc": 17.0,
"sstChargePerc": 18.0,
"promotionReductionAmount": 19.0,
"deliveryFeeAmount": 20.0,
"queueNumber": 1,
"currentQueueNumber": 21,
"canCancelBeforeMinutes": 22,
"canChangeOrderTimeBeforeHours": 23,
"isAdvanceOrder": true,
"orderTypeCode": "sample string 25",
"canComplainDelivery": true,
"deliveryComplainIsSolved": true,
"deliveryComplainRemark": "sample string 28",
"canRate": true,
"address": "sample string 30",
"cancelReason": "sample string 31",
"restaurantRating": 1.0,
"riderRating": 1.0,
"aroundBeforeMinutes": 32,
"absentAfterMinutes": 33,
"advancedBookingMinDay": 34,
"advancedBookingMaxDay": 35,
"orderTakingDayOfWeek": [
1,
2
],
"checkoutDishList": [
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"prepareMinutes": 6,
"preorderDays": 7,
"isSoldOut": true,
"specialRequest": "sample string 9",
"checkoutAdditionalList": [
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
},
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
}
]
},
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"prepareMinutes": 6,
"preorderDays": 7,
"isSoldOut": true,
"specialRequest": "sample string 9",
"checkoutAdditionalList": [
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
},
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
}
]
}
],
"cancellationTierList": [
{
"hoursBefore": 1,
"cancellationFeePerc": 2.0
},
{
"hoursBefore": 1,
"cancellationFeePerc": 2.0
}
]
},
{
"orderID": 1,
"branchID": 2,
"merchantBranchName": "sample string 3",
"tableTypeName": "sample string 4",
"tablePax": 5,
"bookingDateTime": "sample string 6",
"createdDateTime": "sample string 7",
"orderStatus": "sample string 8",
"orderStatusCode": "sample string 9",
"remark": "sample string 10",
"showCountdown": true,
"isUpcoming": true,
"isPaid": true,
"currencyCode": "sample string 14",
"totalAmount": 15.0,
"refundAmount": 16.0,
"serviceChargePerc": 17.0,
"sstChargePerc": 18.0,
"promotionReductionAmount": 19.0,
"deliveryFeeAmount": 20.0,
"queueNumber": 1,
"currentQueueNumber": 21,
"canCancelBeforeMinutes": 22,
"canChangeOrderTimeBeforeHours": 23,
"isAdvanceOrder": true,
"orderTypeCode": "sample string 25",
"canComplainDelivery": true,
"deliveryComplainIsSolved": true,
"deliveryComplainRemark": "sample string 28",
"canRate": true,
"address": "sample string 30",
"cancelReason": "sample string 31",
"restaurantRating": 1.0,
"riderRating": 1.0,
"aroundBeforeMinutes": 32,
"absentAfterMinutes": 33,
"advancedBookingMinDay": 34,
"advancedBookingMaxDay": 35,
"orderTakingDayOfWeek": [
1,
2
],
"checkoutDishList": [
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"prepareMinutes": 6,
"preorderDays": 7,
"isSoldOut": true,
"specialRequest": "sample string 9",
"checkoutAdditionalList": [
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
},
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
}
]
},
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"prepareMinutes": 6,
"preorderDays": 7,
"isSoldOut": true,
"specialRequest": "sample string 9",
"checkoutAdditionalList": [
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
},
{
"id": 1,
"code": "sample string 2",
"name": "sample string 3",
"price": 4.0,
"unit": 5,
"isSoldOut": true
}
]
}
],
"cancellationTierList": [
{
"hoursBefore": 1,
"cancellationFeePerc": 2.0
},
{
"hoursBefore": 1,
"cancellationFeePerc": 2.0
}
]
}
]
},
"errors": [
{
"additional_fields": {},
"code": "sample string 2",
"detail": "sample string 3"
},
{
"additional_fields": {},
"code": "sample string 2",
"detail": "sample string 3"
}
]
}
text/html
Sample:
{"data":{"orderList":[{"orderID":1,"branchID":2,"merchantBranchName":"sample string 3","tableTypeName":"sample string 4","tablePax":5,"bookingDateTime":"sample string 6","createdDateTime":"sample string 7","orderStatus":"sample string 8","orderStatusCode":"sample string 9","remark":"sample string 10","showCountdown":true,"isUpcoming":true,"isPaid":true,"currencyCode":"sample string 14","totalAmount":15.0,"refundAmount":16.0,"serviceChargePerc":17.0,"sstChargePerc":18.0,"promotionReductionAmount":19.0,"deliveryFeeAmount":20.0,"queueNumber":1,"currentQueueNumber":21,"canCancelBeforeMinutes":22,"canChangeOrderTimeBeforeHours":23,"isAdvanceOrder":true,"orderTypeCode":"sample string 25","canComplainDelivery":true,"deliveryComplainIsSolved":true,"deliveryComplainRemark":"sample string 28","canRate":true,"address":"sample string 30","cancelReason":"sample string 31","restaurantRating":1.0,"riderRating":1.0,"aroundBeforeMinutes":32,"absentAfterMinutes":33,"advancedBookingMinDay":34,"advancedBookingMaxDay":35,"orderTakingDayOfWeek":[1,2],"checkoutDishList":[{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"prepareMinutes":6,"preorderDays":7,"isSoldOut":true,"specialRequest":"sample string 9","checkoutAdditionalList":[{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true},{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true}]},{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"prepareMinutes":6,"preorderDays":7,"isSoldOut":true,"specialRequest":"sample string 9","checkoutAdditionalList":[{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true},{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true}]}],"cancellationTierList":[{"hoursBefore":1,"cancellationFeePerc":2.0},{"hoursBefore":1,"cancellationFeePerc":2.0}]},{"orderID":1,"branchID":2,"merchantBranchName":"sample string 3","tableTypeName":"sample string 4","tablePax":5,"bookingDateTime":"sample string 6","createdDateTime":"sample string 7","orderStatus":"sample string 8","orderStatusCode":"sample string 9","remark":"sample string 10","showCountdown":true,"isUpcoming":true,"isPaid":true,"currencyCode":"sample string 14","totalAmount":15.0,"refundAmount":16.0,"serviceChargePerc":17.0,"sstChargePerc":18.0,"promotionReductionAmount":19.0,"deliveryFeeAmount":20.0,"queueNumber":1,"currentQueueNumber":21,"canCancelBeforeMinutes":22,"canChangeOrderTimeBeforeHours":23,"isAdvanceOrder":true,"orderTypeCode":"sample string 25","canComplainDelivery":true,"deliveryComplainIsSolved":true,"deliveryComplainRemark":"sample string 28","canRate":true,"address":"sample string 30","cancelReason":"sample string 31","restaurantRating":1.0,"riderRating":1.0,"aroundBeforeMinutes":32,"absentAfterMinutes":33,"advancedBookingMinDay":34,"advancedBookingMaxDay":35,"orderTakingDayOfWeek":[1,2],"checkoutDishList":[{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"prepareMinutes":6,"preorderDays":7,"isSoldOut":true,"specialRequest":"sample string 9","checkoutAdditionalList":[{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true},{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true}]},{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"prepareMinutes":6,"preorderDays":7,"isSoldOut":true,"specialRequest":"sample string 9","checkoutAdditionalList":[{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true},{"id":1,"code":"sample string 2","name":"sample string 3","price":4.0,"unit":5,"isSoldOut":true}]}],"cancellationTierList":[{"hoursBefore":1,"cancellationFeePerc":2.0},{"hoursBefore":1,"cancellationFeePerc":2.0}]}]},"errors":[{"additional_fields":{},"code":"sample string 2","detail":"sample string 3"},{"additional_fields":{},"code":"sample string 2","detail":"sample string 3"}]}