Trimble Routes API

openapi: 3.2.0
info:
  title: MasterData Routes API
  description: 'The Master Data management API allows for an external system to create, retrieve, update or delete TruckMate configuration data, such as Client, Vendor and Driver profiles, as well as sites, zones, commodity codes etc.


    Download latest released OpenAPI


    This documentation is based on the most currently released version of TruckMate. Documentation for previous versions can be accessed by navigating to the openapi.json endpoint for any given API (the service must be set up and running). For example: http://DOMAIN/openapi.json


    ---


    © 2026, Trimble Inc. All rights reserved. Unauthorized copying prohibited. Software functions, including our APIs and their specification, are subject to change without notice. Information contained herein is Trimble Confidential Information, used under license.


    ---'
  version: '1'
  x-tm-release: 26.3.125.0
tags:
- name: Routes
  description: Retrieves TruckMate route information. Route information can be viewed in the TruckMate Crossdock traffic lanes application.
paths:
  /routes:
    get:
      summary: Retrieve route information
      description: 'Retrieves route information records.


        Route information can be viewed in the Crossdock traffic lanes application.'
      operationId: GetRoutes
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/select'
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - zones
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRoutes200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /routes/{routeId}:
    parameters:
    - name: routeId
      in: path
      description: The unique identifier for the route.
      required: true
      schema:
        type: integer
    get:
      summary: Retrieve a route
      description: 'Retrieves a route information record.


        Route information can be viewed in the Crossdock traffic lanes application.'
      operationId: GetRoute
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/select'
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - zones
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /routes/{routeId}/zones:
    parameters:
    - name: routeId
      in: path
      description: The unique identifier for the route.
      required: true
      schema:
        type: integer
    get:
      summary: Retrieve route zones
      description: 'Retrieves zone records for the specified route.


        Route zones can be viewed in the Crossdock traffic lanes application.'
      operationId: RoutesGetRouteZones
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoutesGetRouteZones200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /routes/{routeId}/zones/{zoneId}:
    parameters:
    - name: routeId
      in: path
      description: The unique identifier for the route.
      required: true
      schema:
        type: integer
    - name: zoneId
      in: path
      description: The zone code.
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a route zone
      description: 'Retrieves a zone record for the specified route.


        Route zones can be viewed in the Crossdock traffic lanes application.'
      operationId: RoutesGetRouteZone
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Routes
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/routesZone'
                - type: object
                  properties:
                    href:
                      type: string
                      readOnly: true
                      description: Self-referencing URL for this resource
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
components:
  schemas:
    routesZone:
      type: object
      properties:
        routeId:
          type: integer
        zoneId:
          type: string
          maxLength: 10
    ARTError:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        code:
          type: string
          description: Error code (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
        description:
          type: string
          description: Human-readable description (optional, deprecated; omitted in Mobile Comm)
          deprecated: true
    GetRoutes200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        filter:
          type: string
        sort:
          type: string
        select:
          type: string
        count:
          type: integer
        routes:
          type: array
          items:
            $ref: '#/components/schemas/route'
    ARTErrors:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
          enum:
          - 400
          - 401
          - 403
          - 404
          - 405
          - 409
          - 429
          - 500
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ARTError'
    RoutesGetRouteZones200:
      type: object
      properties:
        href:
          type: string
          readOnly: true
          description: Self-referencing URL for this resource
        offset:
          type: integer
        limit:
          type: integer
        filter:
          type: string
        sort:
          type: string
        select:
          type: string
        count:
          type: integer
        zones:
          type: array
          items:
            $ref: '#/components/schemas/routesZone'
    route:
      type: object
      properties:
        routeId:
          type: integer
        routeName:
          type: string
          maxLength: 40
        routeParent:
          type:
          - integer
          - 'null'
        zones:
          type: array
          items:
            $ref: '#/components/schemas/routesZone'
  parameters:
    offset:
      name: offset
      in: query
      description: Specifies the number of items to skip before beginning to select the records to return.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 0
    select:
      name: $select
      in: query
      description: Select allows to request a specified set of properties, see [Selecting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html#_Toc31361040)
      required: false
      style: form
      explode: true
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Specifies the maximum number of items to include in the response results.
      required: false
      style: form
      explode: true
      schema:
        type: integer
        default: 20
    orderBy:
      name: $orderBy
      in: query
      description: Field(s) to order returned resource by, with optional direction. E.g., "fieldName desc, fieldName2"
      required: false
      style: form
      explode: true
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter). Note, not all features of oData filter syntax are supported.
      required: false
      style: form
      explode: true
      schema:
        type: string
  securitySchemes:
    tidJwtAuth:
      type: http
      description: A time-limited JSON Web Token generated via separate POST request using TID
      scheme: bearer
    webuserJwtAuth:
      type: http
      description: A fresh JSON Web Token expires in four hours. It can be renewed by making a GET request to /login endpoint, or generated by making a POST request to /login endpoint
      scheme: bearer
    truckmateApiKeyAuth:
      type: http
      description: TruckMate API Key
      scheme: bearer
externalDocs:
  url: https://learn.transportation.trimble.com/