Tracking

These endpoints can be used to get and update the shipment tracking information

Get Shipment Tracking

GET https://api-sandbox.shiplemon.com/public/v1/shipments/:id/tracking

This endpoint allows you to retrieve the shipment tracking information for a given shipmentId.

Update interval:

Call this endpoint every hour at :05 and :35.

{
    "status": "ok",
    "data": {
        "partner_id": "partner_id",
        "driver": "elta",
        "carrier": {
            "code": "elta",
            "name": "ELTA Courier",
            "image": "https://static.shiplemon.com/providers/eltacourier.svg"
        },
        "service": {
            "code": "elta_courier_porta_porta",
            "name": "Porta-Porta",
            "estimated_delivery_in_days": 6
        },
        "tracking_status": "DELIVERED",
        "tracking_history": [
            {
                "status": "DELIVERED",
                "status_exact": null,
                "status_date": "2024-07-15T10:02:00.000Z",
                "status_details": "ΠΑΡΑΛΑΒΗ ΑΠΟ ΣΤΑΘΜΟ ΜΕ ΔΗΛΩΣΗ ΠΑΡΑΛΗΠΤΗ"
            },
            {
                "status": "TRANSIT",
                "status_exact": "WITH_COURIER",
                "status_date": "2024-07-15T09:45:00.000Z",
                "status_details": "ΠΡΟΣ ΠΑΡΑΔΟΣΗ"
            },
            {
                "status": "PRE_TRANSIT",
                "status_exact": null,
                "status_date": "2024-07-12T14:17:00.000Z",
                "status_details": "ΔΗΜΙΟΥΡΓΙΑ ΣΥ.ΔΕ.ΤΑ. ΑΠΟ ΠΕΛΑΤΗ"
            }
        ],
        "tracking_ref": "tracking_ref",
        "tracking_url": "tracking_url",
        "country_from": "GR",
        "country_to": "GR"
    }
}

Update Shipment Tracking

PUT https://api-sandbox.shiplemon.com/v1/shipments/:id/tracking

This endpoint allows you to update the shipment tracking with the given shipmentId

Path Parameters

Name
Type
Description

id

string

The `id` of the shipment that needs to be updated.

tracking_history

array

The payload should always include the entire tracking history.

Accepted values

The status and status_date have specific format as shown below:

status: DELIVERED, TRANSIT, PRE_TRANSIT, EXCEPTION (case sensitive) status_date: must be in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.sssZ)

Example Request

Example response

Last updated