Gönderi Hareketleri

Bu API, Gönderinin tüm hareketlerini listelemesini sağlar.

Endpoint Bilgileri

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

İstek Parametreleri

URL Parametreleri

Parametre Adı	Parametre Tipi	Zorunluluk	Açıklama
`consignment_id`	Integer	ZORUNLU	Gönderi ID

Opsiyonel Sayfalama URL Query Parametreleri

Parametre Adı	Parametre Tipi	Zorunluluk	Açıklama
`page`	Integer	Opsiyonel	Sayfa numarası
`limit`	Integer	Opsiyonel	Sayfa başına listeleme limiti

Ö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/632280/events?page=1&limit=10
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": "successful",
    "data": [
        {
            "consignment": {
                "id": 632280
            },
            "status": 1,
            "statusMessage": "Consignment sent to provider",
            "statusDatetime": "2025-02-18T13:21:16+03:00",
            "provider": {
                "id": 1,
                "name": "Ptt"
            },
            "createdAt": "2025-02-18T13:21:16+03:00"
        }
    ],
    "meta": {
        "page": 1,
        "limit": 10,
        "total": 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": "Konsinye bulunamadı"
        }
    ]
}