REST API - Status

The REST API supports retrieving the status of a shipment by barcode.

Endpoint

/parcel/status/{Barcode}

Headers

A valid JWT token in the request is needed along with the version number to authenticate and authorize the request.
Replace ACCESS_TOKEN with a valid access token.

Authorization: Bearer ACCESS_TOKEN
Api-Version: 3.0
Content-Type: application/json

Status Request

Based on the provided barcode the status of the shipment will be retrieved.

Method: GET
Response: 200 OK

Parameter	Type	Comment
Barcode	string	Barcode of the shipment

Status Response

The response format is a JSON body with http code 200 OK.
If no shipments are found a http code 204 No Content is returned.
If an error occurred an Error response will be generated.

Parameter	Type	Comment
Barcode	string	Barcode of the shipment
StatusId	int	The statusId of the shipment used by Simplymail
Status	string	The status name of the shipment used by Simplymail
CarrierDate	date	The date when the status of the shipment was updated by the carrier
CarrierCode	string	The code of the shipment used by the carrier
CarrierStatus	string	The status of the shipment used by the carrier

{
    "barcode": "3S1100001",
    "statusId": 6,
    "status": "Delivered",
    "carrierDate": "2022-09-02T14:35:09",
    "carrierCode": "11",
    "carrierStatus": "Zending afgeleverd"
}