FarEye API
FarEye is an AI-powered delivery management platform that orchestrates last-mile logistics across the order-to-door lifecycle for enterprise shippers, retailers, and carriers. An unofficial API lets you programmatically pull orders, shipments, routes, tracking events, and delivery status—and push updates like new shipments, route plans, dispatch assignments, and delivery confirmations back into FarEye.
What is FarEye?
FarEye is an AI-powered delivery management platform that helps enterprise shippers, retailers, and carriers optimize last-mile logistics across the complete order-to-door lifecycle. Customers use FarEye to forecast capacity, plan and optimize routes, run multi-carrier shipping, dispatch and execute deliveries, track shipments in real time, and manage the end-customer delivery experience—delivered through a low-code, microservices-based platform.
Core product areas include:
- Ship (multi-carrier shipping and rate shopping)
- Route and Plan (route planning, optimization, and territory planning)
- Track (real-time last-mile tracking and visibility)
- Execute (delivery execution and driver dispatch)
- Experience (delivery experience management and customer slot booking)
- Analyze (analytics and reporting across delivery operations)
Common data entities:
- Orders, Shipments, Consignments, Parcels
- Routes, Trips, Stops, Delivery Slots
- Drivers, Vehicles, Fleet, Hubs
- Carriers, Rates, Manifests, Labels
- Tracking Events, Proof of Delivery, Exceptions
- Customers, Addresses, Delivery Notifications
The FarEye Integration Challenge
Enterprises run mission-critical delivery operations on FarEye, but turning a configurable, multi-tenant logistics platform into reliable API-driven automation is non-trivial:
- Per-tenant configuration: Workflows, statuses, and entity models are tailored with FarEye's low-code drag-and-drop framework, so generic integrations break across customers
- Developer portal gating: API access on developer.fareyeconnect.com requires credentials and onboarding before endpoints are exposed
- Multi-carrier sprawl: Rate shopping, label generation, and tracking span many downstream carriers, each with its own identifiers and status codes to normalize
- Real-time tracking volume: High-frequency tracking and exception events need durable webhook handling and de-duplication to stay consistent
- Driver and field data: Proof-of-delivery, signatures, and scans originate from mobile execution apps that are awkward to reach programmatically
- Endpoint variability: API coverage differs by module (Ship, Route, Track, Execute) and by the customer's enabled product mix
How Supergood Creates FarEye APIs
Supergood reverse-engineers authenticated browser flows and FarEye's developer-portal APIs to deliver a resilient API layer for your FarEye tenant—across Ship, Route, Track, and Execute.
- Handles API key and username/password plus MFA authentication securely
- Maintains session continuity with automated refresh and change detection
- Normalizes responses across Orders, Shipments, Routes, and Tracking so you integrate once and rely on consistent objects
- Aligns with tenant-specific workflow configuration, custom fields, and carrier mappings to ensure accurate data
Use FarEye with AI agents: FarEye MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your modules, carrier mix, and authentication model.
- Supergood Generates and Validates Your API
We deliver a hardened FarEye adapter tailored to your tenant configuration and enabled products.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as FarEye evolves.
API Endpoints
Authentication
/authenticateAuthenticate to a FarEye tenant using an API key or username/password and obtain a session token for downstream calls.
Orders
/ordersList orders and consignments with filters for status, hub, customer, and delivery date range.
Shipments
/create_shipmentCreate a shipment from an order, run multi-carrier rate shopping, and generate a label and manifest.
Routing
/routesRetrieve planned and optimized routes, trips, and stops with driver and vehicle assignments.
Routing
/create_routeGenerate an optimized route plan for a set of orders against fleet capacity, time windows, and delivery slots.
Tracking
/trackingPull real-time tracking events, delivery status, exceptions, and proof of delivery for a shipment or order.
Use Cases
Sync order and shipment data into your stack
- Pull orders, consignments, and shipments from FarEye into a single warehouse - Stream tracking and exception events to downstream BI and customer-experience tools - Reconcile carrier, rate, and label records across your order-to-door lifecycle
Automate route planning and dispatch
- Push orders into Route and pull optimized trips and stops back for fleet systems - Assign drivers and vehicles to routes without portal clicks - Surface capacity shortfalls and delivery-slot conflicts to planning workflows
Power real-time delivery tracking experiences
- Subscribe to tracking and status events to drive branded customer notifications - Pull proof of delivery, signatures, and scans for post-delivery workflows - Route delivery exceptions and failed attempts to support and retention systems
Run multi-carrier rate shopping and labeling
- Trigger rate shopping across carriers and select the best service per shipment - Generate labels and manifests programmatically at checkout or fulfillment - Reconcile carrier invoices against booked rates and delivered shipments
Technical Specifications
Authentication
API key and username/password plus MFA handled in a managed session
Connectivity
Authenticated browser flows plus FarEye's developer-portal APIs surfaced through developer.fareyeconnect.com where exposed by the tenant
Response format
Normalized JSON across Orders, Shipments, Routes, and Tracking objects
Rate limits
Adaptive throttling tuned to your tenant to avoid platform-side limits
Session management
Automatic session refresh, token rotation, and MFA replay handling
Data freshness
Near real-time pulls for orders, shipments, and tracking with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for order creation, shipment dispatch, tracking updates, and delivery exceptions
Latency
Sub-second reads on cached entities; multi-second writes when posting through routing and labeling workflows
Throughput
Horizontally scaled workers sized to high-volume last-mile delivery operations
Reliability
Retry, backoff, and idempotency keys for shipment creation, route plans, and status updates
Adaptation
Continuous monitoring of FarEye releases, carrier changes, and tenant-specific configuration drift
Frequently asked questions
Supergood profiles your tenant against its enabled products and normalizes data across Ship, Route, Track, and Execute, so orders, shipments, routes, and tracking are exposed through one consistent API surface regardless of which modules you run.
No. Supergood works with your existing FarEye credentials and authenticated sessions. Where your tenant exposes developer-portal APIs we use them, and we cover the gaps through authenticated browser flows.
Carrier identifiers, rate structures, and tracking status codes are normalized into a single schema, so rate shopping, label generation, and tracking look consistent regardless of which carrier fulfills the shipment.
Yes. Supergood provides event-style webhooks for order creation, shipment dispatch, tracking updates, and delivery exceptions, with de-duplication so high-frequency tracking stays consistent.
FarEye's low-code framework means each tenant configures its own statuses, fields, and workflows. Supergood preserves those tenant-specific fields and lifecycle states rather than forcing a generic schema.