Banyan Technology LIVE Connect™
  1. Additional Tracking
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
      • Load Details
        • GetLoadDetails
        • GetNotes
      • Additional Tracking
        • GetTrackingByLoad
          POST
      • 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 Tracking

GetTrackingByLoad

POST
/services/api/rest/GetTrackingByLoad
Used for retrieving tracking details about specific Loads.

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
Request Request Example
Shell
JavaScript
Java
Swift
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
}
Modified at 2024-09-16 11:42:17
Previous
GetNotes
Next
Normalized Charge Codes
Built with