Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

PanelbgColor#f0f0f0titleBGColor#f0f0f0title

Info

Listę statusów występujących w trackingu można pobrać korzystając z [1.2.0] Statusy

Info

Tracking nie jest dostępna na środowisku sandboxowym. Nie są zwracane statusy



Na tej stronie

Table of Contents
minLevel2
 

Uwierzytelnianie

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


Struktura

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

Atrybut

Typ

Opis

tracking_number

String

Numer przesyłki

type

String

Rodzaj przesyłki. Dostępne rodzaje opisane są na stronie Rozmiary i usługi dla przesyłek

 

service

String

Rodzaj przesyłki. Dostępne rodzaje opisane są na stronie Rozmiary i usługi dla przesyłek

 

custom_attributes

Object

Dodatkowe atrybuty dla przesyłek

paczkomatowych

Paczkomat®.

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.

status

String

Status w jakim aktualnie znajduje się przesyłka.

created_at

DateTime

Data utworzenia przesyłki.

updated_at

DateTime

Data ostatniej aktualizacji informacji o zmianie statusu.

tracking_details

Array

status

String

Status w jakim aktualnie znajduje się przesyłka.

created_at

DateTime

Data utworzenia przesyłki.

updated_at

DateTime

Data ostatniej aktualizacji informacji o zmianie statusu.

tracking_details

Array

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

expected_flow

Array

Tablica przewidywanych statusów, przez które może przejść jeszcze określona przesyłka.

Dodatkowe atrybuty dla przesyłek Paczkomat® custom_attributes

Atrybut

Typ

Opis

size

String

Rozmiar przesyłki [A, B, C]

target_machine_id

String

Nazwa Paczkomat® odbiorczego.

target_machine_detail

Hash

Dodatkowe parametry Paczkomat® odbiorczego.

dropoff_machine_id 

String

Nazwa Paczkomat® nadawczego.

dropoff_machine_detail

Hash

Dodatkowe parametry Paczkomat® nadawczego.

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

.

tracking_details

Atrybut

Typ

Opis

status

String

Nazwa statusu

origin_status

String String 

String 

Nazwa agencji

datetime

String 

String 

Czas zmiany statusu

expected_flow

Array

Tablica przewidywanych statusów, przez które może przejść jeszcze określona przesyłka.

Przykład zasobu 

Przykład zasobu Tracker w formacie JSON:

Code Block
languagejson
{
    
"tracking_number": "
612345678901234567890123
632085946340007012341234",
"type
    "service": "inpost_locker_standard",
    "
service
type": "inpost_locker_standard",
    "status": "
dispatched_by_sender
delivered",
    
"custom_attributes": {
        "size": "A"
"target_point
,
        "target_machine_id": "
KRA000
KAT07A",
        "target_machine_detail": {
            "
href
name": "
https://api-pl-points.easypack24.net/v1/points/AAA000
KAT07A",
            "
name
opening_hours": "
AAA000
24/7",
            "
opening
location_
hours
description": "
PN-PT 09:00-16:00", "location_description": "Beta Agencja Usługowo-Finansowa"
Przy Instytucie Matematyki UŚ",
            "location": {
                "latitude": 50.
26899
26219,
                "longitude": 
18
19.
97812
02902
            },
            "address": {
                "line1": "
ul.Reymonta
Bankowa 
999
14",
                "line2": "
33
40-
333
007 
Kraków
Katowice"
            },
            "type": [
                "parcel_locker"
            ],
        
}, }, "tracking_details": [ { "status": "dispatched_by_sender",
    "location247": true
        },
        "
origin_status
end_of_week_collection":
"NWP"
 false
    },
    "tracking_details": [
      
"agency": "Kraków", "datetime": "2015-09-17T11:28:00.000+02:00" }, { "
  {
            "origin_status": "
confirmed
DOR",
            "
origin_
status": "
PPN
delivered",
            "agency": null,
            "location": null,
            "datetime": "
2015
2023-
09
12-
17T10
18T11:
28
20:
00
06.000+
02
01:00"
}
 
],
 
"expected_flow": []
      },
    
"created_at
    {
            "origin_status": "
2015-09-17T08:00:00.000+02:00
UWP",
"updated_at": "2015-09-17T11:28:00.000+02:00", }

Historia przesyłki

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

Code Block
languagejson
GET /v1/tracking/:tracking_number

Przykład zapytania

Code Block
languagejson
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:

