Ana içeriğe geç

İrsaliye Gönderim - Send Despatch (JSON)

POST https://webservis.ekupbilisim.com/api/outsource/despatch/send-json
Bu, canlı tabandır. Geliştirme ve entegrasyon testleri için /api/outsource-test tabanını kullanın — bkz. Test Ortamı / Sandbox.

JSON formatında irsaliye gönderim işlemleri için gerekli olan API uç noktası. Bu uç nokta, UBL yapısına uygun JSON verilerini alır, XML'e dönüştürür, sisteme kaydeder ve GİB'e gönderir.

ipucu

XML oluşturmaya gerek kalmadan doğrudan JSON verileriyle irsaliye gönderebilirsiniz. Sistem, JSON'u otomatik olarak UBL-TR DespatchAdvice formatına dönüştürür.

Üst Bilgi (Header) Parametreleri​

Authorization string required
Bearer token ile kimlik doğrulama yapılmalıdır.

JSON Parametreleri​

receiver_alias string
Özel bir etikete gönderilmek isteniyorsa kullanılır. Sistem otomatik ilk sıradakine gönderir
ID string
İrsaliye belge numarası. Boş bırakılırsa sistem otomatik oluşturur
UUID string
İrsaliye UUID bilgisi. Boş bırakılırsa sistem otomatik oluşturur
IssueDate string required
İrsaliye düzenleme tarihi. YYYY-MM-DD formatında
DespatchSupplierParty object required
Gönderici taraf bilgileri. UBL-TR DespatchSupplierParty yapısına uygun JSON nesnesi
DeliveryCustomerParty object required
Alıcı taraf bilgileri. UBL-TR DeliveryCustomerParty yapısına uygun JSON nesnesi
DespatchLine array required
İrsaliye kalemleri. UBL-TR DespatchLine yapısına uygun JSON dizisi
bilgi

Yukarıda listelenmemiş tüm UBL-TR alanları opsiyonel olarak gönderilebilir. Detaylı alan listesi için GİB UBL-TR kılavuzlarına bakınız.

Cevaplar ( Responses )​

200
OK
{
        "error": 0,
        "message": "İşlem başarıyla tamamlandı",
        "extra": {
          "id": "01k1x8rykgcnjv07zgf8h07sey",
          "envelopeId": "32a0fa61-1aa9-47ef-123d-30f72e326369",
          "signedXml": [
            "base64"
          ],
          "isEDespatch": true
        }
      }
422
İş Kuralı Hatası
{
"error": 1,
"message": "Geçersiz DespatchAdvice XML formatı."
}
422
İş Kuralı Hatası — Gönderici Etiketi
{
"error": 1,
"message": "Gönderici etiketi bulunamadı."
}
422
İş Kuralı Hatası — İmza Doğrulama
{
"error": 1,
"message": "İrsaliye imzalandı ancak doğrulama başarısız."
}
401
Unauthorized
{
  "error": 1,
  "message": "e-Posta veya şifre hatalı."
}
404
Not Found
{
  "error": 1,
  "message": "The route api/outsource/auth/login1 could not be found."
}
500
Server Error
{
  "error": 1,
  "message": "Sunucu Hatası"
}

Örnek İstek ( Curl )​


curl -X POST --location 'https://webservis.ekupbilisim.com/api/outsource-test/despatch/send-json' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: ••••••' \
--data '{
"IssueDate": "2025-01-15",
"DespatchSupplierParty": {
"Party": {
"PartyIdentification": [{"ID": {"@schemeID": "VKN", "Value": "1234567890"}}],
"PartyName": {"Name": "Gönderici Firma Ünvanı"},
"PostalAddress": {
"CitySubdivisionName": "İlçe",
"CityName": "İl",
"Country": {"Name": "Türkiye"}
}
}
},
"DeliveryCustomerParty": {
"Party": {
"PartyIdentification": [{"ID": {"@schemeID": "VKN", "Value": "0987654321"}}],
"PartyName": {"Name": "Alıcı Firma Ünvanı"},
"PostalAddress": {
"CitySubdivisionName": "İlçe",
"CityName": "İl",
"Country": {"Name": "Türkiye"}
}
}
},
"DespatchLine": [
{
"ID": "1",
"DeliveredQuantity": {"@unitCode": "C62", "Value": "10"},
"OrderLineReference": {"LineID": "1"},
"Item": {"Name": "Ürün Adı"}
}
]
}'