Tamamlanmış siparişler

Tamamlanmış siparişler

GET /CompletedOrders

Restoranın Adisyo'daki tamamlanmış siparişlerini listelemek için kullanılır.

Örnek istek

Tamamlanmış siparişler
curl -X GET "https://ext.adisyo.com/api/External/v2/CompletedOrders?page=1&startDate=2025-12-01%2014:00:00&includeCancelled=true&orderType=TakeAway,Table" \
  --header "x-api-key: ..." \
  --header "x-api-secret: ..." \
  --header "x-api-consumer: ..."

İstek Parametreleri

Aşağıdaki parametreleri query string olarak gönderebilirsiniz

ParametreData TipiAçıklamaÖrnek
pageNumber?Geçerli sayfa1
startDateDate? (ISO 8601 "yyyy-MM-dd HH:mm:ss")Başlangıç Tarihi2025-12-01 14:00:00
includeCancelledBoolean?İptal edilen siparişler dahil edilsin mi?true
orderTypeString? (Virgülle ayrılmış, çoklu)Sipariş TipleriTakeAway,Table

Kısıtlamalar

İstek oluşturulurken aşağıdaki kısıtlamalara dikkat etmek gerekir

  • Parametrelerde startDate değeri yyyy-MM-dd HH:mm:ss (ISO 8601) formatında gönderilmelidir. Boş gönderilirse, son 24 saat içerisindeki siparişler döndürülür. UTC zaman diliminde gönderilmelidir. Örneğin, Türkiye'de saat 18:00 için başlangıç tarihi 15:00 olarak gönderilmelidir.
  • İptal siparişlerin de dahil edilmesi için includeCancelled parametresini true göndermeniz gereklidir.
  • Varsayılan olarak orderType parametresi tüm sipariş tiplerini kapsar. Birden fazla orderType değeri gönderirken virgülle ayırmalısınız. Sipariş tiplerine buradan ulaşabilirsiniz.
  • Her cevapta en fazla 100 sipariş objesi görüntülenebilir. Görüntülenen yanıtta TotalCount parametresi 100'den fazlaysa Page parametresini değiştirerek bir sonraki sayfada diğer siparişleri görebilirsiniz.

Örnek cevap

Tamamlanmış siparişler
{
  "orders": [
    {
      "id": 190202584,
      "waiterName": "Azad Gök",
      "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,
          "excludedComposites": null,
          "excludedItems": [
            {
              "compositeId": 4521881,
              "compositeName": "ŞEKER"
            }
          ],
          "features": [
            {
              "featureName": "ORTA",
              "additionalPrice": 0.00,
              "featureId": 1707861,
              "orderDetailId": 698440349,
              "featureProductCode": null,
              "featureProductName": null
            }
          ]
        },
        {
          "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,
          "excludedComposites": null,
          "excludedItems": [
            {
              "compositeId": 4521882,
              "compositeName": "BUZ"
            }
          ],
          "features": [
            {
              "featureName": "ELMA",
              "additionalPrice": 0.00,
              "featureId": 849913,
              "orderDetailId": 440333700,
              "featureProductCode": "AR-ELMA",
              "featureProductName": "Elma Aroması"
            }
          ]
        },
        {
          "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,
          "excludedComposites": null,
          "excludedItems": [
            {
              "compositeId": 4521883,
              "compositeName": "TUZ"
            }
          ],
          "features": []
        }
      ],
      "payments": [
        {
          "orderId": 190202584,
          "paymentTypeId": 1,
          "paymentName": "Nakit",
          "isMealCard": false,
          "amount": 87.00,
          "customerId": null,
          "customerName": null,
          "customerSurname": null,
          "isDebit": false,
          "currencyId": 1,
          "currency": "TRY",
          "exchangeRate": 1.00,
          "bankId": null,
          "bankName": null,
          "insertDate": "2023-08-18T11:41:03.417"
        }
      ],
      "invoices": [
        {
          "orderId": 190202584,
          "ettn": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "invoiceUrl": "https://example.com/invoice/e-arsiv-2023-001",
          "title": "ACME RESTORAN A.Ş.",
          "identity": "1234567890",
          "identityType": 3,
          "orderInvoiceType": 1
        }
      ]
    }
  ],
  "closedOrdersReceived": 99,
  "canceledOrdersReceived": 1,
  "totalCount": 2841,
  "pageCount": 29,
  "status": 100,
  "message": "İşlem Başarılı!"
}
 

Özellik Alanları (features[])

AlanData TipiAçıklama
featureNameStringÖzellik adı
additionalPriceNumberÖzelliğin ek fiyatı
featureIdNumberÖzellik ID'si
orderDetailIdNumberÖzelliğin ait olduğu ürün satırının ID'si
featureProductCodeString?Özelliğe bağlı reçete ürününün kodu. Bağlı ürün yoksa veya ürün kodu boşsa null
featureProductNameString?Özelliğe bağlı reçete ürününün adı. Bağlı ürün yoksa null

Bir özelliğe en fazla bir reçete ürünü bağlanır. Bağlantı sipariş anında kaydedilir; özellik tanımında sonradan yapılan değişiklikler geçmiş siparişleri etkilemez.

Fatura Alanları (invoices[])

AlanData TipiAçıklama
orderIdNumberSipariş ID'si
ettnStringE-fatura benzersiz takip numarası (ETTN)
invoiceUrlStringFatura belgesine erişim URL'i
titleStringFatura unvanı / şirket adı
identityStringFatura alıcısının vergi veya kimlik numarası
identityTypeNumber1 = TC Kimlik No, 3 = Vergi No (VKN)
orderInvoiceTypeNumber1 = E-Arşiv, 3 = E-Fatura, 5 = E-Adisyon

Ödeme Alanları (payments[])

AlanData TipiAçıklama
paymentTypeIdNumberÖdeme Tipi ID'si
paymentNameStringÖdeme tipi adı
isMealCardBooleanBu ödeme tipinin yemek kartı olup olmadığı
amountNumberÖdeme tutarı
isDebitBooleanÖdemenin veresiye/hesap ödemesi olup olmadığı
currencyIdNumberPara birimi ID'si
currencyStringPara birimi kısa adı
exchangeRateNumberUygulanan döviz kuru
bankIdNumberBanka ID'si
bankNameStringBanka adı
insertDateDate ISO 8601Ödemenin kaydedildiği tarih