Taslak Sevkiyat İşle

Taslak Sevkiyat İşle

Bu endpoint, Varolan bir taslak sevkiyatı gerçek bir gönderiye çevirmek üzere işleme alır. Bu işlemle birlikte sevkiyat aktif hale gelir ve sistemdeki işleme alınmış gönderiler arasında yerini alır.

Endpoint Bilgileri

• URL: {{BASE_URL}}/api/v1/consignments/draft/{draft_consignment_id}/start-process
• HTTP Metodu: POST
• İçerik Türü: application/json
• Kimlik Doğrulama Tipi: APIKEY

İstek Parametreleri

URL Parametreleri

Gövde Parametreleri

• Bu endpoint gövde parametrelerini destekler.
• Gövde verisinde Gönderi Oluştur dökümanında bulunan tüm parametreleri kullanabilirsiniz. Bu parametreleri kullandığınızda var olan taslak sevkiyat önce güncellenecek sonra işleme alınacaktır.
• Bu sayede taslak sevkiyatı göndermeden önce güncelleme/değiştirme işlevlerini tek endpoint üzerinden yapabilir ve hızlıca işleme alabilirsiniz

Örnek Kullanım

API İsteği

Aşağıda, API isteği için bir örnek JSON verisi bulunmaktadır. Bu örnekte önceden oluşturulan Taslak Sevkiyata, Gövde Parametreleri kullanılarak olmayan veriler(paket bilgileri) doldurulmuş/güncellenmiş ve işleme alınması sağlanmıştır.

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

{
    "package": {
        "items": [
            {
                "description": "Bosch Kahve makinesi",
                "gtip": "12345678901",
                "origin": "TR",
                "currency_code": "TR",
                "quantity": 1,
                "category": "Beyaz eşya",
                "unit_price": 200
            }
        ]
    }
}

API Cevabı

Başarılı bir istekte, API aşağıdaki gibi bir yanıt döndürecektir:

{
    "status": true,
    "message": "Draft Consignment process start successfully",
    "data": {
        "consignment": 243,
        "barcode": "C2H32972076995",
        "c2hBarcode": "C2H32972076995",
        "providerTrackingCode": "C2H32972076995",
        "contentType": "application/pdf",
        "base64label": "...base64_label_data...."
    }
}

Hata Cevapları

API isteği başarısız olursa, API aşağıdaki gibi bir hata yanıtı döndürecektir:

{
    "status": false,
    "errors": [
        {
            "message": "reference_no:Reference number \"XYZ123\" has already been used. Please provide a unique reference number."
        }
    ]
}