Statuses

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
- 3.1 List of statuses that have origin_status assigned to them

Structure

Status resource has the following attributes:

Attribute	Type	Description

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

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

Parameter

Type

Description

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
}

shipment_type

String

Specifies shipment type.

Titles and descriptions will be adjusted for specific shipment type.

Available values: inpost_locker_standard

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

Example request:

Example response:

List of statuses that have `origin_status` assigned to them

Origin_status	Name

Origin_status	Name
N/A	created
N/A	offers_prepared
N/A	offer_selected
PPN	confirmed
PWPOK	ready_to_pickup_from_pok
GAB	oversized
NWPOK	dispatched_by_sender_to_pok
NWP	dispatched_by_sender
PKL	collected_from_sender
OZPA	taken_by_courier
PWO	adopted_at_source_branch
WZO	sent_from_source_branch
PDA	readdressed
PDD_2	out_for_delivery
UWP	ready_to_pickup
AWI_3	pickup_reminder_sent
PWP	pickup_time_expired
PDO	avizo
OZPOK	taken_by_courier_from_pok
OPP	rejected_by_receiver
PDMPN	undelivered
MOD	delay_in_delivery
ZDN	returned_to_sender
OW	ready_to_pickup_from_branch
DOR	delivered
ANU	canceled
ZAR	claimed
PWP_1	stack_in_customer_service_point
DOPM	stack_parcel_pickup_time_expired
OZP_1	unstack_from_customer_service_point
PWP_2	courier_avizo_in_customer_service_point
PDO_1	taken_by_courier_from_customer_service_point
PWPM	stack_in_box_machine
DOPM_1	stack_parcel_in_box_machine_pickup_time_expired
OZPMM	unstack_from_box_machine
POS	adopted_at_sorting_center
PDD_3	out_for_delivery_to_address
AWI_1	pickup_reminder_sent_address
BDA	undelivered_wrong_address
BRG	undelivered_cod_cash_receiver
PDP	redirect_to_box
APDP	canceled_redirect_to_box

Statuses

Structure

Authorization

Status list

List of statuses that have origin_status assigned to them

List of statuses that have `origin_status` assigned to them