Transit API

The Transit API allows you to calculate estimated delivery times (ETAs) for consignments based on the chosen carrier service, pickup date, and origin/destination locations. It uses Cario’s carrier configuration, location data, historical performance, and ETA management rules to produce accurate and transparent ETA outcomes. 

Overview 

The Transit API provides up to three ETA scenarios for each shipment: 

1. Carrier ETA 
   ETA calculated directly from the carrier’s standard transit rules. 
2. Likely ETA 
   ETA calculated from Cario’s historical consignments for similar routes. 
3. Adjusted ETA 
   ETA after applying Cario’s ETA management rules such as weekends and public holidays. 

These scenarios give you a clearer view of both expected and real-world transit performance. 

 

Available Endpoints 

The Transit API includes three endpoints, each returning different levels of detail. 

1. Get Transit Details
   Returns full transit information including ETA dates, transit days, weekends, holidays, and more.
   
2. Get Transit Days
   Returns only the number of working transit days for each ETA scenario. 
   
3. Get ETA Dates
   Returns the three ETA dates (Carrier, Likely, Adjusted). 
   

All endpoints require API version 3. 

Prerequisites 

Before calling the Transit API: 

• You must be logged in so your session is authenticated. 

• You must use the v3 route. 

• Carrier and service codes must exist in your Cario configuration. 

• Pickup and delivery addresses must be valid. 
  You can use the Address Validation API to confirm locations beforehand. 

Required Inputs 

All Transit API endpoints use the same required query parameters. 

• Carrier & Service 

  carrierCode 

  serviceCode 

• Pickup Location 

  fromLocality 

  fromPostCode 

  fromCountry 

• Delivery Location 

  toLocality 

  toPostCode 

  toCountry 

• Pickup Details 

  pickupDate (format: yyyy-MM-dd) 

• API Version 

  version (must be 3) 

Get Transit Details 

Returns the full breakdown of transit calculations for a carrier service. 

Endpoint 
GET /api/v3/Transit/GetTransitDetails 

What It Returns 

• Pickup date and service details 

• Carrier, likely, and adjusted transit calculations 

• Estimated delivery date (etaDate) 

• Shipping days (calendar days) 

• Working transit days 

• Weekend days 

• Public holidays 

Key Response Fields 

etaDate – Final estimated delivery date 
shippingDays – Calendar days from pickup to delivery 
transitDays – Working days from pickup to delivery 
weekendDays – Weekend days in the delivery window 
holidays – Public holidays affecting the route 

Each transit scenario (Carrier, Likely, Adjusted) includes its own calculation breakdown. 

Get Transit Days 

Returns only the number of working transit days for each ETA scenario. 

Endpoint 
GET /api/v3/Transit/GetTransitDays 

What It Returns 

carrierTransitDays 
likelyTransitDays 
adjustedTransitDays 

Useful when you need transit duration without specific delivery dates. 

Get ETA Dates 

Returns the carrier, likely, and adjusted estimated delivery dates. 

Endpoint 
GET /api/v3/Transit/GetEtaDates 

What It Returns 

carrierEtaDate 
likelyEtaDate 
adjustedEtaDate 

Ideal for displaying delivery expectations without full transit details. 

When to Use the Transit API 

Use the Transit API for: 

• Quoting and checkout ETA display 

• Comparing carrier ETAs vs historical performance 

• Improving customer delivery visibility 
• Operational planning and dispatch coordination