[1.23.0] Shipment Tracking

Warning!

Resource is available on in the following countries: PL, IT

Tracking resource is an object representing information about the current status of the shipment in the logistics system. It can be utilized to get information about the creation, status change and status history of the shipment.

On this page

1 Structure
2 Authentication
3 Shipment History
4 Shipment service history

Structure

Tracking resource consists of the following attributes:

Attribute	Type	Description	Availability

Attribute	Type	Description	Availability
`tracking_number`	String	Shipment number.	PL, IT
`type`	String	Shipment type. Available types can be found here: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/28639264.	PL, IT
`service`	String	Shipment type (service). Available types can be found here https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/28639264.	PL, IT
`custom_attributes`	Object	Additional attributes for locker shipments.	PL, IT
`status`	String	Current shipment status.	PL, IT
`created_at`	DateTime	Shipment creation date and time.	PL, IT
`updated_at`	DateTime	Last shipment update date and time.	PL, IT
`tracking_details`	Array	An array containing the history of shipment status changes in chronological descending order. (Last status change appears first on the list)	PL, IT
`expected_flow`	Array	An array containing the predicted statuses through which the given shipment might change.	PL, IT

Additional attributes for parcel locker custom_attributes

Attribute	Type	Description	Availability

Attribute	Type	Description	Availability
`target_machine_detail`	Hash	Additional receiver locker parameters.	PL, IT
`dropoff_machine_detail`	Hash	Additional sender locker parameters.	PL, IT
`size`	String	Shipment size [A, B, C]	PL, IT
`target_machine_id`	String	Receiver locker name.	PL, IT
`dropoff_machine_id`	String	Sender locker name.	PL, IT

An array of objects containing the history of status changes, sorted chronologically in descending order (the last status is the first in the list) tracking_details

Attribute	Type	Description	Availability

Attribute	Type	Description	Availability
`status`	String	Status name	PL, IT
`origin_status`	String	Status symbol	PL, IT
`agency`	String	Agency name	PL, IT
`datetime`	String	Time of change	PL, IT

Tracker resource example JSON format:

{
	"tracking_number": "612345678901234567890123",
	"type": "inpost_locker_standard",
    "service": "inpost_locker_standard",
    "status": "dispatched_by_sender",
	"custom_attributes": {
        "size": "A"
		"target_point_id": "KRA000",
        "target_machine_detail": {
            "href": "https://api-pl-points.easypack24.net/v1/points/AAA000",
            "name": "AAA000",
            "opening_hours": "PN-PT 09:00-16:00",
            "location_description": "Beta Agencja Usługowo-Finansowa",
            "location": {
                "latitude": 50.26899,
                "longitude": 18.97812
            },
            "address": {
                "line1": "ul.Reymonta 999",
                "line2": "33-333 Kraków"
            },
            "type": [
                "parcel_locker"
            ]
        },
	},
	"tracking_details": [
		{
			"status": "dispatched_by_sender",
            "origin_status": "NWP",
            "agency": "Kraków",
			"datetime": "2015-09-17T11:28:00.000+02:00"
		},
		{
			"status": "confirmed",
            "origin_status": "PPN",
            "agency": null,
			"datetime": "2015-09-17T10:28:00.000+02:00"
		}
	],
	"expected_flow": [],
    "created_at": "2015-09-17T08:00:00.000+02:00",
	"updated_at": "2015-09-17T11:28:00.000+02:00",
}

Authentication

Resource access does not require authentication.

Shipment History

Retrieving information about shipment status changes:

GET /v1/tracking/:tracking_number

Example request:

curl -X GET https://api-shipx-pl.easypack24.net/v1/tracking/612345678901234567890123 -H 'Content-Type: application/json'

Response:

If the given tracking number is correct and the shipment has been found, the following information is returned:

HTTP/1.1 200 OK
Content-Type: application/json
 {
	"tracking_number": "612345678901234567890123",
	"type": "inpost_locker_standard",
    "service": "inpost_locker_standard",
    "status": "dispatched_by_sender",
	"custom_attributes": {
        "size": "A"
		"target_point_id": "KRA000",
        "target_machine_detail": {
            "href": "https://api-pl-points.easypack24.net/v1/points/AAA000",
            "name": "AAA000",
            "opening_hours": "PN-PT 09:00-16:00",
            "location_description": "Beta Agencja Usługowo-Finansowa",
            "location": {
                "latitude": 50.26899,
                "longitude": 18.97812
            },
            "address": {
                "line1": "ul.Reymonta 999",
                "line2": "33-333 Kraków"
            },
            "type": [
                "parcel_locker"
            ]
        },
	},
	"tracking_details": [
		{
			"status": "dispatched_by_sender",
            "origin_status": "NWP",
			"datetime": "2015-09-17T11:28:00.000+02:00"
		},
		{
			"status": "confirmed",
            "origin_status": "PPN",
			"datetime": "2015-09-17T10:28:00.000+02:00"
		}
	],
	"expected_flow": [],
    "created_at": "2015-09-17T08:00:00.000+02:00",
	"updated_at": "2015-09-17T11:28:00.000+02:00",
}

Response example of a shipment that has not been found:

HTTP/1.1 404 Not Found
Content-Type: application/json
{
	"status": 404,
	"error": "resource_not_found",
	"description": "Tracking information about 612345678901234567890123 InPost Locker shipment has not been found.",
	"details": null
}

Response example for a tracking number for which the shipment type could not be determined:

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
    "status": 400,
    "error": "uknown_tracking_number",
    "message": "Cannot identify type of shipment by given tracking number (612345678901234567890123)",
    "details": null
}

Shipment service history

Mixed shipments services can be changed during the logistics processing.
Shipments service history can be retrieved using the following resource:

GET v1/tracking/:tracking_number/service_history

Request example:

curl -X GET https://api-shipx-pl.easypack24.net/v1/tracking/523000015802677003881245/service_history -H 'Content-Type: application/json'

Response:

HTTP/1.1 200 OK
Content-Type: application/json
{
	"href": "https://api-shipx-pl.easypack24.net/v1/shipments/120"
	"id": "120"
	"service_history": {
		"last_service": "inpost_courier_standard",
		"updated_at": "2017-10-27T12:39:02.125+02:00"
    }
}