Taslak Gönderi İşle

Bu API, mevcut bir taslak gönderiyi gerçek bir gönderiye dönüştürmek için kullanılır. İşlem sonucunda kargo etiketi oluşturulur ve gönderi kargo firmasına iletilir.

Endpoint Bilgileri

Özellik Değer
URL {{BASE_URL}}/api/v1/consignments/draft/{draft_consignment_id}/start-process
HTTP Metodu POST
İçerik Türü application/json
Kimlik Doğrulama APIKEY header

İşlem Akışı

Taslak Gönderi (status: 24) → Process → Aktif Gönderi (status: 2/3)
                                ↓
                          Kargo Etiketi Oluşturulur
Öncesi Sonrası
status: 24 (New Draft) status: 2 veya status: 3
Etiket yok Etiket oluşturulur
Kargo firmasına iletilmedi Kargo firmasına iletildi

İstek Parametreleri

URL Parametreleri

Parametre Tip Zorunluluk Açıklama
draft_consignment_id Integer ZORUNLU Taslak gönderi ID'si

Gövde Parametreleri (Opsiyonel)

Process isteğinde gövde parametreleri göndererek, taslağı önce güncelleyip sonra işleme alabilirsiniz. Bu sayede tek istekte hem güncelleme hem işleme yapılır.

Kullanılabilir parametreler için Taslak Gönderi Oluştur sayfasına bakın.

İpucu: Taslak oluştururken eksik bıraktığınız paket bilgilerini process aşamasında tamamlayabilirsiniz.


Örnek Kullanım

Sadece Process (Güncelleme Olmadan)

Taslak zaten tamamsa, boş gövde ile process yapabilirsiniz:

curl -X POST "{{BASE_URL}}/api/v1/consignments/draft/243/start-process" \
  -H "Content-Type: application/json" \
  -H "APIKEY: {{APIKEY}}"

Process + Güncelleme (Paket Bilgisi Ekleme)

Taslakta eksik olan paket bilgilerini ekleyerek process yapma:

POST {{BASE_URL}}/api/v1/consignments/draft/243/start-process
Content-Type: application/json
APIKEY: {{APIKEY}}

{
    "packages": [
        {
            "package_type": 1,
            "post_type": 4,
            "weight": 2,
            "length": 30,
            "width": 20,
            "height": 15,
            "dangerous_goods": false,
            "items": [
                {
                    "description": "Bosch Kahve Makinesi",
                    "gtip": "851671900000",
                    "origin": "TR",
                    "currency_code": "EUR",
                    "quantity": 1,
                    "unit_price": 200
                }
            ]
        }
    ]
}

API Cevabı

Başarılı Yanıt

{
    "status": true,
    "message": "Draft Consignment process start successfully",
    "data": {
        "consignment": 243,
        "barcode": "C2H32972076995",
        "c2hBarcode": "C2H32972076995",
        "providerTrackingCode": "1Z999AA10123456784",
        "trackingUrl": "https://provider.com/track/1Z999AA10123456784",
        "contentType": "application/pdf",
        "base64label": "...base64_label_data..."
    }
}

Response Alanları

Alan Tip Açıklama
consignment Integer Gönderi ID'si
barcode String Kargo firması barkodu
c2hBarcode String ComToHome sistem barkodu
providerTrackingCode String Kargo firması takip kodu
trackingUrl String Kargo takip URL'i
contentType String Etiket formatı
base64label String Base64 encoded kargo etiketi

Hata Yanıtları

{
    "status": false,
    "errors": [
        {
            "message": "Consignment not found or not in draft status"
        }
    ]
}

Yaygın Hata Senaryoları

Hata Açıklama Çözüm
Consignment not found Taslak bulunamadı Doğru ID kullanın
Not in draft status Gönderi zaten işlenmiş Sadece status: 24 taslaklar işlenebilir
Reference number has already been used Referans numarası daha önce kullanılmış Benzersiz referans kullanın
Validation hataları Zorunlu alanlar eksik Eksik alanları gövdede gönderin

Sonraki Adımlar

Process başarılı olduktan sonra:

  1. Etiket Yazdırma: base64label alanını decode ederek etiketi yazdırın
  2. Takip: trackingUrl veya c2hBarcode ile gönderiyi takip edin
  3. Webhook: Durum değişikliklerini almak için Webhook kurulumu yapın