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" \
  --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
pageNumber?Geçerli sayfa
startDateDate? ISO 8601Başlangıç Tarihi
includeCancelledBoolean?İptal edilen siparişler dahil edilsin mi?
orderTypeString? (Virgülle ayrılmış, çoklu)Sipariş Tipleri

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,
          "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ı!"
}