General
Locus API Integrations: How Enterprise Logistics Operations Connect Their Tech Stack
Aug 10, 2026
12 mins read

Key Takeaways
- Locus exposes three published REST API surfaces: an order API for the order lifecycle, a delivery and master-data API covering locations, line items, transporters, riders, vehicles and rosters, and a platform API for personnel and teams. All are specified in OAS 2.0.
- Asynchronous updates are delivered through configurable callbacks with event-type filtering, not a webhook subscription catalogue. The distinction matters when scoping an integration, because the configuration model is different.
- Two properties in the object model are unusual and worth knowing before you scope: order creation and planning can be invoked together, and delivery-window feasibility is exposed as an API call rather than assumed internally.
- Geocoding is modeled explicitly, with provider, confidence, and accuracy metadata on the order object. That makes address quality visible to your systems rather than a hidden dependency.
Why Integration Depth Decides Deployment Outcomes
Enterprise logistics has always been a multi-system environment, and the count has grown. A large 3PL may connect a WMS, an ERP, a TMS, an OMS, several carrier interfaces, a customer-facing tracking layer, and a BI platform, each with its own data model and update cadence.
Every connection is a potential failure surface, and latency at any point propagates. An order not injected in real time produces a dispatch plan built on a stale order set. A delivery exception not surfaced back to the OMS leaves a customer record showing “in transit” after the delivery has failed.
The practical consequence is that integration depth, rather than platform features, usually determines whether a deployment delivers what was projected. This guide covers what the Locus API actually exposes, how asynchronous events are delivered, eight integration patterns, and how to choose between API, EDI, and iPaaS approaches.
The Locus Integration Architecture
Three API Surfaces
Locus publishes three REST API surfaces rather than one. Knowing this before scoping matters, because they authenticate and are addressed separately.
| Surface | Base URL | Scope |
|---|---|---|
| Order API | oms.locus-api.com/v1 | Order lifecycle: create, retrieve, park, cancel, open, complete, reschedule, inventory verification, serviceability and slots, service types |
| Delivery and master data API | locus-api.com/v1 | Locations, line items, transporters, riders, vehicles, vehicle models, rider personas, rosters, homebases, shift tags |
| Platform API | platform.locus-api.com/v1 | Personnel and team administration |
All three are specified in OAS 2.0, which means the specification can be imported into standard tooling for client generation and contract testing.
What the Order API Exposes
The order lifecycle is addressed at /client/{clientId}/order/{orderId}, with operations to create and retrieve an order and to park, cancel, open, complete, or reschedule it. Inventory verification is a distinct operation on the same resource. Bulk equivalents exist across the object model, alongside filtering, sorting, and pagination structures.
Two capabilities in this surface are less common in delivery platforms and worth calling out.
Order creation and planning can be invoked together. The object model includes batch-and-plan operations and incremental planning requests, which means submitting orders can trigger route planning in the same interaction rather than requiring a separate planning call. For an integration, that collapses two round trips into one and removes a synchronization step.
Delivery-window feasibility is an API call. A slots operation returns available future slots for a given order, and the model includes promise retrieval, promise confirmation, promise update, and serviceability maps. This is the capability that allows a storefront or OMS to validate a delivery window against operational feasibility at the point of order capture rather than asserting one and discovering later that it cannot be held.
What the Delivery and Master Data API Exposes
Master data is addressed as individual resources with consistent patterns: retrieve, create, and disable, at /client/{clientId}/{entity}/{entityId}. Covered entities include locations, line items, transporters, riders, vehicles, vehicle models, rider personas, homebases, and shift tags.
Roster management is included, with a bulk auto-create operation documented specifically for API-integrated clients, which is relevant if driver or rider scheduling originates in your HR or workforce system rather than in Locus.
What the Platform API Exposes
Personnel and team administration: creating personnel with a compact request, updating personnel status, and retrieving, creating, and updating teams. This is the surface to use if user provisioning is driven from an identity provider or HR system.
Authentication
The published reference indicates a token-based model with JWT generation and SSO support, with password authentication and provider configuration present in the object model. Confirm the exact flow and token lifetime with Locus before scoping, since this is the detail most likely to have changed and the one that determines your credential handling design.
Asynchronous Event Delivery: Callbacks, Not Webhooks
This is the single most important terminology point for anyone scoping a Locus integration.
Many platforms publish a webhook subscription catalogue: you subscribe to named events and receive posts. Locus’s published model is configurable callbacks with event-type filtering. The object model includes order callbacks, tour callbacks, and callback settings, alongside order update event types and downstream channel filter settings.
Functionally this achieves the same outcome, which is your systems receiving state changes without polling. The scoping difference is that configuration governs which events reach which destination, and that configuration is a first-class part of the integration design rather than a subscription list. If your integration documentation says “subscribe to webhooks,” it will not match what you find in the reference.
Confirm before build: retry behavior, replay capability, and signature verification on inbound callbacks. These are standard requirements and are not specified in the published surface.
Eight Integration Patterns
Each pattern below maps to capabilities present in the published API reference.
1. Order Injection From OMS or WMS
Orders created upstream are posted to the order resource in real time, so the dispatch engine sees full volume before planning rather than after a batch export. Bulk create operations exist for volume ingestion.
What this replaces: manual export and import between systems, which delays planning and introduces transcription errors.
2. Order-to-Plan in a Single Interaction
Because batch-and-plan and incremental planning operations exist, order submission can trigger planning directly. For continuous intake operations this matters more than it sounds: orders arriving after a scheduled planning wave can enter the plan rather than waiting for the next one.
3. Delivery-Window Feasibility at Order Capture
The slots and promise operations let a storefront or OMS ask what windows are actually available for a given order before committing to one, using serviceability maps and promise confirmation to hold it.
Why this pattern matters most: every downstream delivery failure caused by an unachievable window is prevented here or managed everywhere else. This is the only integration pattern on this list that removes failures rather than communicating them.
4. Master Data Synchronization
Locations, line items, vehicles, vehicle models, riders, rider personas, and transporters are all addressable resources, so master data can be maintained in your system of record and synchronized rather than duplicated.
The dependency to plan for: geocoding. The order object carries geocoding provider, confidence, and accuracy metadata, which means address quality is visible rather than assumed. Use it. Poor geocodes produce routes that look correct and send drivers to the wrong place, and this is the one integration point where you can see the problem before it costs you.
5. Execution Event Delivery to OMS and Customer Systems
Configurable callbacks push order update events to configured destinations, with event-type filtering and downstream channel settings determining what goes where. This is what keeps an OMS record, a customer service view, and a storefront consistent with live delivery state.
6. Proof of Delivery Retrieval
The object model includes proof-of-delivery verification results and checklist verification, with OTP settings covering generation type and the field OTP is generated against. Retrieved after completion, this feeds inventory reconciliation, dispute resolution, and settlement without manual entry.
7. Exception Capture With Reason Codes
Exception checklists, checklist items, expiry settings, and reason codes are present in the model. Structured reason codes are what make exception data analyzable: a timestamped failure tells you a delivery failed, while a coded failure aggregated over a month tells you what to fix.
8. Cost and Settlement Data
Contracts, cost lookups, cost functions and matrices, freight cost objects, reconciliation invoices, tax invoices, and no-due certificates are all present in the model. For a 3PL this is the surface that makes cost attribution per client billable rather than estimated, and it extends the integration through to finance rather than stopping at delivery completion.
Entity export operations with export status tracking also exist, which is the mechanism for scheduled extraction into a data warehouse or BI layer.
API Versus EDI Versus iPaaS: Choosing the Model
Four connectivity models exist, and enterprise stacks typically need more than one.
| Model | Best for | Trade-off |
|---|---|---|
| Direct REST API | Real-time operational exchange where latency changes an outcome: order injection, planning, execution events, proof of delivery | You own the integration code and its maintenance |
| EDI | Trading-partner document exchange where the counterparty requires it, particularly carrier and retailer compliance in the US using ASC X12 transaction sets | Batch and asynchronous by design; not suited to real-time decisioning |
| iPaaS middleware | Environments with many endpoints needing centralized transformation, monitoring, and error handling; absorbs upstream schema changes at one layer | Adds a hop, therefore latency and a failure point; requires internal capability to operate |
| Carrier networks | Reaching many carriers without building each connection | Coverage and data quality vary by carrier |
Locus’s position, stated only as far as the reference confirms it: the published surface is REST with callbacks, and it is documented in OAS 2.0, which means it can be consumed directly or fronted by an iPaaS platform as a standard REST target. The reference does not document native EDI support, named iPaaS connectors, or a pre-built connector catalogue for specific WMS, ERP, or BI platforms. Where your operation requires EDI, confirm with Locus whether that is handled natively or expected to be translated upstream before reaching the API.
What to Confirm Before You Scope
The published reference establishes the surface. Six items are not specified in it and each affects integration design, so confirm all six with Locus before committing to a scope.
- Rate limits and pagination behavior at your order volume
- Sandbox availability, and whether credentials are obtainable before contract signature
- Callback retry, replay, and signature verification behavior
- Idempotency guarantees on write operations, so a retried call does not double-post
- Named production integrations with your specific WMS, ERP, OMS, and TMS instances and versions, at a reference you can call
- EDI handling, whether native or expected upstream, and any recommended middleware
Item five is the one that determines your timeline. A connector the vendor already runs in production against your specific system version is days of work; a system they have never integrated is weeks plus a permanent maintenance tail. Treat “we have a documented API” as accurate and insufficient: an API is permission to build an integration rather than an integration.
For reference, the full API documentation is published at docs.locus.sh, with the OAS specification retrievable per service.
What Actually Sets Your Timeline
Two things dominate, and neither is the Locus API.
Your ERP’s customization depth. A heavily customized enterprise ERP sets the pace regardless of the incoming platform. Custom fields, modified document flows, and bespoke middleware all add discovery and mapping work, and this is the item most often mistaken for platform complexity.
Your data quality. Address and geocoding accuracy, master data consistency for locations and customers, and business rules currently encoded as workarounds. Audit these before kickoff. Discovered in week three, they move go-live by more than the remediation itself takes, and the geocoding metadata on the order object gives you a way to measure the problem rather than guess at it.
| Also Read: How Easy Is It to Integrate Locus APIs? An Architectural Framework for Enterprise Logistics in 2026 |
|---|
FAQs
What APIs does Locus provide? Three published REST surfaces specified in OAS 2.0: an order API at oms.locus-api.com/v1 covering the order lifecycle including serviceability and slots, a delivery and master-data API at locus-api.com/v1 covering locations, line items, transporters, riders, vehicles and rosters, and a platform API at platform.locus-api.com/v1 for personnel and teams.
Does Locus support webhooks? The published model uses configurable callbacks with event-type filtering rather than a webhook subscription catalogue. Functionally you receive state changes without polling; the difference is that configuration governs which events reach which destination. Confirm retry, replay, and signature verification behavior with Locus before building.
How does Locus authenticate API requests? The reference indicates a token-based model with JWT generation and SSO support. Confirm the exact flow and token lifetime with Locus, since this determines your credential handling design and is the detail most likely to have changed.
Can an order be planned in the same call it is created? The object model includes batch-and-plan and incremental planning operations, so order submission can trigger planning rather than requiring a separate call. For operations with continuous order intake this means late orders can enter the plan rather than waiting for the next wave.
Can Locus validate a delivery window before an order is confirmed? Yes. A slots operation returns available future slots for a given order, and the model includes promise retrieval, confirmation, and update alongside serviceability maps. That allows a storefront or OMS to validate feasibility at order capture rather than asserting a window and discovering later it cannot be held.
Does Locus support EDI? The published API reference does not document native EDI support. Where your carriers or retail partners require ASC X12 transaction sets, confirm with Locus whether EDI is handled natively or expected to be translated upstream before reaching the REST API.
Which WMS and ERP platforms does Locus have pre-built connectors for? The published API reference does not include a connector catalogue, so this needs confirming directly with Locus against your specific systems and versions. Ask for named production integrations at a customer you can call, since that distinction is what separates a days-long connection from a multi-week build.
Written by the Locus Solutions Team—logistics technology experts helping enterprise fleets scale with confidence and precision.
Related Tags:
General
Delivery Experience Optimization for E-Commerce and 3PLs: Which Half of the Problem You Actually Have
Fulfillment providers and delivery software solve different halves of the e-commerce delivery experience. Which one you need depends on whether you control delivery execution, and most buyers get that backwards.
Read moreGeneral
Delivery Notifications and Real-Time Tracking: What Separates Deflection From Reporting
What separates a delivery notification and tracking capability that reduces contacts from one that reports status: the five notification moments, ETA accuracy as the foundation, and how to verify a vendor's claims.
Read moreInsights Worth Your Time
Locus API Integrations: How Enterprise Logistics Operations Connect Their Tech Stack