Etiket Listele

Bu API, belirli bir gönderi için etiketleri listelemesini sağlar.

Endpoint Bilgileri

Özellik Değer
URL {{BASE_URL}}/api/v1/consignments/{consignmentId}/labels
HTTP Metodu GET
İçerik Türü application/json
Kimlik Doğrulama APIKEY header

İstek Parametreleri

URL Parametreleri

Parametre Adı Parametre Tipi Zorunluluk Açıklama
consignmentId Integer Zorunlu Gönderi 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/consignments/632236/labels
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": 149536,
            "consignment": {
                "id": 632236
            },
            "consignmentProvider": {
                "id": 1
            },
            "customer": {
                "id": 1
            },
            "fileName": "label_gknAlH.pdf",
            "fileMimeType": "application/pdf",
            "templateName": "c2h-shipment-label.twig",
            "templateType": "twig",
            "providerTrackingCode": "C2H42208773085",
            "labelType": 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"
        }
    ]
}