[1.23.0] Statuses

Warning!

Resource available only for specific countries: PL, IT

Resource Statuses is representing state of the shipment in the logistic process. Each status have unique name in the system.

Besides name, status have also two additional descriptions (short and long), in a form understandable by a human.
It can be used for designing user interfaces, which will provide consistent communication between systems, and will make all changes in status description visible automatically.

Status is a read-only resource.

On this page

1 Structure
2 Authorization
3 Status list

Structure

Status resource has the following attributes:

Attribute	Type	Description	Availability

Attribute	Type	Description	Availability
`name`	String	Status name.	PL, IT
`title`	String	Short description (title).	PL, IT
`description`	String	Long description, explaining more precisely current shipment state.	PL, IT

Example of Status resource in JSON format:

{
	"name": "ready_to_pickup",
	"title": "Placed in Parcel Locker (of destination).",
	"description": "And voilà! The parcel will wait for collection for the next 72 hours. If not collected, the parcel will be forwarded to the nearest InPost office and we will inform the Recipient about it via email and text message."
}

Authorization

Authorization for this resource is not required.

Status list

Returns list of all statuses handled by ShipX.

Paging is not available for this collection.

GET /v1/statuses

Available search parameters:

Parameter	Type	Description	Availability

Parameter

Type

Description

Availability

lang

String

It specifies language of returned data (title and description) for each status.

Available values: en_GB, pl_PL. Default value: pl_PL

For invalid value, API will return HTTP error 400 Bad Request with invalid_parameter key. E.g:

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
}

PL, IT

shipment_type

String

Specifies shipment type.

Titles and descriptions will be adjusted for specific shipment type.

For invalid value, API will return HTTP error 400 Bad Request with invalid_parameter key. E.g:

PL, IT

Example request:

Example response: