[1.2.0] Statusy

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ć je 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.


Struktura

Element zasobu Statuses posiada następujące atrybuty:

Atrybut

Typ

Opis

Atrybut

Typ

Opis

name

String

Nazwa statusu.

title

String

Krótki opis (tytuł) statusu.

description

String

Długi opis statusu, który dokładniej wyjaśnia aktualny stan przesyłki.

Przykład reprezentacji zasobu Status w formacie JSON:

1 2 3 4 5 { "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

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


 

Lista statusów

Pobieranie listy wszystkich statusów obsługiwanych przez ShipX.

Kolekcja nie obsługuje stronicowania.

1 GET /v1/statuses

 

Kryteria wyszukiwania

Nazwa

Typ

Opis

Nazwa

Typ

Opis

lang

String

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:

1 2 3 4 5 6 7 8 9 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_type

String

Rodzaj przesyłki.
Tytuł i opisy statusów zostaną dostosowane dla określonego rodzaju przesyłki.

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

1 2 3 4 5 6 7 8 9 10 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ład zapytania

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

Przykładowa odpowiedź

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 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ę." }, {...} ] }