Viewing Completed Orders
-
Completed orders of the relevant restaurant with
x-api-key
,x-api-secret
andx-api-consumer
information You can withdraw fromhttps://ext.adisyo.com/api/External/v2/CompletedOrders
. -
The request should be sent with the
GET
method.
Parameters
Request Header Parameters
Parameter | Description | Type |
---|---|---|
x-api-key | API key of your account | string |
x-api-secret | API Secret key of your account | string |
x-api-consumer | Integrator restaurant/company name | string |
Required Parameters
Parameter | Description | Type |
---|---|---|
page | Number of Pages | int |
startDate | Start Date | string |
includeCancelled | Condition for inclusion of canceled orders | boolean |
orderType | Type of Order | string |
Limitations
When creating the request, you should consider the following restrictions.
- In the parameters, the start date should be sent in the format
startDate
yyyy-MM-dd HH:mm:ss
. Returns orders within 24 hours if sent empty. Must be sent in UTC time zone. For example, for the 18:00 start date from Turkey, a request should be sent with the date 15:00. - In order to include canceled orders, you must send the
includeCancelled
parameter totrue
. - By default, the
orderType
parameter contains orders with all order types. When sending multipleorderType
parameters, you must separate them with commas. You can find order types here. - Up to 100 order objects can be displayed in each response. If the
TotalCount
parameter is more than 100 in the displayed object, by changing thePage
parameter, you can see the other orders on the next page.
Example Request
curl https://ext.adisyo.com/api/External/v2/CompletedOrders
Example Response
{
"orders":[
{
"id":190202584,
"waiterName":"Azad Gok",
"deliveryUserName":null,
"externalAppName":null,
"restaurantName":null,
"orderTotal":87.00,
"paymentMethodName":null,
"paymentMethodId":0,
"deliveryTime":null,
"discountAmount":0.00,
"currency":"TRY",
"orderNote":null,
"salesChannelId":62271,
"salesChannelName":"Ana Kanal",
"externalAppId":null,
"statusId":7,
"status":"Kapandı",
"integrationRestaurantName":null,
"orderCancelReason":null,
"tableName":"Masa 21",
"orderNumber":122,
"taxAmount":7.91,
"insertDate":"2023-08-18T14:10:52.11",
"updateDate":"2023-08-18T14:41:03.52",
"orderTypeId":1,
"orderType":"Masa Siparişi",
"customerId":0,
"integrationOrderId":null,
"restaurantKey":38910,
"externalAppKey":0,
"customer":null,
"products":[
{
"id":698440349,
"orderId":190202584,
"quantity":2.000,
"unitPrice":25.00,
"productName":"TÜRK KAHVESİ",
"productNote":null,
"productCode":null,
"productUnitId":7572239,
"isMenu":false,
"parentId":null,
"cost":0.0,
"totalAmount":50.00,
"groupName":null,
"groupId":0,
"unitId":4,
"productId":8153225,
"discountAmount":0.00,
"insertDate":"2023-08-18T11:10:52.177",
"description":null,
"cancelReason":null,
"features":[
{
"featureName":"ORTA",
"additionalPrice":0.00,
"featureId":1707861,
"orderDetailId":698440349
}
]
},
{
"id":440333700,
"orderId":190202584,
"quantity":1.000,
"unitPrice":12.00,
"productName":"MEYVELİ SODA",
"productNote":null,
"productCode":null,
"productUnitId":7586234,
"isMenu":false,
"parentId":null,
"cost":0.0,
"totalAmount":12.00,
"groupName":null,
"groupId":0,
"unitId":4,
"productId":1662251,
"discountAmount":0.00,
"insertDate":"2023-08-18T11:10:52.19",
"description":null,
"cancelReason":null,
"features":[
{
"featureName":"ELMA",
"additionalPrice":0.00,
"featureId":849913,
"orderDetailId":440333700
}
]
},
{
"id":440333699,
"orderId":190202584,
"quantity":1.000,
"unitPrice":25.00,
"productName":"CHURCHİLL",
"productNote":null,
"productCode":null,
"productUnitId":5912397,
"isMenu":false,
"parentId":null,
"cost":0.0,
"totalAmount":25.00,
"groupName":null,
"groupId":0,
"unitId":4,
"productId":8170225,
"discountAmount":0.00,
"insertDate":"2023-08-18T11:10:52.187",
"description":null,
"cancelReason":null,
"features":[
]
}
],
"payments":[
{
"orderId":190202584,
"paymentTypeId":1,
"paymentName":"Nakit",
"amount":87.00,
"customerId":null,
"customerName":null,
"customerSurname":null,
"isDebit":false,
"currencyId":1,
"currency":"TRY",
"exchangeRate":1.00,
"insertDate":"2023-08-18T11:41:03.417"
}
]
}
],
"closedOrdersReceived":99,
"canceledOrdersReceived":1,
"totalCount":2841,
"pageCount":29,
"status":100,
"message":"İşlem Başarılı!"
}