Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
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.
Na tej stronie
Table of Contents |
---|
Struktura
Element zasobu Statuses
posiada następujące atrybuty:
Atrybut | Typ | Opis |
---|---|---|
| String | Nazwa statusu. |
| String | Krótki opis (tytuł) statusu. |
| String | Długi opis statusu, który dokładniej wyjaśnia aktualny stan przesyłki. |
Przykład reprezentacji zasobu Status
w formacie JSON:
|
Uwierzytelnianie
Zasób status
nie jest autoryzowany, nie jest wymagane podanie tokenu.
Lista statusów
Pobieranie listy wszystkich statusów obsługiwanych przez ShipX.
Info |
---|
Kolekcja nie obsługuje stronicowania. |
|
Kryteria wyszukiwania
Nazwa | Typ | Opis | |||||
---|---|---|---|---|---|---|---|
| String | Język opisów. Określa w jakim języku mają być zwracane opisy ( Możliwe wartości: W przypadku gdy przekazana wartość będzie niepoprawna, API zwróci błąd z kluczem
| |||||
| String | Rodzaj przesyłki. W przypadku gdy przekazana wartość będzie niepoprawna, serwer zwróci błąd
|
Przykład zapytania
|
Przykładowa odpowiedź
|