Introduction
TMW.Suite is an enterprise-level transportation management system (TMS) used by hundreds of truckload carriers, private fleets, brokers, and 3PLs to manage the order-to-cash lifecycle—from order entry and dispatch through operations, billing, and settlements. It is available on-premise or as a SaaS solution hosted by Trimble Transportation.
Developer applications integrate with Suite data through the OData/CloudHub API, hosted on Trimble Transportation Cloud (TTC). CloudHub—a multi-tenant application in TTC—routes API requests to each customer’s CloudHubConnector(CHC) instance based on CloudHub configuration records that specify the customer’s OData endpoint.
Product Links
Section titled “Product Links”Architecture
Section titled “Architecture”flowchart LR App["Developer Application"] --> TTC["Trimble Transportation Cloud"] TTC --> CloudHub["CloudHub"] CloudHub --> CHC["Cloud Hub Connector"] CHC --> DB["Suite Database"]
Requests to the OData API use the /tte-tmwsuite/v0/odata/ path prefix on TTC. CloudHub forwards those requests to the customer’s CHC deployment, which executes the OData query or update against the local Suite database.
Use Cases
Section titled “Use Cases”Common use cases of the TMW.Suite APIs include:
- Internal systems: Use the APIs to share data and streamline internal business processes.
- External data sharing: In addition to internal networking, the APIs allow the sharing of TMW.Suite data with third-party systems.
- App integrations: Access TMW.Suite data in real time.
- Embedded content: Request data from the TMW.Suite REST APIs to embed pieces of content onto your corporate site.
Embed TMW.Suite Content
Section titled “Embed TMW.Suite Content”Our APIs allow you to embed TMW.Suite content and functionality into your own applications. You can call master data such as companies, drivers, and commodities, and then perform dozens of functions on that data—from creating orders to assigning trips—using the TMW.Suite APIs.
The APIs can not only alleviate repetitive back-office tasks, such as data entry, but also help ensure accuracy so that jobs and forms are done right, the first time.
When our APIs are licensed, software developers have access to hundreds of API endpoints, with each endpoint allowing them to perform a specific action on TMW.Suite data. They can use these endpoints to build new software tools or add-ons to in-house software to take advantage of the power of TMW.Suite. The possibilities are endless.
Example: A Customer Order Form
Section titled “Example: A Customer Order Form”A common use case for TMW.Suite APIs is to create a custom order-entry form for customers or internal staff. Many carriers provide this type of form on a public website or customer portal to capture freight requests and turn them into dispatched loads.
The flow below highlights the API endpoints that can be used to complete and process the form. It uses both Master Data (reference data) and Operations (order and dispatch) API endpoints.
- The
GET /tte-tmwsuite/v0/odata/companiesendpoint retrieves TMW.Suite company (customer) records so a customer name can be selected from a drop-down menu, assuring it matches what is in the TMW.Suite database. - The
GET /tte-tmwsuite/v0/odata/commoditiesendpoint retrieves commodity records that can be used to describe the type of freight on the order. - The
GET /tte-tmwsuite/v0/odata/citiesendpoint retrieves city records so origin and destination can be selected from a drop-down menu. - Finally, after all the information is entered, the
POST /tte-tmwsuite/v0/automation/dispatches/make-orderendpoint takes in the information from the form and creates the order in TMW.Suite.
Develop
Section titled “Develop”The offerings below, grouped by type, enable developers to integrate and extend TMW.Suite in their own applications.
TMW.Suite offers RESTful and OData APIs that customers can use to maximize their existing back-office systems and workflow:
| API | Description |
|---|---|
| Operations API | Business-critical data including orders, trips, legs, dispatch assignments, and more |
| Master Data API | Configuration and reference data including drivers, tractors, trailers, companies, commodities, and more |
| Accounting API | Invoices, payables, customers, vendors, and more |
| Planning API | Load planning, trip assignment, and optimization workflows |