- Version 3
- Authentication
- Shipments
- Invoice
- Tracking
- StaticData
- Authentication
- Version 2
- Exports and Webhooks
DispatchLoad
POST
/services/api/rest/DispatchLoad
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
Username
string
required
Password
string
required
ClientRefNum
string | null
optional
LoadId
integer
required
SubmitPickup
boolean
required
DispatchOverride
boolean
required
LoadData
object
required
ProNumber
string
optional
BOLNumber
string
required
ActualCarrierName
string
optional
QuoteID
integer
required
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
Success
boolean
required
PickupNumber
string
optional
ProNumber
string
optional
UserMessage
string
optional
BOLLink
string
optional
Errors
array[string]
required
Example
{
"LoadId": 0,
"Success": true,
"PickupNumber": "string",
"ProNumber": "string",
"UserMessage": "string",
"BOLLink": "string",
"Errors": [
"string"
]
}
Modified at 2024-09-16 11:42:17