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

Sample Status resource representation in the JSON format:

The Statuses resource represents the statuses which determine the stage of the logistic process the shipment is at. Each status has a unique name (name)in the system Apart from the name, the status also has two descriptions: short and extended, in human-readable form. They can be used when designing and creating user interfaces, offering user communication that is consistent between different systems, and with any changes in status descriptions being visible automatically.
The Statuses resource is read-only.


On this page

 

Structure

The Statuses resource element has the following attributes:

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

Sample Status resource representation in the JSON format:

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



Authentication

In order to gain access to the Status resource no rights (token) are required.

List of statuses

Collecting the list of all statuses operated by Ship X:

GET /v1/statuses


Filters

NameTypeDescription
langString

Language of the descriptions. Determines the language in which the descriptions (title and description) are to be returned for particular statuses.

Possible values: en_GB, pl_PL
By default: pl_PL 

When the provided value is incorrect, the API will return an error with the invalid_parameter key.
Example:

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

Shipment type.

The title and status descriptions will be adjusted to the particular kind of shipment.
Possible values are specified on page API Przesyłka

In the event that the provided value is incorrect, the server will return the invalid_parameter error with HTTP 400 Bad Request code:

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
}


Sample response

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) The collection does not support paging.

  • No labels