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

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Example

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

Modified at 2024-09-16 11:42:17

UnBookLoad

GetLoadDetails