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

AuthenticationData

#/definitions/3334519

required

LoadID

integer

required

Shipment's primary identifier (Banyan supplied)

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

Request samples

Responses

Success - OK(200)

Bad Request(400)

HTTP Code: 200

Content Type : JSONapplication/json

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

#/definitions/3334520

null

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

Last modified: 2 months ago