OrderCreate API

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

Introduction

The OrderCreate API is hosted on Trimble Transportation Cloud (TTC) and provides REST endpoints for creating and updating Suite operational data—orders, dispatches, stops, freight, legs, asset assignments, and related records. Use this API when your integration needs to build or modify dispatch workflows rather than query data through the OData API.

API requests use the /tte-tmwsuite/v0/automation/ path prefix on TTC. CloudHub routes each request to the customer’s on-premise Cloud Hub Connector instance, which persists the changes to the local Suite database.

For read-heavy integrations and entity queries, see the OData API. For master data and financial resources, see the CloudHub API.

Capabilities

The OrderCreate API supports two integration styles:

• Dispatch workflows — High-level operations that create complete dispatch containers, including make-order, create-order-canonical-model, cross-dock, consolidate, split-trip, assign-asset, and related actions on the Dispatches resource.
• Entity CRUD — Create, update, and delete individual records for orders, stops, legs, freights, stop events, load requirements, asset assignments, and third-party assignments.

Additional endpoints support travel queries and CHC connectivity diagnostics.

See the OpenAPI definition for the complete list of endpoints, request parameters, and response schemas.

Create order (canonical model)

The primary order-creation endpoint accepts a canonical order payload and returns a persisted DispatchContainer with the created move, leg, stops, freight, and related records.

POST /transportation/tte-tmwsuite/v0/automation/dispatches/create-order-canonical-model HTTP/1.1
Host: cloud.dev.api.trimblecloud.com
Authorization: Bearer {access_token}
Content-Type: application/json

{
  "billTo": "BILLTO01",
  "shipper": "SHIPPER1",
  "consignee": "CONSIG01",
  "ordCarrier": "CAR001",
  "equipment": {
    "type": "VAN",
    "length": "53"
  },
  "rate": {
    "total": 1500.00,
    "currency": "USD",
    "rateType": "FLAT"
  },
  "stops": [
    {
      "stpSequence": 1,
      "stpEvent": "LLD",
      "cmpId": "SHIPPER1"
    },
    {
      "stpSequence": 2,
      "stpEvent": "LUL",
      "cmpId": "CONSIG01"
    }
  ],
  "freight": [
    {
      "commodityCode": "FAK",
      "description": "General freight",
      "weight": 10000,
      "weightUnit": "LBS"
    }
  ]
}

Required fields are billTo, shipper, and consignee. The response is HTTP 201 Created with a DispatchContainer body. See the OpenAPI definition for the full CanonicalOrderRequest and DispatchContainer schemas.

Authentication

API requests require a Bearer token obtained from Trimble Identity using the OAuth 2.0 client credentials flow with the sas_token scope. See the Access guide for details.