Banyan Technology LIVE Connect™
  1. Exports and Webhooks
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
      • Other
        • Normalized Charge Codes
      • SOAP
    • Changelog
  • Exports and Webhooks
    • Standard Load Export - v1
    • Standard Load Export - v2
    • Standard Load Export - v3
    • Push Tracking
  1. Exports and Webhooks

Push Tracking

Push Tracking provides near real-time notifications regarding the status of a tracked shipment.
These events are triggered whenever there a tracking event is captured on a tracked shipment.
A Post request will be sent to your configured URL containing the request body below. A file can also be placed on an FTP Server.
Requests can be sent out as JSON or XML.
Basic Authentication can be configured for your endpoint or FTP Server.

Schema
JSON Example
XML Example
Tracking Event
Bol
string 
required
Shipment BOL number
Pro
string 
optional
Shipment pro number
LoadId
integer 
required
Banyan's primary Shipment Identifier
BanyanStatus
string 
required
Description of current status
Message
string 
required
The tracking status's EDI 214 message.
CarrierMessage
string 
required
The tracking status's message (carrier supplied)
StatusDate
string 
required
The tracking status's date and time (carrier supplied)
CapturedDate
string 
required
The date and time the event was captured.
CarrierScac
string 
required
Carrier standard carrier alpha code
EstimatedDelivery
string <date-time>
required
Estimated Delivery Date
ActualDelivery
string <date-time>
required
Actual Delivery Date
EstimatedPickup
string <date-time>
required
Estimated Pickup Date
ActualPickup
string <date-time>
required
Actual Pickup Date
Modified at 2024-09-16 11:42:18
Previous
Standard Load Export - v3
Built with