UpdateLoadStatus

POST

/services/api/rest/UpdateLoadStatus

This 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

Body Params application/json

Example

{
    "AuthenticationData": {
        "Username": "username",
        "Password": "password",
        "ClientRefNum": ""
    },
    "LoadId": 123456,
    "NewStatus": "Dispatched"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/UpdateLoadStatus' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "AuthenticationData": {
        "Username": "username",
        "Password": "password",
        "ClientRefNum": ""
    },
    "LoadId": 123456,
    "NewStatus": "Dispatched"
}'

Responses

🟢200UpdateLoadStatus - 200 OK

application/json

Body

Example

{
    "LoadId": 52479246,
    "Success": true,
    "Error": {
        "Message": ""
    }
}

Modified at 2024-09-16 11:42:17

UpdateLoad

UpdateShipmentsExport