DispatchLoad - Banyan Technology LIVE Connect™

Request

Header Params

Content-Type

string

required

Example:

application/json

Accept

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

SubmitPickup

boolean

required

When true, a dispatch request will be sent to the carrier.

DispatchOverride

boolean

required

If dispatch fails with carrier, attempt the follow in order till success: - Attempt EDI 204 (Load Tender) - Attempt email to carrier - Move load into dispatched status, return note

LoadData

object

required

Specific load data.

ProNumber

string

optional

To update the shipment's pro number

BOLNumber

string

required

To update the shipment's BOL number

ActualCarrierName

string

optional

Carrier name of the requested quote

QuoteID

integer

required

Quote's primary identifier (Banyan supplied)

Example

{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":"",
   "SubmitPickup":"true",
   "DispatchOverride":"false",
   "LoadData":{
      "ProNumber":"",
      "BOLNumber":"",
      "ActualCarrierName":"",
      "QuoteID":""
   }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://ws.integration.banyantechnology.com/services/api/rest/DispatchLoad' \
--header 'Content-Type: application/json' \
--data-raw '{
   "AuthenticationData":{
      "Username":"",
      "Password":"",
      "ClientRefNum":""
   },
   "LoadID":"",
   "SubmitPickup":"true",
   "DispatchOverride":"false",
   "LoadData":{
      "ProNumber":"",
      "BOLNumber":"",
      "ActualCarrierName":"",
      "QuoteID":""
   }
}'

Responses

🟢200Success

application/json

Body

LoadId

integer

required

Banyan's primary Shipment Identifier

Success

boolean

required

Success of the dispatch request

PickupNumber

string

optional

Shipment's pickup number

ProNumber

string

optional

Shipment's pro number

UserMessage

string

optional

Carrier message

BOLLink

string

optional

Link to the shipment's BOL

Errors

array[string]

required

List of the errors returned during the attempted dispatch

Example

{
    "LoadId": 0,
    "Success": true,
    "PickupNumber": "string",
    "ProNumber": "string",
    "UserMessage": "string",
    "BOLLink": "string",
    "Errors": [
        "string"
    ]
}