Döküman İndir

Döküman İndir

Bu API, belirli bir gönderinin seçilen dökümanının dosya olarak indirilmesini sağlar.

Endpoint Bilgileri

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

İstek Parametreleri

URL Parametreleri

Parametre Adı Parametre Tipi Zorunluluk Açıklama
documentId Integer Zorunlu Döküman ID'si

Ö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/download
APIKEY: {{APIKEY}}

API Cevabı

Başarılı bir istekte, API yanıtı content-type değişken olmak üzere Stream tipinde dosya akışı sağlayacaktır.

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