Trimble · Schema
order
ConstructionTransportationGeospatialGPSMappingBIMFleet ManagementCollaborationAgriculture
Properties
| Name | Type | Description |
|---|---|---|
| orderId | integer | |
| opCode | string | |
| billNumber | string | |
| startZone | string | |
| startZoneDescription | string | |
| endZone | string | |
| endZoneDescription | string | |
| status | string | |
| statusDescription | string | |
| longStatusDescription | string | |
| currentStatusBehaviour | string | |
| currentZone | string | |
| currentZoneDescription | string | |
| actualDelivery | stringnull | |
| actualPickup | stringnull | |
| createdBy | string | |
| createdTime | stringnull | |
| extraStops | string | |
| masterOrder | integernull | |
| noStops | integernull | |
| parentOrder | integernull | |
| siteId | string | |
| slmDaysSum | integernull | |
| billDate | stringnull | |
| billNumberKey | string | |
| billToCode | string | |
| billToName | string | |
| billTo | string | |
| cashCollect | string | |
| pallets | numbernull | |
| pieces | integernull | |
| length | numbernull | |
| cube | numbernull | |
| weight | numbernull | |
| isDangerousGoods | string | |
| highValue | string | |
| serviceLevel | string | |
| commodity | string | |
| pickUpBy | stringnull | |
| pickUpByEnd | stringnull | |
| latestPickUpBy | stringnull | |
| deliverBy | stringnull | |
| deliverByEnd | stringnull | |
| deliveryApptReq | string | |
| deliveryApptMade | string | |
| deliveryAppt | stringnull | |
| deliveryTerminal | string | |
| pickUpApptMade | string | |
| pickUpApptReq | string | |
| pickUpAppt | stringnull | |
| pickupTerminal | string | |
| pickUpDriver | string | |
| tax1 | numbernull | |
| tax2 | numbernull | |
| totalCharges | numbernull | |
| charges | numbernull | |
| currencyCode | string | |
| declaredValue | numbernull | |
| terminalZone | string | |
| trailerNumber | string | |
| user1 | string | |
| user2 | string | |
| user3 | string | |
| user4 | string | |
| user5 | string | |
| user6 | string | |
| user7 | string | |
| user8 | string | |
| user9 | string | |
| user10 | string | |
| pickupDone | string | |
| latitude | numbernull | |
| longitude | numbernull | |
| currentTrip | integernull | |
| nextTrip | integernull | |
| startStopStatus | integernull | |
| endStopStatus | integernull | |
| billType | string | |
| billingAuditNumber | integernull | |
| updatedTimestamp | stringnull | |
| createdTimestamp | stringnull | |
| webUsername | string | |
| noCharge | string | |
| estimatedDeliveryDate | stringnull | |
| isCsa | string | |
| isTarped | string | |
| isFast | string | |
| isExclusive | string | |
| exclusiveOverride | string | |
| codAmount | numbernull | |
| deliveryDriver1 | string | |
| deliveryDriver2 | string | |
| deliveryPowerUnit1 | string | |
| deliveryPowerUnit2 | string | |
| deliveryTrailer1 | string | |
| deliveryTrailer2 | string | |
| destinationSpotTrailer | string | |
| originSpotTrailer | string | |
| pickupDriver2 | string | |
| pickupPowerUnit1 | string | |
| pickupPowerUnit2 | string | |
| pickupTrailer1 | string | |
| pickupTrailer2 | string | |
| isApproved | string | |
| webStatus | string | |
| webUpdate | string | |
| webAccept | string | |
| quoteId | integernull | |
| distance | numbernull | |
| distanceUnits | string | |
| requestedEquipment | string | |
| temperature | numbernull | |
| volume | numbernull | |
| piecesUnits | string | |
| weightUnits | string | |
| lengthUnits | string | |
| cubeUnits | string | |
| volumeUnits | string | |
| areaUnits | string | |
| timeUnits | string | |
| palletUnits | string | |
| temperatureUnits | string | |
| area | numbernull | |
| ratingTerms | string | |
| salesAgent | string | |
| carrierAgent | string | |
| caller | object | |
| shipper | object | |
| careOf | object | |
| otherContact | object | |
| consignee | object | |
| pickupAt | object | |
| xrefCode | object | |
| intermodal | object | |
| billToCustomer | object | |
| quoteStatus | object | |
| slmDates | object | |
| aCharges | array | |
| details | array | |
| osds | array | |
| shipInstructs | array | |
| traceNumbers | array | |
| notes | array | |
| interliners | array | |
| statusHistory | array | |
| pods | array | |
| dangerousGoods | array | |
| customDefs | array | |
| checklist | array | |
| terminalPlans | array | |
| billing | array | |
| xStops | array |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/trimble/json-schema/trimble-order-schema.json",
"title": "order",
"x-generated": "2026-11-11",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/trimble-truckmate-openapi.yml#/components/schemas/order",
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"readOnly": true
},
"opCode": {
"type": "string",
"maxLength": 10
},
"billNumber": {
"type": "string",
"maxLength": 20,
"readOnly": true
},
"startZone": {
"type": "string",
"maxLength": 10
},
"startZoneDescription": {
"type": "string",
"maxLength": 30,
"readOnly": true
},
"endZone": {
"type": "string",
"maxLength": 10
},
"endZoneDescription": {
"type": "string",
"maxLength": 30,
"readOnly": true
},
"status": {
"type": "string",
"maxLength": 10
},
"statusDescription": {
"type": "string",
"maxLength": 30
},
"longStatusDescription": {
"type": "string",
"maxLength": 131072
},
"currentStatusBehaviour": {
"type": "string",
"maxLength": 1
},
"currentZone": {
"type": "string",
"maxLength": 10,
"readOnly": true
},
"currentZoneDescription": {
"type": "string",
"maxLength": 30,
"readOnly": true
},
"actualDelivery": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"actualPickup": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"createdBy": {
"type": "string",
"maxLength": 128,
"readOnly": true
},
"createdTime": {
"type": [
"string",
"null"
],
"readOnly": true,
"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))?$"
}
]
},
"extraStops": {
"type": "string",
"readOnly": true,
"enum": [
"False",
"True",
"Child",
""
]
},
"masterOrder": {
"type": [
"integer",
"null"
],
"readOnly": true
},
"noStops": {
"type": [
"integer",
"null"
],
"readOnly": true
},
"parentOrder": {
"type": [
"integer",
"null"
],
"readOnly": true
},
"siteId": {
"type": "string",
"maxLength": 10
},
"slmDaysSum": {
"type": [
"integer",
"null"
],
"readOnly": true
},
"billDate": {
"type": [
"string",
"null"
],
"readOnly": true,
"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))?$"
}
]
},
"billNumberKey": {
"type": "string",
"maxLength": 32,
"readOnly": true
},
"billToCode": {
"type": "string",
"maxLength": 10
},
"billToName": {
"type": "string",
"maxLength": 40
},
"billTo": {
"type": "string",
"enum": [
"C",
"O",
"D",
"T",
"I",
"R",
""
]
},
"cashCollect": {
"type": "string",
"enum": [
"False",
"True",
""
],
"readOnly": true
},
"pallets": {
"type": [
"number",
"null"
]
},
"pieces": {
"type": [
"integer",
"null"
]
},
"length": {
"type": [
"number",
"null"
]
},
"cube": {
"type": [
"number",
"null"
]
},
"weight": {
"type": [
"number",
"null"
]
},
"isDangerousGoods": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"highValue": {
"type": "string",
"enum": [
"False",
"True",
""
],
"readOnly": true
},
"serviceLevel": {
"type": "string",
"maxLength": 10
},
"commodity": {
"type": "string",
"maxLength": 10
},
"pickUpBy": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"pickUpByEnd": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"latestPickUpBy": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"deliverBy": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"deliverByEnd": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"deliveryApptReq": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"deliveryApptMade": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"deliveryAppt": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"deliveryTerminal": {
"type": "string",
"maxLength": 10,
"readOnly": true
},
"pickUpApptMade": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"pickUpApptReq": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"pickUpAppt": {
"type": [
"string",
"null"
],
"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))?$"
}
]
},
"pickupTerminal": {
"type": "string",
"maxLength": 10,
"readOnly": true
},
"pickUpDriver": {
"type": "string",
"maxLength": 10
},
"tax1": {
"type": [
"number",
"null"
],
"readOnly": true
},
"tax2": {
"type": [
"number",
"null"
],
"readOnly": true
},
"totalCharges": {
"type": [
"number",
"null"
],
"readOnly": true
},
"charges": {
"type": [
"number",
"null"
],
"readOnly": true
},
"currencyCode": {
"type": "string",
"maxLength": 3
},
"declaredValue": {
"type": [
"number",
"null"
]
},
"terminalZone": {
"type": "string",
"maxLength": 10,
"readOnly": true
},
"trailerNumber": {
"type": "string",
"maxLength": 80,
"readOnly": 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
},
"pickupDone": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"latitude": {
"type": [
"number",
"null"
]
},
"longitude": {
"type": [
"number",
"null"
]
},
"currentTrip": {
"type": [
"integer",
"null"
]
},
"nextTrip": {
"type": [
"integer",
"null"
]
},
"startStopStatus": {
"type": [
"integer",
"null"
]
},
"endStopStatus": {
"type": [
"integer",
"null"
]
},
"billType": {
"type": "string",
"maxLength": 10,
"readOnly": true
},
"billingAuditNumber": {
"type": [
"integer",
"null"
],
"readOnly": true
},
"updatedTimestamp": {
"type": [
"string",
"null"
],
"readOnly": true,
"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))?$"
}
]
},
"createdTimestamp": {
"type": [
"string",
"null"
],
"readOnly": true,
"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))?$"
}
]
},
"webUsername": {
"type": "string",
"maxLength": 128,
"readOnly": true
},
"noCharge": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"estimatedDeliveryDate": {
"type": [
"string",
"null"
],
"readOnly": true,
"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))?$"
}
]
},
"isCsa": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"isTarped": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"isFast": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"isExclusive": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"exclusiveOverride": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"codAmount": {
"type": [
"number",
"null"
]
},
"deliveryDriver1": {
"type": "string",
"maxLength": 10
},
"deliveryDriver2": {
"type": "string",
"maxLength": 10
},
"deliveryPowerUnit1": {
"type": "string",
"maxLength": 10
},
"deliveryPowerUnit2": {
"type": "string",
"maxLength": 10
},
"deliveryTrailer1": {
"type": "string",
"maxLength": 10
},
"deliveryTrailer2": {
"type": "string",
"maxLength": 10
},
"destinationSpotTrailer": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"originSpotTrailer": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"pickupDriver2": {
"type": "string",
"maxLength": 10
},
"pickupPowerUnit1": {
"type": "string",
"maxLength": 10
},
"pickupPowerUnit2": {
"type": "string",
"maxLength": 10
},
"pickupTrailer1": {
"type": "string",
"maxLength": 10
},
"pickupTrailer2": {
"type": "string",
"maxLength": 10
},
"isApproved": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"webStatus": {
"type": "string",
"maxLength": 10,
"readOnly": true
},
"webUpdate": {
"type": "string",
"readOnly": true,
"enum": [
"False",
"Done",
"WIP",
""
]
},
"webAccept": {
"type": "string",
"enum": [
"False",
"True",
""
],
"readOnly": true
},
"quoteId": {
"type": [
"integer",
"null"
],
"readOnly": true
},
"distance": {
"type": [
"number",
"null"
],
"readOnly": true
},
"distanceUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"requestedEquipment": {
"type": "string",
"readOnly": true,
"maxLength": 20
},
"temperature": {
"type": [
"number",
"null"
],
"readOnly": true
},
"volume": {
"type": [
"number",
"null"
],
"readOnly": true
},
"piecesUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"weightUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"lengthUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"cubeUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"volumeUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"areaUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"timeUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"palletUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"temperatureUnits": {
"type": "string",
"readOnly": true,
"maxLength": 3
},
"area": {
"type": [
"number",
"null"
],
"readOnly": true
},
"ratingTerms": {
"type": "string",
"readOnly": true,
"enum": [
"adhoc",
"collect",
"notApplicable",
"prepaid",
"thirdParty",
""
]
},
"salesAgent": {
"type": "string",
"maxLength": 20
},
"carrierAgent": {
"type": "string",
"maxLength": 10
},
"caller": {
"$ref": "#/$defs/caller"
},
"shipper": {
"$ref": "#/$defs/shipper"
},
"careOf": {
"$ref": "#/$defs/careOf"
},
"otherContact": {
"$ref": "#/$defs/otherContact"
},
"consignee": {
"$ref": "#/$defs/consignee"
},
"pickupAt": {
"$ref": "#/$defs/pickupAt"
},
"xrefCode": {
"$ref": "#/$defs/xrefCode"
},
"intermodal": {
"$ref": "#/$defs/intermodal"
},
"billToCustomer": {
"$ref": "#/$defs/orderBillToCustomer"
},
"quoteStatus": {
"$ref": "#/$defs/quoteStatus"
},
"slmDates": {
"$ref": "#/$defs/orderSlmDates"
},
"aCharges": {
"type": "array",
"items": {
"$ref": "#/$defs/aCharge"
}
},
"details": {
"type": "array",
"items": {
"$ref": "#/$defs/detail"
}
},
"osds": {
"type": "array",
"items": {
"$ref": "#/$defs/osd"
}
},
"shipInstructs": {
"type": "array",
"items": {
"$ref": "#/$defs/shipInstruct"
}
},
"traceNumbers": {
"type": "array",
"items": {
"$ref": "#/$defs/traceNumber"
}
},
"notes": {
"type": "array",
"items": {
"$ref": "#/$defs/note"
}
},
"interliners": {
"type": "array",
"items": {
"$ref": "#/$defs/interliner"
}
},
"statusHistory": {
"type": "array",
"items": {
"$ref": "#/$defs/statusHistory"
}
},
"pods": {
"type": "array",
"items": {
"$ref": "#/$defs/pod"
}
},
"dangerousGoods": {
"type": "array",
"items": {
"$ref": "#/$defs/dangerousGoods"
}
},
"customDefs": {
"type": "array",
"items": {
"$ref": "#/$defs/CustomDefsActualResponse"
}
},
"checklist": {
"type": "array",
"items": {
"$ref": "#/$defs/orderChecklist"
}
},
"terminalPlans": {
"type": "array",
"items": {
"$ref": "#/$defs/terminalPlan"
}
},
"billing": {
"type": "array",
"items": {
"$ref": "#/$defs/billing"
}
},
"xStops": {
"type": "array",
"items": {
"$ref": "#/$defs/xStop"
}
}
},
"$defs": {
"ACachargecurrencyrates": {
"type": "object",
"properties": {
"currency": {
"type": "string",
"maxLength": 3
},
"quantity": {
"type": [
"number",
"null"
]
},
"rate": {
"type": [
"number",
"null"
]
},
"amount": {
"type": [
"number",
"null"
]
},
"foreignExchangeRate": {
"type": [
"number",
"null"
]
}
}
},
"CustomDefsActualResponse": {
"type": "object",
"properties": {
"customLabel": {
"type": "string",
"description": "Label of a custom defined field",
"maxLength": 20
},
"sourceId": {
"type": "string",
"description": "References the primary key of the table to which the custom defined field is attached to",
"maxLength": 100
},
"customDefId": {
"type": "integer",
"description": "Custom define field ID"
},
"customValue": {
"oneOf": [
{
"type": "string",
"maxLength": 255
},
{
"type": "number"
}
]
}
}
},
"aCharge": {
"type": "object",
"properties": {
"aChargeCode": {
"type": "string",
"maxLength": 10
},
"aChargeId": {
"type": "integer"
},
"aChargeType": {
"type": "string",
"maxLength": 40
},
"autoAssigned": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"chargeAmount": {
"type": [
"number",
"null"
]
},
"orderId": {
"type": "integer"
},
"functionalAmount": {
"type": [
"number",
"null"
]
},
"isManual": {
"type": "string",
"enum": [
"False",
"True",
""
]
},
"notation": {
"type": "string",
"maxLength": 40
},
"quantity": {
"type": [
"number",
"null"
]
},
"rate": {
"type": [
"number",
"null"
]
},
"actualQuantity": {
"type": [
"number",
"null"
]
},
"threshold": {
"type": [
"number",
"null"
]
},
"increment": {
"type": [
"number",
"null"
]
},
"description": {
"type": "string",
"maxLength": 40
},
"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
},
"aChargeCurrencyRates": {
"$ref": "#/$defs/ACachargecurrencyrates"
}
}
},
"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"
}
}
},
"billing": {
"type": "object",
"properties": {
"basis": {
"type": "string",
"maxLength": 10
},
"basisDescription": {
"type": "string",
"maxLength": 40
},
"rateQuantity": {
"type": [
"number",
"null"
]
},
"rateAmount": {
"type": [
"number",
"null"
]
},
"currencyCode": {
"type": "string",
"maxLength": 3
}
}
},
"caller": {
"type": "object",
"properties": {
"clientId": {
"type": "string",
"maxLength": 10
},
"name": {
"type": "string",
"maxLength": 40
},
"address": {
"type": "string",
"maxLength": 81
},
"address1": {
"type": "string",
"maxLength": 40
},
"address2": {
"type": "string",
"maxLength": 40
},
"city": {
"type": "string",
"maxLength": 30
},
"province": {
"type": "string",
"maxLength": 4
},
"postalCode": {
"type": "string",
"maxLength": 10
},
"contact": {
# --- truncated at 32 KB (111 KB total) ---
# Full source: https://artifacts.apis.io/trimble/json-schema/trimble-order-schema.json
Work with this as data
Every JSON Schema 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 schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.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.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/trimble-order"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.