API Referansı v1.0.0
AloYemek Entegrasyon API'nin tüm uç noktaları. Akışı anlamak için önce Nasıl çalışır? sayfasını okuyun.
Temel adres
https://www.aloyemek.com/aloapi/v1Kimlik doğrulama
Authorization: Bearer <token>OpenAPIopenapi.json indir
Kimlik doğrulama
Uygulama ve restoran anahtarıyla token alın; tüm isteklerde Authorization: Bearer <token> başlığını gönderin.
#Giriş yap (token al)
POST
/auth/loginToken gerekmez
Onaylı firmanın appSecretKey değeri ile restoranın panelinden oluşturduğu restaurantSecretKey değerini gönderin. Dönen token 24 saat geçerlidir; süre dolunca veya 401 aldığınızda tekrar giriş yapın. Her restoran için ayrı token alınır.
İstek gövdesi (JSON)
appSecretKeystringzorunluFirmanıza onayda verilen uygulama anahtarı (
ayk_app_…).restaurantSecretKeystringzorunluRestoranın AloYemek panelinde “API entegrasyonları” sayfasından oluşturduğu anahtar (
ayk_rst_…).Olası hatalar
422
VALIDATION_ERROR401INVALID_CREDENTIALS403INTEGRATOR_SUSPENDED403CONNECTION_REVOKED429RATE_LIMITEDcurl -X POST "https://www.aloyemek.com/aloapi/v1/auth/login" \
-H "Content-Type: application/json" \
-d '{"appSecretKey":"ayk_app_2f6c…","restaurantSecretKey":"ayk_rst_6fa7…"}'{
"appSecretKey": "ayk_app_2f6c…",
"restaurantSecretKey": "ayk_rst_6fa7…"
}{
"success": true,
"data": {
"token": "9f1c2b7e…",
"tokenType": "Bearer",
"expiresAt": "2026-09-18T17:19:13+03:00",
"expiresIn": 86400,
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"scopes": [
"restaurant",
"menu",
"orders",
"reports"
]
}
}#Bağlantı bilgisi
GET
/meToken'ın hangi restorana ait olduğunu ve bağlantının güncel izinlerini döner. Restoran izinleri istediği an değiştirebildiği için uygulamanız açılırken çağırmanız önerilir.
Olası hatalar
401
UNAUTHORIZED401TOKEN_EXPIREDcurl "https://www.aloyemek.com/aloapi/v1/me" \ -H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"integrator": "Örnek POS Yazılım A.Ş.",
"scopes": [
"restaurant",
"menu",
"orders",
"reports"
]
}
}Restoran
Restoran bilgileri, çalışma saatleri ve sipariş alımını açma / durdurma. İzin: restaurant.
#Restoran bilgisi
GET
/restaurantİzin:
restaurantRestoranın adı, adresi, konumu, logosu ve anlık sipariş durumu.
ordering.open false ise restoran şu an sipariş almıyordur: paused restoranın kendisinin durdurduğunu, closedByAdmin AloYemek tarafından kapatıldığını gösterir.Olası hatalar
403
FORBIDDEN_SCOPEcurl "https://www.aloyemek.com/aloapi/v1/restaurant" \ -H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"id": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"name": "Çiğ Köftecim 70",
"slug": "cig-koftecim-70-merkez-alisahane-mah",
"url": "https://www.aloyemek.com/cig-koftecim-70-merkez-alisahane-mah",
"phone": "+903380000000",
"address": {
"full": "Alişahane, Karaman/Karaman, Türkiye",
"city": "Merkez",
"state": "Karaman",
"postalCode": "70100",
"latitude": 37.18532689999999973906597006134688854217529296875,
"longitude": 33.21080450000000183763404493220150470733642578125
},
"logo": "https://www.aloyemek.com/upload/40066/0594d6df-38ed-4744-badb-46bcbdb2c3de.jpg",
"status": "active",
"services": [
"delivery",
"pickup"
],
"ordering": {
"open": true,
"paused": false,
"pausedUntil": null,
"pauseReason": "",
"closedByAdmin": false
}
}
}#Çalışma saatleri
GET
/restaurant/working-hoursİzin:
restaurantHaftalık çalışma saatleri. Aynı gün için birden fazla satır olabilir (ör. gece yarısını geçen vardiya).
dayOfWeek: 1 = Pazartesi … 7 = Pazar. Saatler restoranın yerel saatidir (Europe/Istanbul).Olası hatalar
403
FORBIDDEN_SCOPEcurl "https://www.aloyemek.com/aloapi/v1/restaurant/working-hours" \ -H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": [
{
"day": "monday",
"dayOfWeek": 1,
"open": true,
"start": "11:00",
"end": "23:59",
"start2": null,
"end2": null,
"note": "",
"serviceType": null
},
{
"day": "tuesday",
"dayOfWeek": 2,
"open": true,
"start": "11:00",
"end": "23:59",
"start2": null,
"end2": null,
"note": "",
"serviceType": null
}
]
}#Sipariş alımını durdur
POST
/restaurant/closeİzin:
restaurantRestoranı belirtilen süre boyunca yeni siparişlere kapatır (AloYemek panelindeki “Siparişleri durdur” ile aynıdır). Süre dolunca restoran otomatik olarak yeniden sipariş almaya başlar.
İstek gövdesi (JSON)
minutesintegerzorunluDurdurma süresi, dakika (5 – 1440).
reasonstringisteğe bağlıDurdurma nedeni (en fazla 190 karakter), ör. “Yoğunluk”.
Olası hatalar
422
VALIDATION_ERROR403FORBIDDEN_SCOPEcurl -X POST "https://www.aloyemek.com/aloapi/v1/restaurant/close" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"minutes":30,"reason":"Yoğunluk"}'{
"minutes": 30,
"reason": "Yoğunluk"
}{
"success": true,
"data": {
"id": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"name": "Çiğ Köftecim 70",
"slug": "cig-koftecim-70-merkez-alisahane-mah",
"url": "https://www.aloyemek.com/cig-koftecim-70-merkez-alisahane-mah",
"phone": "+903380000000",
"address": {
"full": "Alişahane, Karaman/Karaman, Türkiye",
"city": "Merkez",
"state": "Karaman",
"postalCode": "70100",
"latitude": 37.18532689999999973906597006134688854217529296875,
"longitude": 33.21080450000000183763404493220150470733642578125
},
"logo": "https://www.aloyemek.com/upload/40066/0594d6df-38ed-4744-badb-46bcbdb2c3de.jpg",
"status": "active",
"services": [
"delivery",
"pickup"
],
"ordering": {
"open": false,
"paused": true,
"pausedUntil": "2026-09-17T17:49:28+03:00",
"pauseReason": "Yoğunluk",
"closedByAdmin": false
}
}
}#Sipariş alımını aç
POST
/restaurant/openİzin:
restaurantDurdurulmuş sipariş alımını hemen yeniden açar. AloYemek tarafından kapatılmış (
closedByAdmin) bir restoranı açmaz.Olası hatalar
403
FORBIDDEN_SCOPEcurl -X POST "https://www.aloyemek.com/aloapi/v1/restaurant/open" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'{}{
"success": true,
"data": {
"id": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"name": "Çiğ Köftecim 70",
"slug": "cig-koftecim-70-merkez-alisahane-mah",
"url": "https://www.aloyemek.com/cig-koftecim-70-merkez-alisahane-mah",
"phone": "+903380000000",
"address": {
"full": "Alişahane, Karaman/Karaman, Türkiye",
"city": "Merkez",
"state": "Karaman",
"postalCode": "70100",
"latitude": 37.18532689999999973906597006134688854217529296875,
"longitude": 33.21080450000000183763404493220150470733642578125
},
"logo": "https://www.aloyemek.com/upload/40066/0594d6df-38ed-4744-badb-46bcbdb2c3de.jpg",
"status": "active",
"services": [
"delivery",
"pickup"
],
"ordering": {
"open": true,
"paused": false,
"pausedUntil": null,
"pauseReason": "",
"closedByAdmin": false
}
}
}Siparişler
Aktif siparişleri alın ve sipariş durumunu yönetin. İzin: orders. Her sipariş nesnesindeki availableActions, o an çağırabileceğiniz işlemleri listeler.
#Aktif siparişler
GET
/orders/activeİzin:
ordersYeni, hazırlanan ve hazır durumdaki siparişler (en yeni önce, en fazla 200). Webhook kullanmıyorsanız bu ucu 15–30 saniyede bir çağırın; webhook kullanıyorsanız yalnız uygulama açılışında ve bağlantı koptuktan sonra eşitleme için çağırmanız yeterlidir.
Olası hatalar
403
FORBIDDEN_SCOPEcurl "https://www.aloyemek.com/aloapi/v1/orders/active" \ -H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": [
{
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "new",
"statusGroup": "new",
"availableActions": [
"accept",
"reject",
"ready"
],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:18:19+03:00",
"acceptedAt": null,
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
]
}#Sipariş detayı
GET
/orders/{orderId}İzin:
ordersSiparişin tüm ayrıntıları: müşteri, teslimat adresi, ürünler ve seçenekleri, notlar, ödeme ve tutarlar.
statusGroup değerleri: new, preparing, ready, completed, cancelled, other.Yol parametreleri
orderIdstring (uuid)zorunluSiparişin
id değeri.Olası hatalar
404
NOT_FOUND403FORBIDDEN_SCOPEcurl "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc" \ -H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "new",
"statusGroup": "new",
"availableActions": [
"accept",
"reject",
"ready"
],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:18:19+03:00",
"acceptedAt": null,
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Siparişi kabul et
POST
/orders/{orderId}/acceptİzin:
ordersYeni siparişi kabul eder; müşteri bildirim alır ve sipariş “hazırlanıyor” olur. Yanıt, işlemden sonraki güncel sipariş nesnesidir (bkz. Sipariş detayı).
Yol parametreleri
orderIdstring (uuid)zorunluSipariş
id.Olası hatalar
409
INVALID_STATUS_TRANSITION409SAME_STATUS404NOT_FOUNDcurl -X POST "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc/accept" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'{}{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "accepted",
"statusGroup": "preparing",
"availableActions": [
"reject",
"ready",
"on-the-way",
"delivered"
],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:19:37+03:00",
"acceptedAt": "2026-09-17T17:20:36+03:00",
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Siparişi reddet / iptal et
POST
/orders/{orderId}/rejectİzin:
ordersSiparişi neden belirterek reddeder. Yeni, hazırlanan veya hazır siparişlerde kullanılabilir. Online ödenmiş siparişlerde iade süreci AloYemek tarafından yürütülür. Hazır nedenler için Red nedenleri ucunu kullanın. Yanıt, işlemden sonraki güncel sipariş nesnesidir (bkz. Sipariş detayı).
Yol parametreleri
orderIdstring (uuid)zorunluSipariş
id.İstek gövdesi (JSON)
reasonstringzorunluRed nedeni (en fazla 255 karakter); müşteriye gösterilir.
Olası hatalar
422
VALIDATION_ERROR409INVALID_STATUS_TRANSITION404NOT_FOUNDcurl -X POST "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc/reject" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"Kitchen closed"}'{
"reason": "Kitchen closed"
}{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "rejected",
"statusGroup": "cancelled",
"availableActions": [],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:18:19+03:00",
"acceptedAt": null,
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": "Kitchen closed",
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Sipariş hazır
POST
/orders/{orderId}/readyİzin:
ordersSiparişi “hazır” yapar (kurye veya müşteri teslim almaya gelebilir). Yanıt, işlemden sonraki güncel sipariş nesnesidir (bkz. Sipariş detayı).
Yol parametreleri
orderIdstring (uuid)zorunluSipariş
id.Olası hatalar
409
INVALID_STATUS_TRANSITION404NOT_FOUNDcurl -X POST "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc/ready" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'{}{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "ready for pickup",
"statusGroup": "ready",
"availableActions": [
"reject",
"on-the-way",
"delivered",
"delivery-failed"
],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:19:37+03:00",
"acceptedAt": "2026-09-17T17:20:36+03:00",
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Sipariş yolda
POST
/orders/{orderId}/on-the-wayİzin:
ordersYalnız paket servis (
type: delivery) siparişlerinde; restoranın kendi kuryesi yola çıktığında çağrılır. Yanıt, işlemden sonraki güncel sipariş nesnesidir (bkz. Sipariş detayı).Yol parametreleri
orderIdstring (uuid)zorunluSipariş
id.Olası hatalar
409
INVALID_STATUS_TRANSITION404NOT_FOUNDcurl -X POST "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc/on-the-way" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'{}{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "delivery on its way",
"statusGroup": "ready",
"availableActions": [
"reject",
"delivered",
"delivery-failed"
],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:19:37+03:00",
"acceptedAt": "2026-09-17T17:20:36+03:00",
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Sipariş teslim edildi
POST
/orders/{orderId}/deliveredİzin:
ordersPaket servis siparişini teslim edildi olarak kapatır. Yanıt, işlemden sonraki güncel sipariş nesnesidir (bkz. Sipariş detayı).
Yol parametreleri
orderIdstring (uuid)zorunluSipariş
id.Olası hatalar
409
INVALID_STATUS_TRANSITION404NOT_FOUNDcurl -X POST "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc/delivered" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'{}{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "delivered",
"statusGroup": "completed",
"availableActions": [],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:19:37+03:00",
"acceptedAt": "2026-09-17T17:20:36+03:00",
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Sipariş tamamlandı (gel-al / masada)
POST
/orders/{orderId}/completeİzin:
ordersGel-al (
pickup) ve masada (dinein) siparişleri tamamlar. Yanıt, işlemden sonraki güncel sipariş nesnesidir (bkz. Sipariş detayı).Yol parametreleri
orderIdstring (uuid)zorunluSipariş
id.Olası hatalar
409
INVALID_STATUS_TRANSITION404NOT_FOUNDcurl -X POST "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc/complete" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'{}{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "complete",
"statusGroup": "completed",
"availableActions": [],
"type": "pickup",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:19:37+03:00",
"acceptedAt": "2026-09-17T17:20:36+03:00",
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": null,
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Teslimat başarısız
POST
/orders/{orderId}/delivery-failedİzin:
ordersHazır veya yoldaki paket servis siparişi müşteriye ulaştırılamadığında çağrılır. Yanıt, işlemden sonraki güncel sipariş nesnesidir (bkz. Sipariş detayı).
Yol parametreleri
orderIdstring (uuid)zorunluSipariş
id.Olası hatalar
409
INVALID_STATUS_TRANSITION404NOT_FOUNDcurl -X POST "https://www.aloyemek.com/aloapi/v1/orders/ad136e9a-9e62-43a5-a739-246ad09ab3dc/delivery-failed" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{}'{}{
"success": true,
"data": {
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "delivery failed",
"statusGroup": "cancelled",
"availableActions": [],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:19:37+03:00",
"acceptedAt": "2026-09-17T17:20:36+03:00",
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105,
"customer": {
"name": "Ayşe Yılmaz",
"phone": "+905551112233"
},
"address": {
"formatted": "Yurt Mah. 71412 Sk. No:5 D:3, Çukurova/Adana",
"address1": "No:5 D:3",
"address2": "",
"label": "Ev",
"locationName": "",
"postalCode": "",
"latitude": 37.05120000000000146656020660884678363800048828125,
"longitude": 35.28609999999999757847035652957856655120849609375,
"instructions": "Zili çalmayın",
"deliveryOption": ""
},
"table": null,
"includeUtensils": true,
"cashChangeFor": 200,
"rejectionReason": null,
"items": [
{
"row": "a1c9916bbe59ba79",
"productId": 57,
"name": "Çiğ Köfte Dürüm",
"sku": "CK-DRM",
"category": "Dürümler",
"sizeId": 57,
"sizeName": "Büyük",
"quantity": 1,
"unitPrice": 100,
"discount": 0,
"discountType": "",
"total": 100,
"free": false,
"note": "Az acılı",
"ifSoldOut": "",
"options": [
{
"groupId": 1,
"groupName": "Ekstralar",
"id": 1,
"name": "Acı sos",
"quantity": 1,
"price": 5,
"total": 5
}
],
"attributes": []
}
],
"totals": {
"subtotal": 105,
"discount": 0,
"promoCode": "",
"promoTotal": 0,
"offerTotal": 0,
"deliveryFee": 0,
"serviceFee": 0,
"smallOrderFee": 0,
"packagingFee": 0,
"tip": 0,
"tax": 0,
"pointsUsed": 0,
"walletUsed": 0,
"total": 105,
"amountDue": 105
}
}
}#Red nedenleri
GET
/orders/reject-reasonsİzin:
ordersAloYemek'te tanımlı hazır red nedenleri. Kullanıcıya liste olarak gösterip seçileni
reason alanında gönderebilirsiniz.Olası hatalar
403
FORBIDDEN_SCOPEcurl "https://www.aloyemek.com/aloapi/v1/orders/reject-reasons" \ -H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": [
"Ürün kalmadı",
"Mutfak kapalı",
"Restoran çok yoğun",
"Müşteri iptal etmek için aradı",
"Diğer"
]
}Raporlar
Geçmiş siparişler ve toplamlar. İzin: reports.
#Sipariş geçmişi
GET
/orders/historyİzin:
reportsTarih aralığındaki siparişlerin özet listesi (sayfa başına 50) ve toplamlar. Aralık en fazla 62 gündür; tarih verilmezse son 7 gün döner.
Sorgu parametreleri
fromstring (YYYY-MM-DD)isteğe bağlıBaşlangıç tarihi.
tostring (YYYY-MM-DD)isteğe bağlıBitiş tarihi (dahil).
pageintegeristeğe bağlıSayfa numarası, 1'den başlar.
Olası hatalar
422
VALIDATION_ERROR403FORBIDDEN_SCOPEcurl "https://www.aloyemek.com/aloapi/v1/orders/history?from=2026-09-01&to=2026-09-17" \ -H "Authorization: Bearer $TOKEN"
{
"success": true,
"data": {
"from": "2026-09-11",
"to": "2026-09-17",
"page": 1,
"perPage": 50,
"totalCount": 1,
"pageCount": 1,
"summary": {
"count": 1,
"completedCount": 1,
"cancelledCount": 0,
"completedTotal": 105
},
"orders": [
{
"id": "ad136e9a-9e62-43a5-a739-246ad09ab3dc",
"number": 10018,
"reference": "",
"restaurantId": "0b484214-4740-407b-b3ec-d3987e6f1bb4",
"status": "delivered",
"statusGroup": "completed",
"availableActions": [],
"type": "delivery",
"createdAt": "2026-09-17T17:18:19+03:00",
"updatedAt": "2026-09-17T17:19:53+03:00",
"acceptedAt": "2026-09-17T17:20:36+03:00",
"scheduled": false,
"deliveryDate": "2026-09-17",
"deliveryTime": null,
"deliveryTimeEnd": null,
"payment": {
"method": "cod",
"name": "Kapıda ödeme",
"status": "unpaid"
},
"currency": "TRY",
"total": 105
}
]
}
}Webhook olayları
İmza doğrulama ve tekrar deneme kuralları için Webhooklar rehberine bakın.
| Olay | Ne zaman? | data |
|---|---|---|
order.created | Restorana yeni sipariş geldi. | Sipariş nesnesi + event |
order.status_changed | Sipariş durumu değişti (kabul, hazır, yolda, teslim, tamamlandı). Değişiklik restoran panelinden, AloYemek'ten veya sizin API çağrınızdan gelebilir. | Sipariş nesnesi + event |
order.cancelled | Sipariş reddedildi, müşteri tarafından iptal edildi veya teslim edilemedi. | Sipariş nesnesi + event |
connection.created | Bir restoran firmanıza bağlandı. | restaurantName, scopes |
connection.key_rotated | Restoran anahtarını yeniledi; eski anahtar ve token'lar geçersiz. | restaurantName, scopes |
connection.revoked | Restoran bağlantıyı kaldırdı. | restaurantName, scopes |
ping | AloYemek panelinden gönderilen test bildirimi. | message |
Hata kodları
| HTTP | error.code | Açıklama |
|---|---|---|
| 422 | VALIDATION_ERROR | Eksik veya hatalı parametre. message alanı hangi alanın hatalı olduğunu söyler. |
| 401 | INVALID_CREDENTIALS | appSecretKey veya restaurantSecretKey hatalı. |
| 401 | UNAUTHORIZED | Token gönderilmedi ya da geçersiz. Tekrar giriş yapın. |
| 401 | TOKEN_EXPIRED | Token süresi doldu (24 saat). Tekrar giriş yapın. |
| 403 | INTEGRATOR_SUSPENDED | Firma hesabı askıya alındı veya onaylı değil. AloYemek ile iletişime geçin. |
| 403 | CONNECTION_REVOKED | Restoran bu firmayla bağlantısını kaldırdı. Restorandan yeni anahtar isteyin. |
| 403 | FORBIDDEN_SCOPE | Bağlantının bu işlem için izni yok. Restoran izinlerini panelden değiştirebilir. |
| 404 | NOT_FOUND | Uç nokta, sipariş, ürün veya seçenek bulunamadı (ya da bu restorana ait değil). |
| 405 | METHOD_NOT_ALLOWED | Yanlış HTTP yöntemi. Allow başlığına bakın. |
| 409 | SAME_STATUS | Sipariş zaten bu durumda. |
| 409 | INVALID_STATUS_TRANSITION | Bu işlem siparişin mevcut durumunda veya sipariş türünde yapılamaz. availableActions alanına bakın. |
| 429 | RATE_LIMITED | Dakikalık istek sınırı aşıldı. Retry-After saniye kadar bekleyin. |
| 500 | SERVER_ERROR | Beklenmeyen hata. İsteği bir süre sonra tekrarlayın; sürerse bize bildirin. |
| 503 | MODULE_DISABLED | API geçici olarak kullanılamıyor. |