{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/trimble/json-schema/trimble-barcode-schema.json",
  "title": "barcode",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/trimble-truckmate-openapi.yml#/components/schemas/barcode",
  "type": "object",
  "properties": {
    "barcode": {
      "type": "string",
      "maxLength": 50,
      "description": "System-generated scannable barcode for the handling unit."
    },
    "altBarcode1": {
      "type": "string",
      "maxLength": 50,
      "description": "An alternate scannable barcode for the handling unit."
    },
    "altBarcode2": {
      "type": "string",
      "maxLength": 50,
      "description": "A second alternate scannable barcode for the handling unit."
    },
    "cube": {
      "type": [
        "number",
        "null"
      ],
      "description": "Cubic dimensional value of the handling unit."
    },
    "cubeUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the cube property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "height": {
      "type": [
        "number",
        "null"
      ],
      "description": "Height of the handling unit."
    },
    "heightUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the height property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "length": {
      "type": [
        "number",
        "null"
      ],
      "description": "Length of the handling unit."
    },
    "lengthUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the length property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "location": {
      "type": "string",
      "maxLength": 12,
      "description": "Identifier for the last known location of the handling unit."
    },
    "locationTerminalId": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Numeric ID for the terminal where the handling unit is currently or was last located."
    },
    "locationTerminalZone": {
      "type": "string",
      "maxLength": 10,
      "description": "Zone code for the terminal where the handling unit is currently or was last located."
    },
    "locationTimestamp": {
      "type": [
        "string",
        "null"
      ],
      "description": "Timestamp for the last known location information.",
      "oneOf": [
        {
          "enum": [
            ""
          ]
        },
        {
          "pattern": "^\\d{4}-(1[0-2]|0[1-9])-(3[01]|0[1-9]|[12]\\d)((T| )([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d))?$"
        }
      ]
    },
    "locationTypeDesc": {
      "type": "string",
      "maxLength": 15,
      "description": "Description of location referred to by the location property."
    },
    "locationType": {
      "type": "string",
      "maxLength": 1,
      "description": "Type of location referred to by the location property."
    },
    "pallets": {
      "type": [
        "number",
        "null"
      ],
      "description": "Pallets that make up the handling unit."
    },
    "palletUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the pallets property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "pieces": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Pieces that make up the handling unit."
    },
    "pieceUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the pieces property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "temperature": {
      "type": [
        "number",
        "null"
      ],
      "description": "Temperature of the handling unit."
    },
    "temperatureUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the temperature property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "status": {
      "type": "string",
      "maxLength": 10,
      "description": "Current location status of this specific handling unit."
    },
    "statusComment": {
      "type": "string",
      "maxLength": 120,
      "description": "Additional human-readable comments clarifying the last known status of the freight."
    },
    "volume": {
      "type": [
        "number",
        "null"
      ],
      "description": "Volume of the handling unit."
    },
    "volumeUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the volume property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "weight": {
      "type": [
        "number",
        "null"
      ],
      "description": "Weight of the handling unit."
    },
    "weightUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the weight property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "width": {
      "type": [
        "number",
        "null"
      ],
      "description": "Width of the handling unit."
    },
    "widthUnits": {
      "type": "string",
      "maxLength": 3,
      "description": "Unit of measure for the width property. Note that unit types are configurable and may vary per TruckMate instance."
    },
    "sequence": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Barcode sequence"
    },
    "barcodeId": {
      "type": "integer",
      "description": "Barcode ID, automatically generated"
    },
    "cubePolicyId": {
      "type": "integer",
      "description": "ID of cube policy if used"
    },
    "cubePolicyValue": {
      "type": [
        "number",
        "null"
      ],
      "description": "Value of cube policy if used"
    },
    "doorNumber": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Terminal door number"
    },
    "handlingNotes": {
      "type": "string",
      "maxLength": 40,
      "description": "Free-form notes that can be entered by pickup/delivery driver"
    },
    "intact": {
      "type": "string",
      "enum": [
        "False",
        "True",
        ""
      ],
      "description": "Describes the pieces/pallet state"
    },
    "isVerified": {
      "type": "string",
      "enum": [
        "False",
        "True",
        ""
      ],
      "description": "Order is verified"
    },
    "lifts": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Number of sets of stairs at location"
    },
    "orderId": {
      "type": "integer",
      "description": "Detail line ID of order"
    },
    "orderDetailId": {
      "type": "integer",
      "description": "Sequence of order"
    },
    "mobileScanned": {
      "type": "string",
      "enum": [
        "False",
        "True",
        ""
      ],
      "description": "Has been scanned by handheld device"
    },
    "palletGroupId": {
      "type": "string",
      "maxLength": 50,
      "description": "Pallet group ID"
    },
    "pieceCubing": {
      "type": "string",
      "enum": [
        "False",
        "True",
        ""
      ],
      "description": "Piece cubing"
    },
    "printStatus": {
      "type": "string",
      "maxLength": 10,
      "description": "Printing status"
    },
    "tripNumber": {
      "type": "integer",
      "description": "Trip number"
    },
    "user1": {
      "type": "string",
      "maxLength": 80,
      "description": "Expansion field #1 for any additional user-provided information"
    },
    "user2": {
      "type": "string",
      "maxLength": 80,
      "description": "Expansion field #2 for any additional user-provided information"
    },
    "user3": {
      "type": "string",
      "maxLength": 80,
      "description": "Expansion field #3 for any additional user-provided information"
    },
    "user4": {
      "type": "string",
      "maxLength": 80,
      "description": "Expansion field #4 for any additional user-provided information"
    },
    "user5": {
      "type": "string",
      "maxLength": 80,
      "description": "Expansion field #5 for any additional user-provided information"
    }
  }
}