UnBookLoad

POST/services/api/rest/UnBookLoad

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

AuthenticationData

#/definitions/3334519

required

Banyan Credentials

LoadId

integer

required

Banyan's primary Shipment Identifier

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

Request samples

Responses

UnBookLoad - 200 OK(200)

UnBookLoad - 200 OK

HTTP Code: 200

Content Type : JSONapplication/json

LoadId

integer

required

Banyan's primary Shipment Identifier

Success

boolean

required

Success of the unbook request

Error

#/definitions/3334520

required

Error message supplied when request fails

{
  "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."
  }
}

Last modified: 2 months ago