Use Case Overview
A large logistics company requires real-time visibility for truckload operations. Visibility enables shippers and stakeholders to track deliveries at different levels, ensuring transparency in logistics movements.
Note: OneRail supports visibility tracking but does not provide routing services.
In this structure:
- shipmentId → Represents the customer designator for the entire truckload.
- orderId → Represents a customer order on the truckload.
Implementation Steps
Setup Visibility Using OneRail API
Create a Visibility Delivery
Use the /visibility/create
endpoint to initialize visibility tracking for the truckload.
Minimum required fields:
-
orderId
→ Unique identifier for a customer order -
SCAC
→ Standard Carrier Alpha Code identifying the carrier
If truckload-level visibility is required, a shipmentId
should also be included.
For further information on this endpoint, refer to the following Swagger reference: Create Visibility.
Add Individual Deliveries
Each delivery within the truckload can also be added individually using /visibility/{orderId}/add-deliveries
.
For further information on this endpoint, refer to the following Swagger reference: Add Deliveries to Visibility.
Real-Time Event Tracking
Leverage visibility events to keep stakeholders updated.
- PICKED_UP → The truckload is loaded at the origin.
- EN_ROUTE_TO_DELIVERY → The truck is in transit to the destination.
- DELIVERED → The order has been successfully delivered.
- GEO → Sends real-time GPS location updates when supported.
Example Event Update (POST /visibility/{orderId}/event):
{ "eventType": "PICKED_UP", "orderId": "MasterBOL123", "eventOn": "2025-02-01T08:00:00Z" }
Comments
0 comments
Please sign in to leave a comment.