Kurye Entegrasyonu

Bu API dokümantasyonu, dış kurye firmalarının GoPOS sistemi ile haberleşerek sipariş durumlarını güncellemesini sağlar. İstekler mağazayı tanımlayan storeGoId parametresi ile yapılmalıdır.

Yeni Sipariş Bildirimi (Size Yapılan İstek)

GoPOS sistemi, kuryeye atanacak yeni bir sipariş oluştuğunda kurye tarafındaki API'nizde açacağınız bu endpoint'e bildirim gönderir. Güvenlik ve doğrulama için, gelen istekteki storeGuId parametresinin sizin sisteminizdeki mağaza GoId değeri ile eşleştiğini kontrol etmeniz zorunludur.

Aşağıdaki örnekteki Enum (int) değerlerinin karşılıkları şöyledir:

• CurrentOrderStatus: 0 (Created), 1 (Accepted), 2 (InDelivery), 3 (Completed), 4 (Cancelled)
• WebhookActionType: 0 (None), 1 (OrderCreated), 2 (OrderUpdated), 3 (OrderRejected)

{
  "ticketGuId": "123e4567-e89b-12d3-a456-426614174000",
  "storeGuId": "HERE_BE_GUID",
  "currentOrderStatus": 0,
  "webhookActionType": 1
}

Siparişi Getir

Belirtilen bilete (siparişe) ait detayları getirir. Kurye firması siparişi üstlendiğinde detayları bu endpoint üzerinden sorgulayabilir.

{
  "status": 100,
  "success": true,
  "data": [
    {
      "id": 25,
      "orderTotal": 50.00,
      "products": [
        {
          "productName": "Cheeseburger",
          "price": 30.00,
          "quantity": 1
        }
      ]
    }
  ]
}

Siparişi Kabul Et

Kuryenin atanan siparişi kabul ettiğini GoPOS sistemine bildirir.

{
  "ticketGuId": "123e4567-e89b-12d3-a456-426614174000"
}

Siparişi Reddet

Kuryenin siparişi teslim almayı reddettiğini veya iptal ettiğini bildirir. Bir iptal nedeni (RejectionReasonId) gönderilmesi zorunludur.

{
  "ticketGuId": "123e4567-e89b-12d3-a456-426614174000",
  "rejectionReasonId": "REASON_01"
}

Yola Çıktı (Teslim Alındı)

Kuryenin siparişi restorandan/şubeden teslim aldığını ve müşteriye doğru yola çıktığını bildirir.

{
  "ticketGuId": "123e4567-e89b-12d3-a456-426614174000"
}

Teslim Edildi (Tamamlandı)

Siparişin müşteriye başarıyla teslim edildiğini bildirir. Eğer siparişte ödeme kapıda alındıysa goPaymentId gönderilmelidir.

{
  "ticketGuId": "123e4567-e89b-12d3-a456-426614174000",
  "goPaymentId": 1
}

İptal Nedenleri

Siparişi reddederken kullanılabilecek geçerli sebep kodlarını listeler. Dönen rejectionReasonId değeri Siparişi Reddet metodunda kullanılır.

[
  {
    "rejectionReasonId": "R_KAZA",
    "rejectionReasonDescription": "Kurye kaza yaptı / Motor arızası"
  }
]

Ödeme Tipleri

Teslimat sırasında kullanılan ödeme tiplerini ve ID'lerini listeler. Dönen id değeri Teslim Edildi metodunda goPaymentId olarak kullanılır.

[
  {
    "id": 1,
    "name": "Nakit"
  }
]