Page Comparison

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
`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:

Code Block

language	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ę."
}

Lista statusów

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

Info
Kolekcja nie obsługuje stronicowania.

Code Block

language	json

GET /v1/statuses

Kryteria wyszukiwania

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:

Code Block

language	json

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:

Code Block

language	json

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

Code Block

language	json

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

Przykładowa odpowiedź

Code Block

language	json

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ę."
		},
		{...}
	]
}

Versions Compared

Old Version 6

New Version 7

Key

Struktura

Uwierzytelnianie

Lista statusów