Versions Compared

Old Version 1

changes.mady.by.user anagorski

Saved on

compared with

New Version 2

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info
titleWarning!

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.


Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleOn this page

Table of Contents
minLevel2
 


Structure

Status resource has following attributes:

AttributeTypeDescriptionAvailability
nameStringStatus name.PL, IT
titleStringShort description (title).PL, IT
descriptionStringLong description, explaining more precisely current shipment state.PL, IT


Example of Status resource in JSON format:

Code Block
{
	"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.

(info) Paging is not available for this collection.

Code Block
GET /v1/statuses

Available search parameters:

ParameterTypeDescriptionAvailability
langString

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:

Code Block
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_typeString

Specifies shipment type.

Titles and descriptions will be adjusted for specific shipment type. Available values were described here: API Przesyłka.

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

Code Block
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
}


PL, IT

Example request:

Code Block
curl -X GET 'https://api-shipx-pl.easypack24.net/v1/statuses?lang=en_GB' -H 'Content-Type: application/json'

Example response:

Code Block
HTTP/1.1 200 OK
Content-Type: application/json
{
	"href": "http://api-shipx-pl.easypack24.net/v1/statuses?lang=en_GB",
	"items": [
		{
			"name": "created",
			"title": "Shipment created.",
			"description": "The shipment has been created but is not ready for dispatch."},{"name":"offers_prepared","title":"Offers prepared.","description":"Offers for shipment have been prepared."
		},
		{
			"name": "offer_selected",
			"title": "Offer selected.",
			"description": "Customer has chosen one of prepared offers."
		},
		{
			"name": "confirmed",
			"title": "Prepared by Sender.",
			"description": "Sender informed us that the shipment is ready for dispatch. The shipments’s journey has not begun yet."
		},
		{...}
	]
}