Sipariş detayları

Sipariş detayları

GET /api/External/v2/Order/{orderId}

Belirli bir sipariş ID'sine göre sipariş detaylarını getirir.

Örnek istek

Sipariş detayı getirme
curl -X GET "https://ext.adisyo.com/api/External/v2/Order/643287" \
  --header "x-api-key: ..." \
  --header "x-api-secret: ..." \
  --header "x-api-consumer: ..." \

İstek Parametreleri

ParametreData TipiAçıklama
orderIdLong (Path Parameter)Siparişin Adisyo sistemindeki ID'si

Örnek cevap

Masa Siparişi Örneği
{
    "id": 123456789,
    "waiterName": "ÖRNEK RESTORAN",
    "deliveryUserName": null,
    "courierId": 0,
    "externalAppName": null,
    "restaurantName": "ÖRNEK ŞUBE",
    "orderTotal": 485.00,
    "paymentMethodName": null,
    "paymentMethodId": 0,
    "deliveryTime": null,
    "discountAmount": 0.00,
    "currency": "TRY",
    "orderNote": null,
    "externalAppId": null,
    "salesChannelId": 12345,
    "salesChannelName": "Ana Kanal",
    "orderType": "Masa Siparişi",
    "orderTypeId": 1,
    "statusId": 1,
    "status": "Sipariş Alındı",
    "orderCancelReason": null,
    "tableName": null,
    "orderNumber": 101,
    "taxAmount": 44.09,
    "insertDate": "2025-01-15T16:10:39.973",
    "updateDate": "2025-01-15T16:22:23.02",
    "customerId": 987654321,
    "customerLatitude": null,
    "customerLongitude": null,
    "confirmationCode": null,
    "integrationRestaurantName": null,
    "addressId": 123456789,
    "isScheduledOrder": false,
    "scheduledTime": null,
    "deliveryType": 2,
    "restaurantKey": 12345,
    "externalAppKey": 0,
    "closedDate": null,
    "preparedDate": null,
    "customer": {
        "customerName": "Ahmet",
        "customerSurname": "Yılmaz",
        "customerEmail": "",
        "customerId": 987654321,
        "customerPhone": "5551234567",
        "customerPhone2": "",
        "address": "Örnek Mahallesi, Örnek Sokak No:123, 34000 İstanbul",
        "addressDescription": "Örnek Bina K:5",
        "region": "Kadıköy",
        "addressHeader": "Ev",
        "city": "İstanbul",
        "company": null,
        "phoneCode": null,
        "addressId": 0,
        "isDefault": null
    },
    "products": [
        {
            "id": 1111111111,
            "orderId": 123456789,
            "productUnitId": 2222222,
            "quantity": 1.000,
            "unitPrice": 270.00,
            "productName": "2 Orta Boy Pizza",
            "categoryName": "Salon Kampanya",
            "productNote": null,
            "productCode": "SALON04",
            "isMenu": true,
            "parentId": null,
            "cost": 0.0,
            "totalAmount": 325.00,
            "groupName": null,
            "groupId": 0,
            "discountAmount": 0.00,
            "insertDate": "2025-01-15T16:10:40.163",
            "description": null,
            "cancelReason": null,
            "excludedComposites": null,
            "excludedItems": [],
            "features": []
        },
        {
            "id": 1111111112,
            "orderId": 123456789,
            "productUnitId": 3333333,
            "quantity": 1.000,
            "unitPrice": 0.00,
            "productName": "Salamlı Zeytinli (Orta Boy)",
            "categoryName": "Ekonomik Pizzalar",
            "productNote": null,
            "productCode": "ADP02",
            "isMenu": false,
            "parentId": 1111111111,
            "cost": 0.0,
            "totalAmount": 0.00,
            "groupName": null,
            "groupId": 0,
            "discountAmount": 0.00,
            "insertDate": "2025-01-15T16:10:40.173",
            "description": null,
            "cancelReason": null,
            "excludedComposites": null,
            "excludedItems": [
                {
                    "compositeId": 123456,
                    "compositeName": "SIYAH ZEYTIN"
                }
            ],
            "features": [
                {
                    "featureName": "FUME KABURGA",
                    "additionalPrice": 40.00,
                    "featureId": 111111,
                    "orderDetailId": 1111111112
                },
                {
                    "featureName": "TAVUK",
                    "additionalPrice": 15.00,
                    "featureId": 222222,
                    "orderDetailId": 1111111112
                },
                {
                    "featureName": "INCE HAMUR",
                    "additionalPrice": 0.00,
                    "featureId": 333333,
                    "orderDetailId": 1111111112
                }
            ]
        },
        {
            "id": 1111111113,
            "orderId": 123456789,
            "productUnitId": 4444444,
            "quantity": 1.000,
            "unitPrice": 0.00,
            "productName": "Margarita (Orta Boy)",
            "categoryName": "Ekonomik Pizzalar",
            "productNote": "",
            "productCode": "MARG02",
            "isMenu": false,
            "parentId": 1111111111,
            "cost": 0.0,
            "totalAmount": 0.00,
            "groupName": null,
            "groupId": 0,
            "discountAmount": 0.00,
            "insertDate": "2025-01-15T16:10:40.337",
            "description": null,
            "cancelReason": null,
            "excludedComposites": null,
            "excludedItems": [],
            "features": [
                {
                    "featureName": "INCE HAMUR",
                    "additionalPrice": 0.00,
                    "featureId": 333333,
                    "orderDetailId": 1111111113
                }
            ]
        },
        {
            "id": 1111111114,
            "orderId": 123456789,
            "productUnitId": 5555555,
            "quantity": 1.000,
            "unitPrice": 45.00,
            "productName": "Limonata (30 cl.)",
            "categoryName": "İçecekler",
            "productNote": null,
            "productCode": "ICE19",
            "isMenu": false,
            "parentId": null,
            "cost": 7.00,
            "totalAmount": 45.00,
            "groupName": null,
            "groupId": 0,
            "discountAmount": 0.00,
            "insertDate": "2025-01-15T16:10:40.8",
            "description": null,
            "cancelReason": null,
            "excludedComposites": null,
            "excludedItems": [],
            "features": []
        },
        {
            "id": 1111111115,
            "orderId": 123456789,
            "productUnitId": 6666666,
            "quantity": 1.000,
            "unitPrice": 60.00,
            "productName": "Sufle",
            "categoryName": "Tatlılar",
            "productNote": "",
            "productCode": "SUF01",
            "isMenu": false,
            "parentId": null,
            "cost": 0.0,
            "totalAmount": 60.00,
            "groupName": null,
            "groupId": 0,
            "discountAmount": 0.00,
            "insertDate": "2025-01-15T16:10:40.83",
            "description": null,
            "cancelReason": null,
            "excludedComposites": null,
            "excludedItems": [],
            "features": []
        },
        {
            "id": 1111111116,
            "orderId": 123456789,
            "productUnitId": 7777777,
            "quantity": 1.000,
            "unitPrice": 55.00,
            "productName": "Sarımsaklı Ekmek",
            "categoryName": "Çıtır Lezzetler",
            "productNote": null,
            "productCode": "CIT08",
            "isMenu": false,
            "parentId": null,
            "cost": 0.0,
            "totalAmount": 55.00,
            "groupName": null,
            "groupId": 0,
            "discountAmount": 0.00,
            "insertDate": "2025-01-15T16:10:40.877",
            "description": null,
            "cancelReason": null,
            "excludedComposites": null,
            "excludedItems": [],
            "features": []
        }
    ],
    "payments": []
}

Cevap parametreleri

Ana Sipariş Bilgileri

Parametre AdıData TipiAçıklama
idNumberSiparişin Adisyo sistemindeki ID'si
waiterNameString?Garson adı
deliveryUserNameString?Teslimat personeli adı
courierIdNumberKurye ID'si
externalAppNameString?Dış uygulama adı
restaurantNameString?Restoran adı
orderTotalNumberSipariş toplam tutarı
paymentMethodNameString?Ödeme yöntemi adı
paymentMethodIdNumberÖdeme yöntemi ID'si
deliveryTimeDate? (ISO 8601)Teslimat zamanı
discountAmountNumberİndirim tutarı
currencyStringPara birimi
orderNoteString?Sipariş notu
externalAppIdString?Dış uygulamadaki sipariş ID'si
salesChannelIdNumberSatış kanalı ID'si
salesChannelNameStringSatış kanalı adı
orderTypeStringSipariş tipi (Masa Siparişi, Paket Siparişi, Gel-Al Satış)
orderTypeIdNumberSipariş tipi ID'si (1: Masa, 3: Paket, 5: Gel-Al)
statusIdNumberSipariş durum ID'si
statusString?Sipariş durumu
orderCancelReasonString?İptal nedeni (varsa)
tableNameString?Masa adı (masa siparişi ise)
orderNumberNumberSipariş numarası
taxAmountNumberVergi tutarı
insertDateDate (ISO 8601)Sipariş oluşturulma tarihi
updateDateDate (ISO 8601)Son güncelleme tarihi
customerIdNumberMüşteri ID'si (0 ise anonim müşteri)
customerLatitudeString?Müşteri enlem bilgisi
customerLongitudeString?Müşteri boylam bilgisi
confirmationCodeString?Onay kodu
integrationRestaurantNameString?Entegrasyon restoran adı
addressIdNumberAdres ID'si
isScheduledOrderBooleanZamanlanmış sipariş mi?
scheduledTimeString?Zamanlanmış teslimat zamanı
deliveryTypeNumberTeslimat tipi
restaurantKeyNumberRestoran anahtarı
externalAppKeyNumberDış uygulama anahtarı
closedDateDate? (ISO 8601)Sipariş kapatılma tarihi
preparedDateDate? (ISO 8601)Sipariş hazırlanma tarihi