Code Block
languagejson
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": {
            "status": "ready_to_pickup",
            "agency": null,
            "location": null,
            "datetime": "2023-12-18T10:14:01.000+01:00"
        },
        {
            "origin_status": "PDD_2",
            "status": "out_for_delivery",
            "agency": null,
            "location": null,
            "datetime": "2023-12-18T08:37:45.000+01:00"
        },
        {
            "origin_status": "PWO",
            "status": "adopted_at_source_branch",
            "agency": null,
            "location": null,
            "datetime": "2023-12-18T05:56:59.000+01:00"
        },
        {
            "origin_status": "WZO",
            "status": "sent_from_source_branch",
            "agency": null,
            "location": null,
            "datetime": "2023-12-17T19:10:51.000+01:00"
        },
        {
            "origin_status": "PWO",
            "status": "adopted_at_source_branch",
            "agency": null,
            "location": null,
            "datetime": "2023-12-17T17:39:59.000+01:00"
        },
        {
            "origin_status": "PPN",
            "status": "confirmed",
            "agency": null,
            "location": null,
            "datetime": "2023-12-17T12:58:39.000+01:00"
        }
    ],
    "expected_flow": [],
    "created_at": "2023-12-17T12:58:39.539+01:00",
    "updated_at": "2023-12-18T11:20:07.005+01:00"
}

Historia przesyłki

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

Code Block
languagejson
GET /v1/tracking/:tracking_number

Przykład zapytania

Code Block
languagejson
curl -X GET https://api-shipx-pl.easypack24.net/v1/tracking/632085946340007012341234 -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:

Code Block
languagejson
HTTP/1.1 200 OK 
Content-Type: application/json

{
    "tracking_number": "632085946340007012341234",
    "service": "inpost_locker_standard",
    "type": "inpost_locker_standard",
    "status": "delivered",
    "custom_attributes": {
        "size": "A",
        "target_machine_id": "KAT07A",
        "target_machine_detail": {
            "name": "KAT07A",
            "opening_hours": "24/7",
            "location_description": "Przy Instytucie Matematyki UŚ",
            "location": {
                "latitude": 50.26219,
                "longitude": 19.02902
            },
            "address": {
                "line1": "Bankowa 14",
                "line2": "40-007 Katowice"
            },
            "type": [
                "parcel_locker"
            ],
            "location247": true
        },
        "end_of_week_collection": false
    },
    "tracking_details": [
        {
            "origin_status": "DOR",
            "status": "delivered",
            "agency": null,
            "location": null,
            "datetime": "2023-12-18T11:20:06.000+01:00"
        },
        {
            "origin_status": "UWP",
            "status": "ready_to_pickup",
            "agency": null,
            "location": null,
            "datetime": "2023-12-18T10:14:01.000+01:00"
        },
        {
            "origin_status": "PDD_2",
            "status": "out_for_delivery",
            "agency": null,
            "location": null,
            "datetime": "2023-12-18T08:37:45.000+01:00"
        },
        {
            "origin_status": "PWO",
            "sizestatus": "A"
		"target_point_id": "KRA000",adopted_at_source_branch",
            "target_machine_detailagency": {null,
            "href": "https://api-pl-points.easypack24.net/v1/points/AAA000" "location": null,
            "namedatetime": "AAA000",2023-12-18T05:56:59.000+01:00"
        },
        {
            "openingorigin_hoursstatus": "PN-PT 09:00-16:00WZO",
            "location_descriptionstatus": "Beta Agencja Usługowo-Finansowasent_from_source_branch",
            "locationagency": {null,
                "latitudelocation": 50.26899,
   null,
            "longitudedatetime": 18.97812
   "2023-12-17T19:10:51.000+01:00"
        },

           "address": {
                "line1"origin_status": "ul.Reymonta 999PWO",
                "line2status": "33-333 Kraków"
            }adopted_at_source_branch",
            "typeagency": [null,
            "location": null,
  "parcel_locker"          "datetime": "2023-12-17T17:39:59.000+01:00"
 ]       },
 }, 	},
	"tracking_details": [
		{
			"status": "dispatched_by_sender",      {
            "origin_status": "NWPPPN",
			"datetime": "2015-09-17T11:28:00.000+02:00"
		},
		{
			
            "status": "confirmed",
            "origin_statusagency": "PPN",
			null,
            "location": null,
            "datetime": "20152023-0912-17T1017T12:2858:0039.000+0201:00"
		}
	],
	
        }
    ],
    "expected_flow": [],
    "created_at": "20152023-0912-17T0817T12:0058:0039.000539+0201:00",
  	  "updated_at": "20152023-0912-17T1118T11:2820:0007.000005+0201:00",
}

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

Code Block
languagejson
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:

Code Block
languagejson
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
}

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

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

Przykład odpowiedzi

Code Block
languagejson
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"
    }
}