Returns a list of all shipments that match the provided criteria and their tracking updates.Tracking statuses are not marked as exported by default, please use the Mark as exported endpoint to mark tracking statuses as exported.
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
LatestStatusOnly
boolean
optional
True if only the most recent tracking status should be returned.
Ids
array[string]
required
The ids of objects that should be updated.
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 GET 'https://ws.integration.banyantechnology.com/api/v3/tracking?Ids'
Responses
🟢200Success
application/json
Body
array of:
shipmentId
integer<int32>
optional
The Banyan shipment (load) id.
bol
string|null
optional
The BOL Number for the shipment.
proNumber
string|null
optional
The ProNumber for the shipment.
trackingStatuses
array[object (TrackingStatusDto) {14}] |null
optional
Any tracking statuses that belong to the shipment.
trackingStatusId
integer<int32>
optional
The id of the tracking entity. This can relate to either web or edi statuses, refer to BanyanWebServices.Domain.Dtos.Tracking.TrackingStatusDto.Type to determine which.
dateTime
string<date-time>
optional
The date and time that the tracking event occurred. If this was not provided by the carrier, it will be the time Banyan received the event. See .
timeZoneInfo
object(TimeZoneDto)
optional
Time zone information
type
string|null
optional
The type of tracking status. Web or EDI.
code
string
optional
The tracking code.
carrierMessage
string|null
optional
The actual carrier message for this tracking event.
banyanMessage
string|null
optional
The Banyan message for this tracking event.
city
string|null
optional
The city the event occurred in.
state
string|null
optional
The state the event occurred in.
countryCode
string|null
optional
The country the event occurred in.
zipCode
string|null
optional
The zip code the event occurred in.
latitude
number<double>|null
optional
The latitude the event occurred at.
longitude
number<double>|null
optional
The longitude the event occurred at.
dateTimeType
string|null
optional
If an actual date and time were provided from the carrier, this will be Carrier. Otherwise Banyan.