TrackingDetails - Retrieve all the tracking details related to a shipment
POST
/shipmenttracking/shipmentstatusdetailLast modified: 19 days ago
The Shipment Tracking API endpoint retrieves all tracking statuses for a single shipment, using various search options such as Bill of Lading, Purchase Order, ProNumber/InvoiceNumber, or Load Number.
Input Parameters:
Authentication:
userName
,clientCode
, andAuthenticationID
confirm user access.
Search Criteria:
carrierCode
: Specifies the carrier for the shipment.searchType
: Defines the type of search, with options:BL
for Bill of LadingPO
for Purchase OrderPR
for ProNumber or InvoiceNumberLD
for Load Number
searchValue
: The specific identifier value for the selectedsearchType
.
Output Structure:
- ErrorMessage: Provides details if an error occurs.
- Details: An array where each entry provides detailed tracking information for the shipment, including:
Shipment Identifiers:
Pro
,BlNumber
,ReferenceNumber
,Scac
(carrier’s SCAC code), andCarrier
name.
Shipper, Consignee, and Billing Details:
- Shipper information (
ShipperCode
,ShipperName
,ShipperAddress
,ShipperCity
,ShipperState
,ShipperZip
). - Consignee information (
ConsigneeCode
,ConsigneeName
,ConsigneeAddress
,ConsigneeCity
,ConsigneeState
,ConsigneeZip
). - Billing information (
BillToCode
,BillToName
,BillToAddress
,BillToCity
,BillToState
,BillToZip
).
- Shipper information (
Shipment Status:
TransactionDate
,StatusDate
,StatusTime
,StatusTimeCode
, andStatusMessage
provide timestamps and messages for each status.ReasonMessage
for any status-related reasons.AppointmentMessage
andAppointmentReasonMessage
for appointment specifics.
Additional Information:
LocationCity
,LocationState
for the shipment’s current location.Weight
of the shipment.
This endpoint offers a comprehensive history of status updates for a single shipment, allowing users to monitor each stage of the shipment in detail.
Request
Body Params application/json
No schema defined
Example
Not configured
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
OK
Data Schema
No schema defined
Example
Not configured