Update shipment status
This endpoint is used to update the status of a shipment. The status is updated with the new status, stop number, and additional details of the shipment.
Header Parameters
Authorization string required
API Key generated in the settings. For third-party apps, Chaine will provide this key.
application/json
Request Body required
status string required
Possible values: [Arrived
, Departed
, ETA
]
Current status of the shipment. Must be one of: Arrived, Departed, ETA.
stopNumber integer
The number of the stop for which the status is being provided for.
dateTime date-time required
Date and time of the status update. This field is required in the format YYYY-MM-DDTHH:MM:SSZ.
shipmentNumber string required
Shipment number unique to the Chaine customer.
Responses
- 200
- 400
- 401
OK
application/json
Schema
Example (from schema)
Example
Schema
message string
{
"message": "string"
}
{
"message": "Status updated successfully"
}
Bad Request
application/json
Schema
Example (from schema)
Example
Schema
error string
{
"error": "string"
}
{
"error": "Invalid input data"
}
Unauthorized
application/json
Schema
Example (from schema)
Example
Schema
error string
{
"error": "string"
}
{
"error": "Invalid API key"
}
Loading...