Trimble Units API

openapi: 3.2.0
info:
  title: MasterData Units 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: Units
  description: Retrieves TruckMate units of measurement. Units can be viewed and maintained in the TruckMate Codes Maintenance application.
paths:
  /units:
    get:
      summary: Retrieve units of measurement
      description: 'Retrieve unit of measurement records.


        Unit of measurement records can be viewed in the Codes Maintenance application > Units tab.'
      operationId: GetUnits
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Units
      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/GetUnits200'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
  /units/{unitId}:
    parameters:
    - name: unitId
      in: path
      description: unit identifier
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a unit of measurement
      description: 'Retrieve a unit of measurement record.


        Unit of measurement records can be viewed in the Codes Maintenance application > Units tab.'
      operationId: GetUnit
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Units
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/unit'
                - 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'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
components:
  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
  schemas:
    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
    unit:
      type: object
      properties:
        unitSymbol:
          type: string
          maxLength: 3
        unitName:
          type: string
          maxLength: 20
        unitType:
          type: string
          enum:
          - area
          - cube
          - currency
          - distance
          - length
          - pallets
          - pieces
          - temperature
          - time
          - volume
          - weight
          - ''
        isBaseUnit:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        conversionToBase:
          type:
          - number
          - 'null'
        webEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
    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'
    GetUnits200:
      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
        units:
          type: array
          items:
            $ref: '#/components/schemas/unit'
  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/