Maven offers a wide range of endpoints. Below is a list of endpoints that most LTL fleets use to integrate into Maven.

TMS to Maven Data Flow

Maven offers RESTful APIs to send Maven updates from the TMS system and other fleet IT systems.

Master Data

Assets

POST /users - Drivers and admins are automatically created through the POST users endpoint. With this endpoint, the fleet does not need to add and edit users in Maven and can instead use an HR system or their TMS to manage users

POST /vehicles - Vehicles are automatically created in Maven through the POST vehicles endpoint. With this endpoint, the fleet does not need to add or edit vehicles in Maven but can use their maintenance system or TMS as the source of truth.

POST /trailers - Similar to vehicles, an endpoint to create trailers

Locations

POST /company-locations - Company locations are Maven's way of representing physical locations where fleets do business. While the model is flexible to represent things like terminals, warehouses, or depots, company locations is most commonly used to model the customers where freight is picked up and delivered.

Usually when a customer is created or updated in the TMS, this endpoint is called to update Maven. Maven uses the customer information to know where to send drivers to make pickups and deliveries.

Transactional Data

Transactional data is the heart of the data feeds into Maven. Maven supports a variety of transactional data feeds depending on what product or product groups are being utilized.

Shipments / Orders

POST /shipment - The shipment endpoint is the most common (and often the only required) transactional data feed for Maven customers. The shipment endpoint is designed to take in continuous updates that originate outside of Maven. This typically starts with an external EDI/pickup request but also can be used for things like shipment reweighs, billing updates, delivery date adjustments, etc..

Essentially anytime the shipment is updated in the TMS, Maven should know about it by calling the shipment endpoint.

P&D Manifests

POST /manifest - Pickup and Delivery manifests are sent to Maven via the /manifests endpoint. Manifests and their assigned shipments appear in the dispatch board.

POST /manifestNumber - The TMS is the record keeper of manifests. When a manifest is created in Maven, the TMS can use this endpoint to assign a manifestNumber.

Linehaul Manifests

POST /linehaul/manifests - Linehaul manifests contain information about what freight is expected to be sent from location A to B. Maven ingests linehaul manifests and shows this information on a dedicated "Linehaul" tab within the Maven Dispatch portal. Manifests are also displayed on the Dock App for dock associates to unload.

Linehaul Trips

POST /linehaul/trips - Linehaul trips are the individual driving segments that are required to move a linehaul manifest from A to B - typically terminal to terminal. This can also be terminal to relay point, relay point to relay point, etc. This endpoint is necessary for customers who want to execute trips generated by the TMS within Maven's trip execution workflow system.

Maven To TMS Flows

Fleets can consume events from Maven using Maven's return event stream. Anytime a driver or dispatcher take an action in Maven, an appropriate return event is generated and placed into a queue for the TMS to pickup and process.

Freight Lifecycle

Maven offers an exhaustive set of return events related to the lifecycle of freight, but below are the key events that must be implemented for a successful implementation

ManifestPlanned - Generated when a planner marks a city delivery manifest as being ready for loading. This event typically triggers a loading process on the fleet's side.

ManifestDispatched - Generated with a planner or dispatcher marks a city delivery manifest as being dispatched. At this point, the driver has access to the manifest and can begin making deliveries.

RouteBegin - Generated when a driver begins their deliveries. This event includes details about the manifest, stops, and shipments on the route.

StopComplete - Generated when a driver completes a stop. This event includes details about the stop and the shipments on the stop. If a dispatcher has assigned pickup requests to the driver, they will appear here once the driver completes the pickup.

RouteComplete - Generated when a driver has completed their route. At this point, the city delivery manifest is no longer available to the driver.