Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Zasób Tracking reprezentuje obiekt z informacjami o aktualnym stanie przesyłki w procesie logistycznym. Za jego pomocą można uzyskać informacje o utworzeniu przesyłki, ostatniej zmianie statusu czy też historii statusów.

 

Struktura

Zasób Tracking posiada następujące atrybuty:

AtrybutTypOpis
tracking_numberStringNumer przesyłki
typeStringRodzaj przesyłki. Dostępne rodzaje opisane są na stronie API Przesyłka.
serviceStringRodzaj przesyłki. Dostępne rodzaje opisane są na stronie Usługi i wymiary dla przesyłek.
custom_attributesObject

Dodatkowe atrybuty dla przesyłek paczkomatowych.

AtrybutTypOpis
sizeStringRozmiar przesyłki [A, B, C]
target_machine_idStringNazwa paczkomatu odbiorczego.
target_machine_detailHashDodatkowe parametry paczkomatu odbiorczego.
dropoff_machine_id StringNazwa paczkomatu nadawczego.
dropoff_machine_detailHashDodatkowe parametry paczkomatu nadawczego.
statusStringStatus w jakim aktualnie znajduje się przesyłka.
created_atDateTimeData utworzenia przesyłki.
updated_atDateTimeData ostatniej aktualizacji informacji o zmianie statusu.
tracking_detailsArray

Tablica obiektów zawierające historię zmian statusów, posortowana chronologicznie w kolejności malejącej (ostatni status jest pierwszy na liście).

Przykład obiektu:

{
    "status": "ready_to_pickup",
    "datetime": "2015-08-02T10:15:00.000+02:00"
}
expected_flowArrayTablica przewidywanych statusów, przez które może przejść jeszcze określona przesyłka.

Przykład zasobu Tracker w formacie 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",
}

 

 

 

Uwierzytelnianie

Zasób Tracking nie jest autoryzowany, nie jest wymagane podanie tokenu.

 

 

Historia przesyłki

Pobieranie informacji o zmianach statusów dla określonej przesyłki:

GET /v1/tracking/:tracking_number

Przykład zapytania

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

Odpowiedź

Gdy podany numer przesyłki jest poprawny i zostały odnalezione informacje o przesyłce, serwer zwróci odpowiedź jak poniżej:

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",
}

 

Przykład odpowiedzi w sytuacji gdy informacje o przesyłce nie zostały odnalezione:

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
}

 

Przykład odpowiedzi w sytuacji, gdy system nie był w stanie rozpoznać rodzaju przesyłki na podstawie podanego numeru:

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
}

 

 

Flow przesyłek (wygaszone)

Dla każdego z rodzajów przesyłek może występować różne, spodziewane flow (expected_flow).
Pobieranie flow dla określonego rodzaju przesyłki

/v1/tracking/flow/:shipment_type

Możliwe wartości dla parametru :shipment_type zostały określone na stronie API Przesyłka.

Przykład zapytania

curl -X GET https://api-shipx-pl.easypack24.net/v1/tracking/flow/inpost_locker_standard -H 'content-type: application/json' 

Przykład odpowiedzi

HTTP/1.1 200 OK
Content-Type: application/json
 
{}

 

 

Historia serwisu przesyłek

Paczki mieszane mogą zmieniać swój serwis w tracie procesu logistycznego.
Historię ostatniego serwisu paczki można przeglądać, odpytują poniższy zasób:

Przykład zapytania

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

Przykład odpowiedzi

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"
    }
}

 

 

 

  • No labels