UnBookLoad - Banyan Technology LIVE Connect™

This function will unbook a shipment in Banyan only.
This request has no communication with the carrier.

This function is not to be used when the shipment has been dispatched.

This will only move a shipment back into the quoted status, for purposes to book another available quote related to the shipment.

Request

Header Params

Content-Type

string

required

Example:

application/json

string

optional

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

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200UnBookLoad - 200 OK

application/json

Body

LoadId

integer

required

Banyan's primary Shipment Identifier

Success

boolean

required

Success of the unbook request

Error

object (ErrorObject)

required

Error message supplied when request fails

Message

string

required

Example

{
  "LoadId": 39626987,
  "Success": true,
  "Error": {
    "Message": "Sequi laborum sunt nostrum incidunt quasi quam fuga. Debitis in reprehenderit illo ex cum. Debitis eaque blanditiis ea tempora id ad. Sed ut deleniti esse culpa praesentium possimus modi."
  }
}