Müşteri Bilgileri (customer)

Parametre AdıData TipiAçıklama
customerNameString?Müşteri adı (null ise anonim müşteri)
customerSurnameString?Müşteri soyadı
customerEmailString?Müşteri e-posta adresi
customerIdNumberMüşteri ID'si (0 ise anonim müşteri)
customerPhoneString?Birincil telefon numarası
customerPhone2String?İkincil telefon numarası
addressString?Adres
addressDescriptionString?Adres açıklaması
regionString?Semt/İlçe
addressHeaderString?Adres başlığı
cityString?Şehir
companyString?Şirket adı
phoneCodeString?Telefon kodu
addressIdNumberAdres ID'si
isDefaultBoolean?Varsayılan adres mi?

Ürün Bilgileri (products)

Parametre AdıData TipiAçıklama
idNumberÜrün satır ID'si
orderIdNumberSipariş ID'si
productUnitIdNumberÜrün birim ID'si
quantityNumberMiktar
unitPriceNumberBirim fiyat
productNameStringÜrün adı
categoryNameString?Kategori adı
productNoteString?Ürün notu
productCodeString?Ürün kodu
isMenuBooleanMenü ürünü mü?
parentIdString?Ana menü ID'si
costNumberMaliyet
totalAmountNumberToplam tutar
groupNameString?Grup adı
groupIdNumberGrup ID'si
discountAmountNumberİndirim tutarı
insertDateDate (ISO 8601)Eklenme tarihi
descriptionString?Ürün açıklaması
cancelReasonString?İptal nedeni
excludedCompositesString?Hariç tutulan bileşenler
excludedItemsArrayHariç tutulan öğeler (compositeId, compositeName)
featuresArrayÖzellikler (featureName, additionalPrice, featureId, orderDetailId)

Ödeme Bilgileri (payments)

Parametre AdıData TipiAçıklama
orderIdNumberSipariş ID'si
paymentTypeIdNumberÖdeme tipi ID'si
paymentNameStringÖdeme yöntemi adı
amountNumberÖdeme tutarı
customerIdNumber?Müşteri ID'si
customerNameString?Müşteri adı
customerSurnameString?Müşteri soyadı
isDebitBooleanBorçlu mu?
currencyIdNumberPara birimi ID'si
currencyStringPara birimi
exchangeRateNumberDöviz kuru
insertDateDate (ISO 8601)Ödeme tarihi

Kullanım örnekleri

JavaScript/Node.js

JavaScript örneği
const axios = require('axios');
 
async function getOrderById(orderId) {
  try {
    const response = await axios.get(
      `https://ext.adisyo.com/api/External/v2/Order/${orderId}`,
      {
        headers: {
          'x-api-key': 'your-api-key',
          'x-api-secret': 'your-api-secret',
          'x-api-consumer': 'your-consumer'
        }
      }
    );
    
    console.log('Sipariş detayları:', response.data);
    return response.data;
  } catch (error) {
    console.error('Hata:', error.response?.data || error.message);
    throw error;
  }
}
 
// Kullanım
getOrderById(123456789);

Notlar

  • Sadece yetkili kullanıcılar kendi restoranlarının siparişlerini görüntüleyebilir.
  • Sipariş ID'si geçerli bir sayı olmalıdır.
  • Cevapta siparişin tüm detayları, müşteri bilgileri, ürün listesi ve ödeme bilgileri yer alır.