Döküman Sorgu

Bu API, kullanıcının döküman ID'si ile döküman sorgulama ve detay işlemini sağlar.

Endpoint Bilgileri

Özellik	Değer
URL	`{{BASE_URL}}/api/v1/consignment-documents/{documentId}`
HTTP Metodu	`GET`
İçerik Türü	`application/json`
Kimlik Doğrulama	`APIKEY` header

İstek Parametreleri

URL Parametreleri

Parametre Adı	Parametre Tipi	Zorunluluk	Açıklama
`documentId`	Integer	ZORUNLU	Döküman ID

Ö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/consignment-documents/149495
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
    }
}

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": "1494952 id consignment document not found",
        }
    ]
}