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

Zasób Statuses reprezentuje statusy, które określają na jakim etapie procesu logistycznego znajduje się przesyłka. Każdy status posiada unikalną w skali systemu nazwę (name). Poza nazwą, status posiada również dwa opisy: krótki oraz rozszerzony, w formie zrozumiałej dla człowieka. Można wykorzystać jest przy projektowaniu i tworzeniu interfejsów użytkownika, dzięki czemu komunikacja do użytkownika będzie spójna pomiędzy różnymi systemami, a zmiany w opisach statusów widoczne automatycznie.

Zasób Status jest zasobem tylko do odczytu.

Na tej stronie

 

Struktura

Element zasobu Statuses posiada następujące atrybuty:

AtrybutTypOpis
nameStringNazwa statusu.
titleStringKrótki opis (tytuł) statusu.
descriptionStringDługi opis statusu, które dokładniej wyjaśnia aktualny stan przesyłki.

Przykład reprezentacji zasobu Status w formacie JSON:

{
	"name": "stored_by_sender",
	"title": "Umieszczona w Paczkomacie nadawczym",
	"description": "Paczka oczekuje na wyjęcie z Paczkomatu przez doręczyciela. Stąd trafi do najbliższego oddziału InPost i wyruszy w trasę do Paczkomatu odbiorczego. Na tym etapie Odbiorca otrzyma e-mail informujący o wyruszeniu przesyłki w drogę."
}

 

 

Uwierzytelnianie

Aby uzyskać dostęp do zasobu Status nie wymagane są żadne uprawnienia (token).

Lista statusów

Pobieranie listy wszystkich statusów obsługiwanych przez Ship X:

GET /v1/statuses

 

Filtry

NazwaTypOpis
langString

Język opisów. Określa w jakim języku mają być zwracane opisy (title i description) dla poszczególnych statusów.

Możliwe wartości: en_GB, pl_PL
Domyślnie: pl_PL 

W przypadku gdy przekazana wartość będzie niepoprawna, API zwróci błąd z kluczem invalid_parameter. Przykład:

HTTP/1.1 400 Bad Request
Content-Type: application/json
 
{
    "status": 400,
    "error": "invalid_parameter",
    "description": "Provided unsupported value (fr_FR) to parameter (lang)",
    "details": null
}
shipment_typeString

Rodzaj przesyłki.
Tytuł i opisy statusów zostaną dostosowane dla określonego rodzaju przesyłki.
Możliwe wartości określone są na stronie API Przesyłka

W przypadku gdy przekazana wartość będzie niepoprawna, serwer zwróci błąd invalid_parameter z kodem HTTP 400 Bad Request:

HTTP/1.1 400 Bad Request
Content-Type: application/json
 
{
	"status": 400,
	"error": "invalid_parameter",
	"description": "Provided unsupported value (inpost_locker) to
parameter (shipment_type)",
	"details": null
}


Przykładowa odpowiedź

HTTP/1.1 200 OK
Content-Type: application/json
 
{
	"href": "https://api-shipx-pl.easypack24.net/v1/statuses",
	"items": [
		{
			"name": "confirmed",
			"title": "Przygotowana przez Nadawcę",
			"description": "Nadawca poinformował nas, że przygotował paczkę do nadania. Podróż paczki jeszcze się nie rozpoczęła."
		},
		{
			"name": "stored_by_sender",
			"title": "Umieszczona w Paczkomacie Nadawczym",
			"description": "Paczka oczekuje na wyjęcie z Paczkomatu przez doręczyciela. Stąd trafi do najbliższego oddziału InPost i wyruszy w trasę do Paczkomatu odbiorczego. Na tym etapie Odbiorca otrzyma e-mail informujący o wyruszeniu przesyłki w drogę."
		},
		... pozostałe statusy ...
	]
}

(info) Kolekcja nie obsługuje stronicowania.

  • No labels