UpdateLoadStatus
POST/services/api/rest/UpdateLoadStatusThis function will change the status of a shipment. This will return the identification number of the shipment that was updated.
This function is not to be used to switch shipments between booked or dispatched back to open or vice versa.
Suggested uses of this function include:
- Moving pending shipments to open
- Moving shipments from dispatched to in transit
- Moving shipments from in transit to delivered
- Moving shipments from canceled to open
Request
Header Params
Accept
string
required
Example:
application/json
Body Params application/json
No schema defined
Example
{
"AuthenticationData": {
"Username": "username",
"Password": "password",
"ClientRefNum": ""
},
"LoadId": 123456,
"NewStatus": "Dispatched"
}Request samples
Responses
UpdateLoadStatus - 200 OK(200)
UpdateLoadStatus - 200 OK
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
No schema defined
ExampleUpdateLoadStatus - 200 OK
{
"LoadId": 52479246,
"Success": true,
"Error": {
"Message": ""
}
}Last modified: 2 months ago