Yurtdışı Gönderi Oluştur

Yurtdışı Gönderi Oluştur

Bu API, Yurt dışı kargo ve lojistik gönderileri oluşturmak için kullanılır.

Endpoint Bilgileri

• URL: {{BASE_URL}}/api/v1/consignments
• 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

Örnek Kullanım

API İsteği

Aşağıda, API isteği için bir örnek JSON verisi bulunmaktadır.

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

{
    "provider_id": 7,
    "preference": 0,
    "invoice_number": "IHR2024000001641",
    "incoterms_type": 1,
    "address_resolver_type": 0,
    "reference_no": "XYZ128",
    "consignor": {
        "name": "Ali Veli",
        "attention_name": "Ali Veli",
        "country": "TR",
        "state": "İstanbul",
        "city": "Kadıköy",
        "postal_code": "34700",
        "address": "Moda Caddesi 123/A",
        "phone_number": "+905321234567",
        "email": "ali@veli.com"
    },
    "consignee": {
        "name": "John Doe",
        "attention_name": "John Doe",
        "country": "US",
        "state": "California",
        "city": "Los Angeles",
        "postal_code": "90001",
        "address": "123 Street",
        "phone_number": "+12345678901",
        "email": "johndoe@example.com"
    },
    "invoice": {
        "name": "Jane Smith",
        "tax_number": "12345678910",
        "tax_office": "California",
        "email": "janesmith@example.com",
        "country": "US",
        "state": "California",
        "city": "Los Angeles",
        "address": "456  Avenue",
        "phone_number": "+12345678902"
    },
    "packages": [
        {
            "package_type": 1,
            "post_type": 4,
            "quantity": 1,
            "weight": 2,
            "length": 15,
            "width": 15,
            "height": 15,
            "dangerous_goods": true,
            "items": [
                {
                    "description": "FOOD",
                    "gtip": "170490999019",
                    "origin": "TR",
                    "currency_code": "USD",
                    "unit_price": 8.03,
                    "quantity": 1,
                    "category": "FOOD"
                }
            ]
        }
    ]
}

API Cevabı

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

{
    "status": true,
    "message": "Consignment created successfully",
    "data": {
        "consignment": 632279,
        "barcode": "C2H46282802942",
        "c2hBarcode": "C2H46282802942",
        "providerTrackingCode": "C2H46282802942",
        "contentType": "application\/pdf",
        "base64label": "...base64data",
        "detail": {
            "total_cost": 120.96,
            "currency_code": "TRY",
            "currency_rate": 1,
            "reference_no": null,
            "packages": {
                "desi": 1.13,
                "weight": 5.4,
                "quantity": 1
            }
        }
    }
}

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