Tamamlanmış Siparişleri Görüntüleme
-
İlgili restorantın tamamlanmış siparişlerini
x-api-key
,x-api-secret
vex-api-consumer
bilgileri ilehttps://ext.adisyo.com/api/External/v2/CompletedOrders
adresinden çekebilirsiniz. -
GET
metodu ile istek gönderilmelidir.
Parametreler
Request Header Parametreleri
Parametre | Açıklama | Tür |
---|---|---|
x-api-key | Hesabınızın API keyi | string |
x-api-secret | Hesabınızın API Secret keyi | string |
x-api-consumer | Entegratör restoran/firma adı | string |
Gerekli Parametreler
Parametre | Açıklama | Tür |
---|---|---|
page | Sayfa Sayısı | int |
startDate | Başlangıç Tarihi | string |
includeCancelled | İptal siparişlerin dahil edilme koşulu | boolean |
orderType | Siparişin Tipi | string |
Kısıtlamalar
Requesti oluştururken aşağıdaki kısıtlamaları dikkate almanız gerekir.
- Parametrelerde başlangıç tarihi
startDate
yyyy-MM-dd HH:mm:ss
formatıyla gönderilmelidir. Boş gönderilirse 24 saat içerisindeki siparişleri döndürür. UTC zaman dilimiyle gönderilmelidir. Örneğin Türkiye'den saat 18:00 başlangıç tarihi için 15:00 tarihi ile istek gönderilmeli. - İptal siparişlerin de dahil edilmesi için
includeCancelled
parametresinitrue
göndermeniz gereklidir. - Varsayılan olarak
orderType
parametresi tüm sipariş tiplerini içeren siparişlerini içerir. Birden fazlaorderType
parametresi gönderirken virgül ile ayırmalısınız. Sipariş tiplerine buradan ulaşabilirsiniz. - Her response'da en fazla 100 sipariş objesi görüntülenebilir. Görüntülenen objede
TotalCount
parametresi 100'den fazlaysaPage
parametresini değiştirerek bir sonraki sayfada diğer siparişleri görebilir.
Örnek Request
curl https://ext.adisyo.com/api/External/v2/CompletedOrders
Örnek 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ı!"
}