GetTrackingByLoad - 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

LoadIds

array[integer]

required

A list of one or more LoadIds

GetLastStatus

boolean

required

Only the last status will return

Example

{
  "AuthenticationData": {
    "Username": "",
    "Password": "",
    "ClientRefNum": ""
  },
  "LoadIds": [
    "34255933",
    "34256056",
    "55555555"
  ],
  "GetLastStatus": false
}

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/GetTrackingByLoad' \
--header 'Content-Type: application/json' \
--data-raw '{
"AuthenticationData": {
    "Username": "",
    "Password": "",
    "ClientRefNum":""
},
"LoadIds":["34255933","34256056", "55555555"],
"GetLastStatus": false
}'

Responses

🟢200GetTrackingByLoad

application/json

Body

Tracking

array [object {4}]

required

A list of Tracking statuses

LoadId

integer

required

Banyan's primary Shipment Identifier

BOL

string

required

Shipment's BOL number

ProNumber

string

required

Shipment's pro number

TrackingStatuses

array [object {7}]

required

List of tracking statuses

Errors

array[string]

required

A list containing any errors that occurred

Success

boolean

required

Whether request was successful

Example

{
  "Tracking": [
    {
      "LoadId": 34255933,
      "BOL": "2113600014",
      "ProNumber": "507530921",
      "TrackingStatuses": [
        {
          "DateTime": "2021-05-21T10:00:00",
          "Type": "WEB",
          "Code": "AA",
          "CarrierMessage": "Pickup window 5/21/2021 10:00:00 AM - 5/21/2021 5:00:00 PM",
          "BanyanMessage": "Pickup Appointment",
          "City": "",
          "State": ""
        },
        {
          "DateTime": "2021-05-21T16:34:00",
          "Type": "WEB",
          "Code": "SPU",
          "CarrierMessage": "PICKED UP",
          "BanyanMessage": "Shipment picked-up",
          "City": "",
          "State": ""
        },
        {
          "DateTime": "2021-05-22T01:37:00",
          "Type": "WEB",
          "Code": "P1",
          "CarrierMessage": "DEPARTED TERMINAL",
          "BanyanMessage": "Departed Terminal Location",
          "City": "",
          "State": ""
        },
        {
          "DateTime": "2021-05-22T04:14:00",
          "Type": "WEB",
          "Code": "X4",
          "CarrierMessage": "ARRIVED AT TERMINAL",
          "BanyanMessage": "Arrived at Terminal Location",
          "City": "",
          "State": ""
        }
      ]
    },
    {
      "LoadId": 34256056,
      "BOL": "2113600017",
      "ProNumber": "507530947",
      "TrackingStatuses": [
        {
          "DateTime": "2021-05-21T10:00:00",
          "Type": "WEB",
          "Code": "AA",
          "CarrierMessage": "Pickup window 5/21/2021 10:00:00 AM - 5/21/2021 5:00:00 PM",
          "BanyanMessage": "Pickup Appointment",
          "City": "",
          "State": ""
        },
        {
          "DateTime": "2021-05-21T16:34:00",
          "Type": "WEB",
          "Code": "SPU",
          "CarrierMessage": "PICKED UP",
          "BanyanMessage": "Shipment picked-up",
          "City": "",
          "State": ""
        },
        {
          "DateTime": "2021-05-22T01:37:00",
          "Type": "WEB",
          "Code": "P1",
          "CarrierMessage": "DEPARTED TERMINAL",
          "BanyanMessage": "Departed Terminal Location",
          "City": "",
          "State": ""
        },
        {
          "DateTime": "2021-05-22T04:14:00",
          "Type": "WEB",
          "Code": "X4",
          "CarrierMessage": "ARRIVED AT TERMINAL",
          "BanyanMessage": "Arrived at Terminal Location",
          "City": "",
          "State": ""
        }
      ]
    }
  ],
  "Errors": [
    "Load 55555555 does not exist for this user."
  ],
  "Success": true
}