Banyan Technology LIVE Connect™
  1. Additional Dispatching
Banyan Technology LIVE Connect™
  • Version 3
    • Authentication
      • Retrieve a token
    • Shipments
      • Creating
        • Create a Full Shipment
        • Create an EZ Rate Shipment
      • Updating
        • Add Document(s) to a Shipment
        • Update a Shipment
        • Adds one or more Reference Numbers to a Shipment
        • Mark as Exported
      • Retrieving
        • Get a Shipment
        • Get multiple Shipments
        • Get Quotes
        • Get Reference Numbers for a Shipment
        • Get documents for the specified shipment.
      • Booking
        • Book a Shipment
        • Unbooks the awarded quote on the specified load.
      • Canceling
        • Cancels a shipment.
    • Invoice
      • Get multiple invoices
      • Mark as Exported
    • Tracking
      • Get tracking statuses
      • Mark as exported.
    • StaticData
      • Accessorials
      • Document Types
      • Equipment Types
      • Package Types
      • Limited Access Types
      • Size UOMs
      • Weight UOMs
      • Pay Types
      • Ship Types
      • Countries
      • Statuses
      • Service Modes
  • Version 2
    • Recommended Workflow
      • Rating
        • ImportForQuote
        • ImportForQuote_Sync
        • GetQuotes
      • Booking/Dispatching
        • BookLoad
      • Tracking
        • GetTrackingStatuses
      • Documents
        • GetDocuments
      • Invoices
        • GetInvoices
        • GetInvoicesWithLoadDetails
    • Additional Offerings
      • Cancelling
        • Cancel a Load
      • Updating
        • UpdateLoad
        • UpdateLoadStatus
        • UpdateShipmentsExport
      • Importing
        • PendingImport
        • ImportForBook
      • Manual Quotes
        • AddManualQuote
      • EZ Rates
        • EzRate
        • EzRate_Sync
      • Waterfall Tendering
        • StartWaterfallTendering
        • CancelWaterfallTendering
      • Unbooking
        • UnBookLoad
      • Additional Dispatching
        • DispatchLoad
          POST
      • Load Details
        • GetLoadDetails
        • GetNotes
      • Additional Tracking
        • GetTrackingByLoad
      • Other
        • Normalized Charge Codes
      • SOAP
    • Changelog
  • Exports and Webhooks
    • Standard Load Export - v1
    • Standard Load Export - v2
    • Standard Load Export - v3
    • Push Tracking
  1. Additional Dispatching

DispatchLoad

POST
/services/api/rest/DispatchLoad
This function will move a shipment to dispatched status. Communication to the carrier is controlled with the SubmitPickup but within the request. When set to true, a pickup request will be sent to the selected carrier, and when it is set to false the shipment will be moved into dispatched status.

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
Request Request Example
Shell
JavaScript
Java
Swift
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"
  ]
}
Modified at 2024-09-16 11:42:17
Previous
UnBookLoad
Next
GetLoadDetails
Built with