CloudHub API

View OpenAPI Definition The OpenAPI Definition (OAD) for this API is available to view and download here.

Introduction

The CloudHub API (TMWSuite.CloudHub) is hosted on Trimble Transportation Cloud (TTC) and routes API calls to the on-premise CloudHub Connector. Use this API to work with Suite resources such as customers, drivers, tractors, trailers, vendors, contacts, locations, network partners, and accounts payable/receivable.

Most resources use the /tte-tmwsuite/v2/ path prefix. Drivers also have a v3 surface at /tte-tmwsuite/v3/drivers. The CloudHub API resolves each request to the correct customer environment based on CloudHub configuration records that map accounts to CloudHub Connector endpoints. For OData access to Suite data, see the OData API.

Capabilities

The CloudHub API provides REST endpoints across these resource groups:

• Financial: Accounts payable and accounts receivable
• Master data: Customers, vendors, contacts, drivers, tractors, and trailers
• Operations: Locations, network partners, driver availability, and driver availability expirations

List endpoints return paged results (pageIndex, totalItems, items, links). Typical query parameters are pageSize (default 10, maximum 100), pageIndex (default 0), $filter, sortby, $expand, and ExcludeExternalIntegrationSync. $select is documented in the spec but is unsupported.

See the OpenAPI definition for the complete list of endpoints, request parameters, and response schemas. The published spec does not include request or response examples.

List customers

GET /transportation/tte-tmwsuite/v2/customers?pageSize=10&pageIndex=0 HTTP/1.1
Host: cloud.dev.api.trimblecloud.com
Authorization: Bearer {access_token}

A successful response is HTTP 200 OK with a PagedResponseTtcCustomer body (pageIndex, totalItems, items, links).

Create a driver (v3)

The v3 create-driver operation requires id (1–8 characters). Other properties such as legalFirstName and lastName are optional.

POST /transportation/tte-tmwsuite/v3/drivers HTTP/1.1
Host: cloud.dev.api.trimblecloud.com
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "id": "DRV001",
  "legalFirstName": "Alex",
  "lastName": "Rivera",
  "isActive": true
}

A successful response is HTTP 201 Created with a DriverV3Response body. See the OpenAPI definition for the full DriverV3PostRequest schema.

Authentication

API requests require a Bearer token obtained from Trimble Identity using the OAuth 2.0 client credentials flow with the sas_token scope. Optional SubEnv header values (Dev01, Dev02, Qa01, Qa02) forward the request to a sub-environment. See the Access guide for details.