Shipment | States
GET
/api/v0/shipment/{shipmentId}
/states
Request
Headers
Header |
Required |
Description |
Content-Type |
yes |
Type of data sent (application/json ) |
X-Auth-Token |
yes |
Authentication token |
Example
curl --request GET
--url https://net.wings.rs/api/v0/shipment/ce5c4a4e-8324-11ea-a71e-0242ac190002/states
--header 'Content-Type: application/json'
--header 'X-Auth-Token: <TOKEN>'
Response
Body
Parameter |
Type |
Description |
state |
string |
Shipment state (CREATED , UPDATED , SEALED , SENT , READ , CONFIRMED ) |
date |
string |
State occurrence date (format: ISO-8601 , example: 2005-08-15T15:52:01+00:00 ) |
Example
{
"data": [
{
"state": "CREATED",
"date": "2020-06-14T08:43:42+00:00"
},
{
"state": "UPDATED",
"date": "2020-06-14T08:49:21+00:00"
},
{
"state": "SEALED",
"date": "2020-06-14T08:49:21+00:00"
},
{
"state": "SENT",
"date": "2020-06-14T08:49:24+00:00"
},
{
"state": "READ",
"date": "2020-06-14T11:15:13+00:00"
},
{
"state": "CONFIRMED",
"date": "2020-06-14T11:32:48+00:00"
}
]
}
In case of an error (status code 422
):
{
"error": {
"message": "Provided Shipment cannot be found for authenticated user"
}
}