Taslak Sevkiyat Oluştur

 Taslak Oluştur

Bu endpoint, Yeni bir taslak sevkiyat oluşturulmasını sağlar.

Endpoint Bilgileri

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

İstek Parametreleri

Temel Parametreler

Gönderen Bilgileri

Alıcı Bilgileri

Fatura Bilgileri

Paket Bilgileri

Paket İçerik Bilgileri

Döküman Bilgileri (Opsiyonel)

Bu alan tamamen opsiyonel olup, gönderiniz döküman içermeyecek ise kullanılmamalıdır.

Gönderimden önce Döküman Yüklemesi gerekmektedir , Bu işlem için şu dökümanı inceleyiniz: Gönderi Döküman Yükleme API.

Not: Sadece bazı providerlar Dijital Döküman Gönderimini desteklemektedir. Provider ve Kullanılabilir Döküman gönderimi bilgisi için iletişime geçiniz

Döküman Bilgisi Örnek Veri

{
    //diğer gönderi parametreleri...
    "documents": [
        {
            "id": 4617
        }
    ],
    //diğer gönderi parametreleri...

Ek Hizmet Bilgileri (Opsiyonel)

Bu alan tamamen opsiyonel olup, gönderiniz Ek Hizmet içermiyor ise kullanılmamalıdır.

Sistemde yer alan Ek Hizmet Tiplerine ve Detay parametreleri hakkında daha fazla bilgi için şu dökümanı mutlaka inceleyiniz Ek Hizmetler

Not: Sadece bazı Providerlar Ek Hizmetleri desteklemektedir. Provider ve Kullanılabilir Ek hizmet bilgisi için iletişime geçiniz

Ek Hizmet Bilgisi Örnek Veri

{
    //diğer gönderi parametreleri...
    "special_services": [
        {
            "service_type": "CASH_ON_DELIVERY",
            "details": {
                "method": "CASH",
                "amount": 134.52,
                "accountNumber": "12312312"
            }
        },
        {
            "service_type": "HOLD_AT_DEPARTMENT"
        }
    ],
//diğer gönderi parametreleri...
}

Örnek Kullanım

API İsteği

Aşağıda, API isteği için bir örnek JSON verisi bulunmaktadır. Bu örnekte Normalde Sevkiyat Oluşturma verisinde istenen bazı alanlar sonra belirlenmek üzere hiç gönderilmemiştir. (package, items vs.) Sadece Gönderici Alıcı bilgileri girilmiştir.

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

{
    "provider_id": 7,
    "preference": 0,
    "incoterms_type": 1, //1=DDP,2=DDU
    "consignor": {
        "name": "XYZ COMP",
        "attention_name": "XYZ COMP",
        "country": "TUR",
        "state": "İstanbul",
        "city": "Kadıköy",
        "postal_code": "34758",
        "address": "istanbul",
        "phone_number": "2122512222",
        "email": "admin@comtohome.com"
    },
    "consignee": {
        "name": "Clonberg Duates",
        "attention_name": "Clonberg Duates",
        "country": "DEU",
        "state": "Hamburg",
        "city": "Altona",
        "postal_code": "16909",
        "address": "example address .",
        "phone_number": "09606468625",
        "email": "testConsignee@comtohome.com"
    }
}

API Cevabı

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

{
    "status": true,
    "message": "Draft consignment created",
    "data": {
        "specific_provider_barcode": null,
        "id": 242,
        "provider_id": 7,
        "preference": 0,
        "uuid": "aa203bc1-c2f0-46c3-a635-f59abccd1c4a",
        "barcode": null,
        "reference_no": null,
        "invoice_number": null,
        "status": 24,
        "status_message": "New draft",
        "weight": 0,
        "desi": 0,
        "consignor": {
            "name": "XYZ COMP",
            "attention_name": "XYZ COMP",
            "country": "Turkey",
            "country_iso3": "TUR",
            "state": "İstanbul",
            "city": "Kadıköy",
            "address": "istanbul",
            "postal_code": "34758",
            "phone": "2122512222",
            "email": "admin@comtohome.com"
        },
        "consignee": {
            "name": "Clonberg Duates",
            "attention_name": "Clonberg Duates",
            "country": "Germany",
            "country_iso3": "DEU",
            "state": "Hamburg",
            "city": "Altona",
            "address": "example address .",
            "postal_code": "16909",
            "phone": "09606468625",
            "email": "testConsignee@comtohome.com"
        },
        "warehouse_id": null,
        "consignee_id": null,
        "details": [],
        "packages": [],
        "documents": [],
        "labels": [],
        "created_at": "2025-05-07 18:14:45",
        "updated_at": "2025-05-07 18:14:45",
        "consignment_type": 2,
        "incoterms_type": 1,
        "special_services": [],
        "specific_shipping_method": null
    }
}

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."
        }
    ]
}