Structure
Status
resource has following attributes:
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 |
---|---|---|---|
lang | String | It specifies language of returned data (title and description) for each status. Available values: For invalid value, API will return HTTP error 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. Available values were described here: API Przesyłka. For invalid value, API will return HTTP error 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:
curl -X GET 'https://api-shipx-pl.easypack24.net/v1/statuses?lang=en_GB' -H 'Content-Type: application/json'
Example response:
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." }, {...} ] }