Cancel a Load

POST

/services/api/rest/CancelLoad

This function will cancel a shipment. This request has no communication with the carrier. This function is not to be used when the shipment has been dispatched.
This will only cancel the shipment in Banyan.

Request

Header Params

Content-Type

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

Shipment's primary identifier (Banyan supplied)

Example

{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":""
}

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/CancelLoad' \
--header 'Content-Type: application/json' \
--data-raw '{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":""
}'

Responses

🟢200Success - OK

application/json

Body

LoadID

integer

optional

Shipment's primary identifier (Banyan supplied)

Success

boolean

optional

Indicates whether the load operation was successful or not

Error

optional

If an error occurred during the load operation, this field provides additional information about the error.

Any of

ErrorObject

null

Message

string

required

Example

{
    "LoadID": 12345678,
    "Success": true,
    "Error": null
}

🟠400Bad Request

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

GetInvoicesWithLoadDetails

UpdateLoad