Versions Compared

Old Version 4

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version 5

changes.mady.by.user Michał Machowski

Saved on

Key

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

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.

PanelbgColor#f0f0f0titleBGColor#f0f0f0title


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

Table of Contents
minLevel2
 

Structure

The Statuses resource element

Status resource has the following attributes:

Attribute

Type

Description

name

String

Nazwa statusu

Status name.

title

String

Krótki opis

Short description (

tytuł

title)

statusuSample Status resource representation in the

.

description

String

Długi opis statusu, które dokładniej wyjaśnia aktualny stan przesyłki.

Long description, explaining more precisely current shipment state.


Example of Status resource in JSON format:

Code Block
languagejson
{
	"name": "
stored
ready_
by
to_
sender
pickup",
	"title": "
Umieszczona w Paczkomacie nadawczym
Placed in Parcel Locker (of destination).",
	"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ę
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."
}

Authentication

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

Authorization

Authorization for this resource is not required.

List of statuses

Collecting the

Status list

Returns list of all statuses

operated by Ship X:code

handled by ShipX.

Info

Paging is not available for this collection.

Code Block
languagejson
GET /v1/statuses

Filters

Name

Available search parameters:

Parameter

Type

Description

lang

String

Language of the descriptions. Determines the language in which the descriptions

It specifies language of returned data (title and description)

are to be returned for particular statuses

for each status.

Possible

Available values: en_GB, pl_PL


By default

. Default value: pl_PL 

When the provided value is incorrect, the

For invalid value, API will return

an error with the

HTTP error 400 Bad Request with invalid_parameter key. E.


Example

g:

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

Shipment

Specifies shipment type.

The title

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

Code Block

for specific shipment type.

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

Code Block
languagejson
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
code

Example request:
 Code Block
languagejson
curl -X GET 'https://api-shipx-pl.easypack24.net/v1/statuses?lang=en_GB' -H 'Content-Type: application/json'
Example response:
 Code Block
languagejson
HTTP/1.1 200 OK
Content-Type: application/json

 

{
	"href": "
https
http://api-shipx-pl.easypack24.net/v1/statuses?lang=en_GB",
	"items": [
		{
			"name": "
confirmed
created",
			"title": "
Przygotowana przez Nadawcę
Shipment created.",
			"description": "
Nadawca poinformował nas, że przygotował paczkę do nadania. Podróż paczki jeszcze się nie rozpoczęła
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": "
stored
offer_
by_sender
selected",
			"title": "
Umieszczona w Paczkomacie Nadawczym
Offer selected.",
			"description": "
Paczka
Customer 
oczekuje
has 
na
chosen 
wyjęcie
one 
z
of 
Paczkomatu
prepared 
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ę
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."
		},
		{...
 pozostałe statusy ...
}
	]
}
(info) The collection does not support paging.