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

string

required

Example:

application/json

Body Params application/json

AuthenticationData

object (Authentication Data)

required

Banyan Credentials

Username

string

required

Banyan Username

Password

string

required

Banyan Password

ClientRefNum

string | null

optional

Client Reference Number - Used during multiple client integrations

LoadId

integer

required

Banyan's primary Shipment Identifier

NewStatus

enum<string>

required

The new status for the shipment provided

Allowed values:

PendingOpenQuotedBookedDispatchedIn TransitDeliveredCanceled

Example

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

Request 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

LoadId

integer

required

Banyan's primary Shipment Identifier

Success

boolean

required

Success of the request

Error

optional

Error message supplied when request fails

Any of

ErrorObject

null

Message

string

required

Example

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

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

UpdateLoad

UpdateShipmentsExport