Find by Consignment ID

This API allows you to query consignment details using the consignment ID.

Endpoint Information

Request Parameters

URL Parameters

Example Usage

curl -X GET "{{BASE_URL}}/api/v1/consignments/632280/details" \
  -H "Content-Type: application/json" \
  -H "APIKEY: {{APIKEY}}"

<?php
$client = new \GuzzleHttp\Client();

$consignmentId = 632280;

$response = $client->request('GET', "{{BASE_URL}}/api/v1/consignments/{$consignmentId}/details", [
    'headers' => [
        'Content-Type' => 'application/json',
        'APIKEY' => '{{APIKEY}}'
    ]
]);

$body = json_decode($response->getBody(), true);
print_r($body);

<?php
$consignmentId = 632280;

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "{{BASE_URL}}/api/v1/consignments/{$consignmentId}/details",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Content-Type: application/json',
        'APIKEY: {{APIKEY}}'
    ]
]);

$response = curl_exec($ch);
$result = json_decode($response, true);

print_r($result);

curl_close($ch);

API Response

Successful Response

{
    "status": true,
    "message": null,
    "data": {
        "id": 632280,
        "uuid": "3c1563eb-9afd-4eda-8c26-51174d805b08",
        "parent": null,
        "type": "NORMAL",
        "barcode": "C2H07238640094",
        "labels": [
            {
                "id": 149546,
                "provider": 1,
                "file_name": "label_GejlkH.pdf",
                "file_url": "http://localhost/api/v1/public-download/consignment-label/149546?_hash=...",
                "tracking_code": "1Z999AA10123456784",
                "label_type": 0,
                "tracking_type": 2
            }
        ],
        "reference_no": "ORDER-2024-001",
        "consignmentType": 0,
        "status": 1,
        "status_message": "Consignment sent to provider",
        "desi": 1.13,
        "weight": 5.4,
        "consignor": {
            "name": "Sender Company Inc.",
            "attention_name": "Sender Company Inc.",
            "country": "Turkey",
            "countryIso3": "TUR",
            "state": "İstanbul",
            "city": "Arnavutköy",
            "address": "Sample District, Sample Street No:28/A",
            "postal_code": "34277",
            "phone": "905386831394",
            "email": "consignor@example.com"
        },
        "consignee": {
            "name": "Recipient Name",
            "attention_name": "Recipient Name",
            "country": "Turkey",
            "countryIso3": "TUR",
            "state": "Bursa",
            "city": "Nilüfer",
            "address": "Sample District, Sample Street",
            "postal_code": "16285",
            "phone": "905386416672",
            "email": "consignee@example.com"
        },
        "warehouse_id": null,
        "consignee_id": null,
        "details": [
            {
                "status": 1,
                "status_name": "SENDED_TO_PROVIDER",
                "status_description": "Consignment sent to provider",
                "message": "Consignment sent to provider",
                "status_datetime": "2025-02-18 13:21:16",
                "location": null
            }
        ],
        "packages": [
            {
                "id": 562353,
                "package_type": 1,
                "post_type": 4,
                "quantity": 1,
                "dangerous_goods": false,
                "items": [
                    {
                        "id": 150433,
                        "gtip": null,
                        "description": "Product Description",
                        "category": "Category",
                        "origin": "TR",
                        "currency": "USD",
                        "quantity": 1,
                        "unit_price": 8.03
                    }
                ]
            }
        ],
        "documents": [],
        "created_at": "2025-02-18 13:21:16",
        "updated_at": "2025-02-18 13:21:18",
        "provider_base_cost": 20,
        "additional_cost": 64,
        "rule_cost": 0,
        "service_fee": 16.8,
        "special_service_fee": 0,
        "total_cost": 120.96,
        "currency_code": "TRY",
        "currency_rate": 1,
        "permissions": {
            "can_create_cn22": true,
            "can_create_cn23": true,
            "can_create_proforma_invoice": true,
            "can_send_to_provider_manually": true,
            "can_recheck_manually": true
        },
        "customer": {
            "id": 1,
            "customer_code": "1",
            "name": "Customer Name",
            "authorized_name": null
        },
        "user": {
            "id": 1,
            "firstname": "User",
            "lastname": "Name"
        },
        "provider": {
            "id": 1,
            "name": "Ptt",
            "logo": "http://localhost/uploads/provider_logos/ptt.png"
        },
        "special_services": [],
        "specific_shipping_method": null
    }
}

Error Responses

{
    "status": false,
    "errors": [
        {
            "message": "Consignment not found"
        }
    ]
}