Shipment Details

ShipmentDetails - Get shipment details and tracking history

Use this endpoint to retrieve the full details of a shipment using its trackingNumber.

The response includes shipment information, recipient details, retailer/store details, assigned driver details, delivery settings, and tracking history.

Required URL parameter

trackingNumber - Public tracking number of the shipment.

When to use this endpoint

To check the current shipment status.
To view shipment, recipient, retailer, and driver information.
To retrieve the tracking history of an order.
To confirm delivery details after the shipment is delivered.

Delivery and drop-off details

deliverySettings is returned for all shipment statuses.
dropOffDetails is only included when the shipment status is delivered.
If the shipment is not delivered, dropOffDetails will be null.
If the shipment is delivered but drop-off data is not available, the related fields may be null.

Summary

Use ShipmentDetails when you need to retrieve complete shipment details and tracking history for a specific order.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Responses

🟢200

application/json

Successful response

Body

Examples

Example order - not deliveredDelivered order responseOrder Delivered but No Settings/DetailsOrder not found

{
    "status": "success",
    "data": {
        "trackingNumber": "IV83RWTX7XGH",
        "status": "delivered",
        "orderDate": "2024-01-15T10:30:00.000Z",
        "expectedDelivery": "2024-01-16T18:00:00.000Z",
        "deliverDate": "2024-01-16T15:30:00.000Z",
        "recipient": {
            "name": "John Doe",
            "mobileNumber": "+971501234567",
            "address": {
                "postalCode": null,
                "location": "Dubai",
                "street1": "123 Main St",
                "street2": "Apt 4B",
                "streetNumber": "123"
            }
        },
        "retailer": {
            "name": "Store Name",
            "externalLocationId": "LOC123456",
            "address": {
                "postalCode": "00000",
                "location": "Dubai",
                "street1": "123 Store Street",
                "street2": "Building A",
                "streetNumber": "456",
                "latitude": 25.2048,
                "longitude": 55.2708
            }
        },
        "driver": {
            "idNumber": "TestHXT5JK",
            "name": "Test Emirates",
            "phone": "+971501234567"
        }
    }
}

🟠401