Trimble Commodities API

Retrieves, creates, updates and deletes TruckMate commodity codes. Commodity codes can be viewed and maintained in the TruckMate Codes Maintenance application.

GitHub OpenAPI

Operations 5

GET /commodities Retrieve commodity codes #
POST /commodities Create a new commodity #
GET /commodities/{commodityId} Retrieve a commodity code #
PUT /commodities/{commodityId} Update a commodity code #
DELETE /commodities/{commodityId} Delete a commodity code #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/trimble:trimble-commodities-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

trimble-commodities-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: MasterData Commodities 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: Commodities
  description: Retrieves, creates, updates and deletes TruckMate commodity codes. Commodity codes can be viewed and maintained in the TruckMate Codes Maintenance application.
paths:
  /commodities:
    get:
      summary: Retrieve commodity codes
      description: 'Retrieves commodity code records that can be used to describe the type of freight on a freight bill.


        Commodity codes can be viewed in the Codes Maintenance application > Commodity tab.'
      operationId: GetCommodities
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Commodities
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/orderBy'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCommodities200'
        '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'
    post:
      summary: Create a new commodity
      description: 'Creates one or more commodity records.


        Commodity codes can be viewed in the Codes Maintenance application > Commodity tab.'
      operationId: PostCommodities
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Commodities
      requestBody:
        description: An array of JSON objects containing the properties of the commodity to be created.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefCommoditiesPostRequest'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCommodities201'
        '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'
  /commodities/{commodityId}:
    parameters:
    - name: commodityId
      in: path
      description: commodity code identifier
      required: true
      schema:
        type: string
    get:
      summary: Retrieve a commodity code
      description: 'Retrieves a commodity code record that can be used to describe the type of freight on a freight bill.


        Commodity codes can be viewed in the Codes Maintenance application > Commodity tab.'
      operationId: GetCommodity
      security:
      - truckmateApiKeyAuth: []
      - webuserJwtAuth: []
      - tidJwtAuth: []
      tags:
      - Commodities
      parameters:
      - name: expand
        in: query
        description: Expand applicable sub-resources separated by comma.
        required: false
        schema:
          type: string
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/commodity'
                - 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'
    put:
      summary: Update a commodity code
      description: 'Updates one or more properties of a specific commodity code record.


        Commodity codes can be viewed in the Codes Maintenance application > Commodity tab.'
      operationId: PutCommodityCode
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Commodities
      requestBody:
        description: A JSON objects containing the properties of the Commodity to be updated.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefCommodityPutRequest'
      parameters:
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/commodity'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          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'
    delete:
      summary: Delete a commodity code
      description: 'Deletes a commodity record.


        Commodity codes can be viewed in the Codes Maintenance application > Commodity tab.'
      operationId: DeleteCommodityCode
      security:
      - truckmateApiKeyAuth: []
      tags:
      - Commodities
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ARTErrors'
        '404':
          description: Not Found
          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
    commodity:
      type: object
      properties:
        commodityCode:
          type: string
          maxLength: 10
        shortDescription:
          type: string
          maxLength: 80
        longDescription:
          type: string
          maxLength: 131072
        dangerous:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        commodityclass:
          type: string
          maxLength: 10
        applyTax1:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        applyTax2:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        exportName:
          type: string
          maxLength: 10
        temperatureControlled:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        defaultTemperature:
          type:
          - number
          - 'null'
        defaultTemperatureUnits:
          type: string
          maxLength: 3
        palletOwner:
          type: string
          maxLength: 10
        conversionType:
          type: string
          enum:
          - pieces
          - pallets
          - ''
        conversionPieceUnits:
          type: string
          maxLength: 3
        conversionWeight:
          type:
          - number
          - 'null'
        conversionWeightUnits:
          type: string
          maxLength: 3
        conversionCube:
          type:
          - number
          - 'null'
        conversionCubeUnits:
          type: string
          maxLength: 3
        conversionPallet:
          type:
          - number
          - 'null'
        conversionPalletUnits:
          type: string
          maxLength: 3
        isPalletType:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        defaultWeight:
          type:
          - number
          - 'null'
        defaultWeightUnits:
          type: string
          maxLength: 3
        defaultHeight:
          type:
          - number
          - 'null'
        defaultHeightUnits:
          type: string
          maxLength: 3
        defaultLength:
          type:
          - number
          - 'null'
        defaultLengthUnits:
          type: string
          maxLength: 3
        defaultWidth:
          type:
          - number
          - 'null'
        defaultWidthUnits:
          type: string
          maxLength: 3
        defaultPieces:
          type:
          - number
          - 'null'
        defaultPiecesUnits:
          type: string
          maxLength: 3
        washType:
          type: string
          maxLength: 10
        unNumber:
          type: string
          maxLength: 10
        unId:
          type: integer
        unIsGroup:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        user1:
          type: string
          maxLength: 40
        user2:
          type: string
          maxLength: 40
        user3:
          type: string
          maxLength: 40
        user4:
          type: string
          maxLength: 40
        user5:
          type: string
          maxLength: 40
        user6:
          type: string
          maxLength: 40
        user7:
          type: string
          maxLength: 40
        user8:
          type: string
          maxLength: 40
        user9:
          type: string
          maxLength: 40
        user10:
          type: string
          maxLength: 40
        highValue:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        webEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        stackable:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        matchAllClients:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        defaultArea:
          type:
          - number
          - 'null'
        defaultAreaUnits:
          type: string
          maxLength: 3
        defaultCube:
          type:
          - number
          - 'null'
        defaultCubeUnits:
          type: string
          maxLength: 3
        defaultDistance:
          type:
          - number
          - 'null'
        defaultDistanceUnits:
          type: string
          maxLength: 3
        defaultPallets:
          type:
          - number
          - 'null'
        defaultPalletsUnits:
          type: string
          maxLength: 3
        defaultTime:
          type:
          - number
          - 'null'
        defaultTimeUnits:
          type: string
          maxLength: 3
        defaultVolume:
          type:
          - number
          - 'null'
        defaultVolumeUnits:
          type: string
          maxLength: 3
        stcc:
          type: string
          maxLength: 7
          oneOf:
          - enum:
            - ''
          - pattern: ^\d{1,7}$
        fdaApproval:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        perishable:
          type: string
          enum:
          - 'False'
          - 'True'
          - ''
        excludeConnectedDock:
          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'
    RefCommoditiesPostRequest:
      type: object
      properties:
        commodities:
          type: array
          items:
            $ref: '#/components/schemas/RefCommodityPostRequest'
    PostCommodities201:
      type: object
      properties:
        commodities:
          type: array
          items:
            $ref: '#/components/schemas/commodity'
    RefCommodityPostRequest:
      type: object
      properties:
        commodityCode:
          type: string
          maxLength: 10
        shortDescription:
          type: string
          maxLength: 80
        longDescription:
          type: string
          maxLength: 131072
        dangerous:
          type: string
          enum:
          - 'False'
          - 'True'
        commodityclass:
          type: string
          maxLength: 10
        applyTax1:
          type: string
          enum:
          - 'False'
          - 'True'
        applyTax2:
          type: string
          enum:
          - 'False'
          - 'True'
        exportName:
          type: string
          maxLength: 10
        temperatureControlled:
          type: string
          enum:
          - 'False'
          - 'True'
        defaultTemperature:
          type: number
        defaultTemperatureUnits:
          type: string
          maxLength: 3
        conversionPieceUnits:
          type: string
          maxLength: 3
        conversionWeight:
          type: number
        conversionWeightUnits:
          type: string
          maxLength: 3
        conversionCube:
          type: number
        conversionCubeUnits:
          type: string
          maxLength: 3
        conversionPallet:
          type: number
        conversionPalletUnits:
          type: string
          maxLength: 3
        isPalletType:
          type: string
          enum:
          - 'False'
          - 'True'
        defaultWeight:
          type: number
        defaultWeightUnits:
          type: string
          maxLength: 3
        defaultHeight:
          type: number
        defaultHeightUnits:
          type: string
          maxLength: 3
        defaultLength:
          type: number
        defaultLengthUnits:
          type: string
          maxLength: 3
        defaultWidth:
          type: number
        defaultWidthUnits:
          type: string
          maxLength: 3
        defaultPieces:
          type: number
        defaultPiecesUnits:
          type: string
          maxLength: 3
        washType:
          type: string
          maxLength: 10
        unNumber:
          type: string
          maxLength: 10
        unIsGroup:
          type: string
          enum:
          - 'False'
          - 'True'
        user1:
          type: string
          maxLength: 40
        user2:
          type: string
          maxLength: 40
        user3:
          type: string
          maxLength: 40
        user4:
          type: string
          maxLength: 40
        user5:
          type: string
          maxLength: 40
        user6:
          type: string
          maxLength: 40
        user7:
          type: string
          maxLength: 40
        user8:
          type: string
          maxLength: 40
        user9:
          type: string
          maxLength: 40
        user10:
          type: string
          maxLength: 40
        highValue:
          type: string
          enum:
          - 'False'
          - 'True'
        webEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
        stackable:
          type: string
          enum:
          - 'False'
          - 'True'
        matchAllClients:
          type: string
          enum:
          - 'False'
          - 'True'
        defaultArea:
          type: number
        defaultAreaUnits:
          type: string
          maxLength: 3
        defaultCube:
          type: number
        defaultCubeUnits:
          type: string
          maxLength: 3
        defaultDistance:
          type: number
        defaultDistanceUnits:
          type: string
          maxLength: 3
        defaultPallets:
          type: number
        defaultPalletsUnits:
          type: string
          maxLength: 3
        defaultTime:
          type: number
        defaultTimeUnits:
          type: string
          maxLength: 3
        defaultVolume:
          type: number
        defaultVolumeUnits:
          type: string
          maxLength: 3
        stcc:
          type: string
          pattern: ^\d{0,7}$
          maxLength: 7
        fdaApproval:
          type: string
          enum:
          - 'False'
          - 'True'
        perishable:
          type: string
          enum:
          - 'False'
          - 'True'
        excludeConnectedDock:
          type: string
          enum:
          - 'False'
          - 'True'
        palletOwner:
          type: string
          maxLength: 10
        conversionType:
          type: string
          enum:
          - pieces
          - pallets
      required:
      - commodityCode
    RefCommodityPutRequest:
      type: object
      properties:
        shortDescription:
          type: string
          maxLength: 80
        longDescription:
          type: string
          maxLength: 131072
        dangerous:
          type: string
          enum:
          - 'False'
          - 'True'
        commodityclass:
          type: string
          maxLength: 10
        applyTax1:
          type: string
          enum:
          - 'False'
          - 'True'
        applyTax2:
          type: string
          enum:
          - 'False'
          - 'True'
        exportName:
          type: string
          maxLength: 10
        temperatureControlled:
          type: string
          enum:
          - 'False'
          - 'True'
        defaultTemperature:
          type: number
        defaultTemperatureUnits:
          type: string
          maxLength: 3
        conversionPieceUnits:
          type: string
          maxLength: 3
        conversionWeight:
          type: number
        conversionWeightUnits:
          type: string
          maxLength: 3
        conversionCube:
          type: number
        conversionCubeUnits:
          type: string
          maxLength: 3
        conversionPallet:
          type: number
        conversionPalletUnits:
          type: string
          maxLength: 3
        isPalletType:
          type: string
          enum:
          - 'False'
          - 'True'
        defaultWeight:
          type: number
        defaultWeightUnits:
          type: string
          maxLength: 3
        defaultHeight:
          type: number
        defaultHeightUnits:
          type: string
          maxLength: 3
        defaultLength:
          type: number
        defaultLengthUnits:
          type: string
          maxLength: 3
        defaultWidth:
          type: number
        defaultWidthUnits:
          type: string
          maxLength: 3
        defaultPieces:
          type: number
        defaultPiecesUnits:
          type: string
          maxLength: 3
        washType:
          type: string
          maxLength: 10
        unNumber:
          type: string
          maxLength: 10
        unIsGroup:
          type: string
          enum:
          - 'False'
          - 'True'
        user1:
          type: string
          maxLength: 40
        user2:
          type: string
          maxLength: 40
        user3:
          type: string
          maxLength: 40
        user4:
          type: string
          maxLength: 40
        user5:
          type: string
          maxLength: 40
        user6:
          type: string
          maxLength: 40
        user7:
          type: string
          maxLength: 40
        user8:
          type: string
          maxLength: 40
        user9:
          type: string
          maxLength: 40
        user10:
          type: string
          maxLength: 40
        highValue:
          type: string
          enum:
          - 'False'
          - 'True'
        webEnabled:
          type: string
          enum:
          - 'False'
          - 'True'
        stackable:
          type: string
          enum:
          - 'False'
          - 'True'
        matchAllClients:
          type: string
          enum:
          - 'False'
          - 'True'
        defaultArea:
          type: number
        defaultAreaUnits:
          type: string
          maxLength: 3
        defaultCube:
          type: number
        defaultCubeUnits:
          type: string
          maxLength: 3
        defaultDistance:
          type: number
        defaultDistanceUnits:
          type: string
          maxLength: 3
        defaultPallets:
          type: number
        defaultPalletsUnits:
          type: string
          maxLength: 3
        defaultTime:
          type: number
        defaultTimeUnits:
          type: string
          maxLength: 3
        defaultVolume:
          type: number
        defaultVolumeUnits:
          type: string
          maxLength: 3
        stcc:
          type: string
          pattern: ^\d{0,7}$
          maxLength: 7
        fdaApproval:
          type: string
          enum:
          - 'False'
          - 'True'
        perishable:
          type: string
          enum:
          - 'False'
          - 'True'
        excludeConnectedDock:
          type: string
          enum:
          - 'False'
          - 'True'
        palletOwner:
          type: string
          maxLength: 10
        conversionType:
          type: string
          enum:
          - pieces
          - pallets
    GetCommodities200:
      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
        commodities:
          type: array
          items:
            $ref: '#/components/schemas/commodity'
  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/