Döküman Listele

Döküman Listele

Bu API, belirli bir gönderi için dökümanları listelemesini sağlar.

Endpoint Bilgileri

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

İstek Parametreleri

URL Parametreleri

Örnek Kullanım

API İsteği

Aşağıda, API isteği için bir örnek HTTP raw request bulunmaktadır.

GET {{BASE_URL}}/api/v1/consignments/632236/documents
Content-Type: application/json
APIKEY: {{APIKEY}}

API Cevabı

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

{
    "status": true,
    "message": null,
    "data": [
        {
            "id": 149495,
            "documentType": 8,
            "consignment": {
                "id": 632280
            },
            "fileName": "proforma.pdf",
            "fileSize": "24840",
            "mimeType": "application/pdf",
            "status": 0
        },
        {
            "id": 149496,
            "documentType": 10,
            "consignment": {
                "id": 632280
            },
            "fileName": "cn22.pdf",
            "fileSize": "27126",
            "mimeType": "application/pdf",
            "status": 0
        }
    ]
}

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": "Consignment not found"
        }
    ]
}