Freight Forwarders
Streamline multi-modal logistics with CHRT’s comprehensive API
Freight forwarders coordinate complex shipments between shippers and multiple courier networks. CHRT’s API enables you to manage these multi-party logistics operations efficiently, from organization setup to real-time tracking.
Quick Start
- Create Account: Sign up at chrt.com
- Get API Access: Contact us to obtain your Bearer token
- Set Base URL: Use
https://api.chrt.com
for production
Core Workflows
Organization Management
Set up your freight forwarding organization and connect with shippers and couriers in your network.
Create Your Organization
View Available Shippers
Find shippers looking for freight forwarding services:
Returns shippers seeking courier partners in your service areas.
View Available Couriers
Find courier networks and their capabilities:
Returns courier networks available for partnership and their service capabilities.
List Members of Organization
Manage team members and their roles within your organization:
Returns current organization members with their roles and permissions.
Example Response:
Order Management
Create and manage complex multi-modal shipments with comprehensive tracking and documentation.
Order Structure Overview
CHRT orders are built with a hierarchical structure optimized for freight forwarding:
- Order: Top-level container with routing and dispatch information
- Task Groups: Logical groupings of related operations (e.g., origin handling, transit, destination handling)
- Tasks: Individual actions within each group (pickup, transfer, delivery, etc.)
- Cargos: Physical items with detailed specifications
- Milestones: Proof points and documentation requirements
Create Standard Orders
Basic Order Creation
Essential Order Components:
- Order Metadata - Basic order information and routing
- Task Groups - Organized sequences of operations
- Cargo Specifications - Detailed item descriptions and dimensions
- Dispatch Configuration - Transport type and courier assignment
- Notification Setup - Stakeholder communication preferences
Standard Order Example:
Order Configuration Options
Dispatch Types:
dtc
(Direct to Customer) - Direct delivery to end recipientff
(Freight Forwarder) - Handoff to freight forwarder for further routingself
(Self-service) - Self-managed logistics
Transport Types:
ground_only
- Road transportation onlypassenger_flight
- Commercial passenger flightcargo_flight
- Dedicated cargo flightchartered_flight
- Private chartered flightonboard_courier
- Courier accompanies cargo
Cargo Classification:
medical_devices
- Medical equipment and devicespharmaceuticals
- Temperature-sensitive medicationslab_specimen
- Lab samples requiring special handlingorgan
- Transplant organs with time-critical deliverytissue
- Biological tissue samplesblood
- Blood products and componentsperishable
- Time-sensitive perishable goodsfrozen
- Frozen goods requiring temperature controlhazardous_materials
- Materials requiring special permitsmanufacturing_equipment
- Industrial machineryaircraft_parts
- Aviation components requiring certified handlingelectronics
- Sensitive electronic devicesdocuments
- Important legal or business documentsspare_parts
- Replacement parts and componentschemicals
- Chemical products requiring special handling
Task Actions for Freight Forwarding
Primary Actions:
pickup
- Initial collection from origin locationdeliver
- Final delivery to destinationtransfer
- Handoff between carriers or modesconsolidate
- Combine multiple shipmentstender
- Hand over to another partyrecover
- Retrieve from temporary storagehold
- Temporarily store cargoother
- Custom action
Milestone Types for Documentation
Proof of Service:
image
- Photo documentationsignature
- Signature collectionbarcode_scan
- Barcode scanningqr_code_scan
- QR code scanning
Status Tracking:
user_action
- Manual user actiondetected_by_app
- Automatic app detectionorder_in_progress
- Order status milestoneother
- Custom milestone
Order Response and Tracking
Order Creation Response:
Key Tracking Identifiers:
order_id
- Unique system identifierorder_short_id
- Human-readable referencetask_group_ids
- Task group referencestask_ids
- Individual task referencesmilestone_ids
- Milestone references
Multistop Orders & Flight Management
Handle complex multistop scenarios including air freight, NFO (Next Flight Out), and OBC (On-Board Courier) services with comprehensive tracking and documentation.
Air Freight Service Types
Service Classification:
- Standard Air Freight - Regular scheduled cargo service
- NFO (Next Flight Out) - Expedited service on next available flight
- OBC (On-Board Courier) - Dedicated courier accompanies shipment
- Chartered Flight - Private aircraft for exclusive use
NFO (Next Flight Out) Orders
Service Overview:
- Time-critical shipments requiring immediate air transport
- Priority handling and expedited processing
- Real-time flight tracking and status updates
- Ideal for: Medical emergencies, urgent parts, time-sensitive documents
NFO Order Configuration:
OBC (On-Board Courier) Orders
Service Overview:
- High-value, time-critical shipments with dedicated courier
- Hand-carry service for maximum security
- Continuous chain of custody throughout transit
- Ideal for: High-value items, organs, sensitive documents, cash
OBC Order Configuration:
Flight Management Features
Task Actions for Flight Operations:
pickup
- Initial collection from origintransfer
- Handoff at airport/terminalconsolidate
- Combine shipments for flighttender
- Airport pickup from flightrecover
- Retrieve from temporary storagedeliver
- Final delivery to destination
Flight Information Management:
- Include
flight_number
in task comments for tracking - Use
arrive_by
andarrive_at
for flight timing - Set up milestone notifications for flight status updates
- Configure real-time flight tracking alerts
Best Practices for Flight Management
1. Flight Tracking & Monitoring
- Monitor flight status in real-time through API endpoints
- Set up automated notifications for delays or cancellations
- Have backup flight options ready for critical shipments
- Track weather conditions and airport status
2. Documentation & Compliance
- Ensure all customs documentation is complete and accurate
- Verify cargo declarations and permits before departure
- Maintain chain of custody records throughout transit
- Prepare contingency documentation for delays
3. Timing Coordination
- Allow sufficient buffer time for airport transfers (minimum 2-3 hours)
- Coordinate with ground transportation at both origin and destination
- Plan for customs clearance time at international destinations
- Account for time zone differences in scheduling
4. Communication & Escalation
- Keep all stakeholders informed of flight status changes
- Provide real-time updates during transit via milestone notifications
- Establish clear escalation procedures for exceptions and delays
- Maintain contact information for all parties involved
5. Risk Management
- Implement temperature monitoring for sensitive cargo
- Set up insurance coverage for high-value shipments
- Establish backup courier networks for critical routes
- Monitor security requirements for sensitive destinations
Tracking & Monitoring
Monitor shipments across your entire network with comprehensive tracking data.
View All Orders (Basic)
Returns basic order information for quick overview.
View All Orders (Detailed)
Returns complete order details including:
- Task groups and individual tasks
- Milestone tracking with timestamps
- Driver and vehicle information
- Real-time location updates
Get Specific Order Details
Get comprehensive tracking data for customer updates and exception handling.
View Orders by Courier
Monitor orders assigned to specific courier networks.
Task Management
Manage the execution of orders through task groups and milestones.
View Task Groups by Courier
Get task groups with their tasks for a specific courier.
View Task Groups (Detailed)
Get task groups with tasks, milestones, and cargo details.
Update Task Groups
Update task status and progress as shipments move through your network.
Milestone Tracking
Track progress and provide proof of delivery through milestones.
Update Milestones
Update delivery progress with milestone types:
pickup_arrival
- Driver arrives at pickup locationpickup_complete
- Cargo loaded and securedin_transit
- En route to destinationdelivery_arrival
- Driver arrives at delivery locationdelivery_complete
- Cargo delivered successfully
Upload Proof of Delivery
Upload photos for:
- Signature confirmations
- Cargo condition documentation
- Delivery location verification
- Incident reports
Retrieve Delivery Documentation
Access uploaded proof of delivery documentation.
Notification Management
Configure comprehensive notification preferences to keep all stakeholders informed with automated updates across multiple channels.
Notification Channels
CHRT supports four notification channels for maximum flexibility:
- Email - Detailed notifications with documentation and tracking links
- SMS - Urgent updates for time-critical events
- Push - Real-time mobile notifications for immediate awareness
- Phone Call - Voice notifications for critical exceptions
Task Actions for Notifications
Configure notifications for specific task actions:
Standard Actions:
pickup
- Cargo pickup eventsdeliver
- Delivery completiontransfer
- Cargo handoffs between partiesconsolidate
- Shipment consolidationtender
- Cargo tendering to carriersrecover
- Cargo recovery from storagehold
- Cargo placed on holdother
- Custom actions
Advanced Air Freight Actions (OBC/NFO):
- Flight Operations -
cargo_booked_with_airline
,flight_checkin_completed
- Airport Handling -
courier_arrived_at_airport
,courier_thru_security
- Flight Tracking -
courier_boarded_flight_1
,flight_1_departed
,flight_1_arrived
- Customs & Recovery -
courier_thru_customs
,courier_recovered_cargo
Get Current Notification Preferences
Returns current notification configuration for your organization.
Configure Notification Preferences
Comprehensive Notification Configuration:
Task-Level Notification Overrides
Specify notification recipients for individual tasks during order creation:
Notification Best Practices
Channel Selection Strategy:
- SMS - Use for urgent events (pickup, delivery, exceptions)
- Email - Use for detailed updates and documentation
- Push - Use for real-time mobile notifications
- Voice - Use for critical exceptions requiring immediate attention
Configuration Recommendations:
- Multiple Recipients - Include backup contacts for redundancy
- Action-Specific Channels - Match urgency to notification method
- Task-Level Overrides - Use for specific stakeholders or urgent shipments
- Regular Updates - Keep contact information current as teams change
Example Configuration for Medical Logistics:
Advanced Features
Multi-Modal Logistics
For complex routes involving multiple transport modes:
- Create order segments for each transport mode (ground, air, ocean)
- Use task groups to organize sequential operations and transfers
- Set up milestone notifications at critical transfer points
- Monitor each segment independently for optimal visibility
- Coordinate timing between different carriers and modes
Specialized Cargo Handling
Temperature-Controlled Shipments:
- Use
cargo_type: "pharmaceuticals"
or"frozen"
- Include temperature requirements in task comments
- Set up milestone notifications for temperature alerts
- Monitor cold chain compliance throughout transit
Hazardous Materials:
- Use
cargo_type: "hazardous_materials"
- Ensure proper documentation and permits
- Configure immediate notifications for incidents
- Verify courier certifications for hazmat transport
High-Value Items:
- Use detailed cargo descriptions and accurate dimensions
- Set up frequent milestone updates for security
- Configure multi-channel notifications for all parties
- Consider insurance requirements and documentation
SDKs & Integration
Use our official SDKs for faster integration:
TypeScript:
See our SDK documentation for detailed examples and advanced configuration options.
Best Practices
- Always specify accurate cargo dimensions for proper capacity planning and cost optimization
- Use detailed contact information for each organization to ensure smooth communications
- Set up proactive notifications for all stakeholders to reduce inquiries and improve transparency
- Monitor order status regularly using full order endpoints for complete visibility
- Keep organization information updated as contacts and capabilities change
- Coordinate timing carefully for multi-modal shipments to avoid delays and additional costs
- Document special requirements clearly in task comments for proper handling
- Establish clear escalation procedures for exceptions and delays
Support
- API Reference: Full endpoint documentation with examples
- SDK Documentation: Integration guides and examples
Need help with a specific integration? Contact our support team.