Gönderi Listele

Gönderi Listele

Bu API, hesabın tüm gönderilerini özet bir veri ile listelemesini sağlar.

Endpoint Bilgileri

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

İstek Parametreleri

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?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": null,
    "data": [
        {
            "id": 632280,
            "uuid": "3c1563eb-9afd-4eda-8c26-51174d805b08",
            "barcode": "C2H07238640094",
            "reference_no": "XYZ123",
            "consignmentType": 0,
            "status": 1,
            "status_message": "Consignment sent to provider",
            "consignee": {
                "name": "Emre Sabancı",
                "attention_name": "Emre Sabancı",
                "country": "Turkey",
                "countryIso3": "TUR",
                "state": "Bursa",
                "city": "Nilüfer",
                "address": "Dumlupınar Mh. Cevizlik Cd. Anadolu Evleri 1, B Blok, D:12",
                "postal_code": "16285",
                "phone": "905386416672",
                "email": "consignee@comtohome.com"
            },
            "consignor": {
                "name": "PtteM Tek. ve Elektronik Hiz A.Ş.",
                "attention_name": "PtteM Tek. ve Elektronik Hiz. A.Ş",
                "country": "Turkey",
                "countryIso3": "TUR",
                "state": "İstanbul",
                "city": "Arnavutköy",
                "address": "Yassıören Mah. Dolunay Sk. 28/A Arnavutköy İstanbul",
                "postal_code": "34277",
                "phone": "905386831394",
                "email": "consignor@comtohome.com"
            },
            "created_at": "2025-02-18 13:21:16",
            "updated_at": "2025-02-18 13:21:18",
            "total_cost": 120.96,
            "currency_code": "TRY",
            "currency_rate": 1,
            "customer": {
                "id": 1,
                "customer_code": "1",
                "name": "ComToHome Admin",
                "authorized_name": null
            },
            "user": {
                "id": 1,
                "firstname": "Veli",
                "lastname": "Arı"
            },
            "provider": {
                "id": 1,
                "name": "Ptt",
                "logo": "http://localhost/uploads/provider_logos/ptt.png"
            }
        },
        {
            "id": 632279,
            "uuid": "08152c88-e63a-44f4-8bd1-636d4f166b86",
            "barcode": "C2H46282802942",
            "reference_no": "-",
            "consignmentType": 0,
            "status": 1,
            "status_message": "Consignment sent to provider",
            "consignee": {
                "name": "Emre Sabancı",
                "attention_name": "Emre Sabancı",
                "country": "Turkey",
                "countryIso3": "TUR",
                "state": "Bursa",
                "city": "Nilüfer",
                "address": "Dumlupınar Mh. Cevizlik Cd. Anadolu Evleri 1, B Blok, D:12",
                "postal_code": "16285",
                "phone": "905386416672",
                "email": "consignee@comtohome.com"
            },
            "consignor": {
                "name": "PtteM Tek. ve Elektronik Hiz A.Ş.",
                "attention_name": "PtteM Tek. ve Elektronik Hiz. A.Ş",
                "country": "Turkey",
                "countryIso3": "TUR",
                "state": "İstanbul",
                "city": "Arnavutköy",
                "address": "Yassıören Mah. Dolunay Sk. 28/A Arnavutköy İstanbul",
                "postal_code": "34277",
                "phone": "905386831394",
                "email": "consignor@comtohome.com"
            },
            "created_at": "2025-02-10 16:31:07",
            "updated_at": "2025-02-10 16:31:07",
            "total_cost": 0.37,
            "currency_code": "EUR",
            "currency_rate": 37.1747,
            "customer": {
                "id": 1,
                "customer_code": "1",
                "name": "ComToHome Admin",
                "authorized_name": null
            },
            "user": {
                "id": 1,
                "firstname": "Veli",
                "lastname": "Arı"
            },
            "provider": {
                "id": 7,
                "name": "PttAbroad",
                "logo": "http://localhost/uploads/provider_logos/pttabroad.png"
            }
        },
        {
            "id": 632262,
            "uuid": "b0673369-04fe-42f7-b6f8-e0522e175871",
            "barcode": "C2H44344298503",
            "reference_no": "TU123213123",
            "consignmentType": 0,
            "status": 1,
            "status_message": "Consignment sent to provider",
            "consignee": {
                "name": "Hans Müller",
                "attention_name": "Hans Müller",
                "country": "Germany",
                "countryIso3": "DEU",
                "state": "Berlin",
                "city": "Mitte",
                "address": "Unter den Linden 1",
                "postal_code": "81366",
                "phone": "49301234567",
                "email": "hans.mueller@muster.de"
            },
            "consignor": {
                "name": "PtteM Tek. ve Elektronik Hiz A.Ş.",
                "attention_name": "PtteM Tek. ve Elektronik Hiz. A.Ş",
                "country": "Turkey",
                "countryIso3": "TUR",
                "state": "İstanbul",
                "city": "Arnavutköy",
                "address": "Yassıören Mah. Dolunay Sk. 28/A Arnavutköy İstanbul",
                "postal_code": "34277",
                "phone": "905386831394",
                "email": "consignor@comtohome.com"
            },
            "created_at": "2025-02-10 16:29:43",
            "updated_at": "2025-02-10 16:29:49",
            "total_cost": 0.37,
            "currency_code": "EUR",
            "currency_rate": 37.1747,
            "customer": {
                "id": 1,
                "customer_code": "1",
                "name": "ComToHome Admin",
                "authorized_name": null
            },
            "user": {
                "id": 1,
                "firstname": "Veli",
                "lastname": "Arı"
            },
            "provider": {
                "id": 7,
                "name": "PttAbroad",
                "logo": "http://localhost/uploads/provider_logos/pttabroad.png"
            }
        }
    ],
    "meta": {
        "page": 1,
        "limit": 10,
        "total": 9
    }
}