GetTrackingStatuses - Banyan Technology LIVE Connect™

This function will return all the tracking statuses for all the clients under your web service user’s super user group. Tracking statuses can either be gathered by Banyan’s automated tracking process or EDI 214 process.

Each status will only be exported once. The carrier message returned in the response is directly from the carrier and is simply parsed by Banyan. Banyan does not make any adjustments to that message

Request

Header Params

Content-Type

string

required

Example:

application/json

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

Example

{
  "Username": "",
  "Password": "",
  "ClientRefNum": ""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200GetTrackingStatuses

application/json

Body

TrackingStatuses

array [object {9}]

optional

A list of tracking statuses

LoadId

integer

required

Banyan's primary Shipment Identifier

BOL

string

required

Shipment's BOL number

ProNumber

string

optional

Shipment's pro number

DateTime

string <date-time>

optional

The tracking status's date and time (carrier supplied)

Code

string

required

The tracking status's EDI 214 code

CarrierMessage

string

optional

The tracking status's message (carrier supplied)

BanyanMessage

string

required

The tracking status's EDI 214 message.

City

string

optional

The tracking status's current city (carrier supplied)

State

string

optional

The tracking status's current state (carrier supplied)

Success

boolean

required

Success of the cancel request

Error

string | null

optional

Error message supplied when request fails

Example

{
  "TrackingStatuses": [
    {
      "LoadID": 12345678,
      "BOL": "3000555567",
      "ProNumber": "207000555",
      "DateTime": null,
      "Code": "T1",
      "CarrierMessage": "En route to interim Bismarck, ND ",
      "BanyanMessage": "In Transit",
      "City": "Bismarck",
      "State": "ND"
    },
    {
      "LoadID": 87654321,
      "BOL": "3000123456",
      "ProNumber": "207555000",
      "DateTime": null,
      "Code": "T2",
      "CarrierMessage": "En route to destination Lumberton, NC ",
      "BanyanMessage": "En Route to Delivery Location",
      "City": "Lumberton",
      "State": "NC"
    }
  ],
  "Success": true,
  "Error": null
}