Qualifiers
| OTM Reference Number Qualifier | IoT Field Name | Description |
|---|---|---|
| CAPACITYPROVIDERACCOUNTCODE | capacityProviderAccountCode | The code for the requested capacity provider account that was used for authentication with the capacity provider's API. |
| DOT_NUMBER | Carrier’s Department of Transportation Number | |
| INVOICE | InvoiceNumber | Invoice Number |
| IOT_BILL_OF_LADING | billOfLading | IOT Bill of Lading |
| IOT_FM_ID | Shipment ID to link OTM Shipment to IOT Trip. | |
| MC_NUMBER | Carrier’s Operating Authority(MC Number | |
| PORTABLETRACKERID | portableTrackerId | Portable Trackers ID, if location source is "Portable". |
| PRIMARYDRIVERALTERNATEMOBILENUMBER |
Alternate mobile phone number of the driver executing the shipment.
|
|
| PRIMARYDRIVERMOBILENUMBER | driverMobileNumber |
Mobile phone number of the driver executing the shipment. This field is mandatory for tracking Shipment through Data Aggregator integration.
|
| SECONDARYDRIVERALTERNATEMOBILENUMBER | Alternate mobile phone number of the second driver executing the shipment. | |
| SECONDARYDRIVERMOBILENUMBER |
Mobile phone number of the second driver executing the shipment.
|
|
| SYSTEM | ||
| VEHICLEELDID | vehicleELDID |
Vehicle Identifier is an ELD registration number for a vehicle in North America. This ID is used to fetch vehicle information (position, other parameters) from data providers. This is critical for tracking vehicles of certain carriers in North America.
|
| VEHICLELICENSEPLATE |
vehicleLicensePlate or (vehicleRegNumber) |
License Plate info of Truck carrying the shipment. This field is needed for tracking Shipment through Data Aggregator integration.
|
| OTM Reference Number Qualifier | IoT Field Name | Description |
|---|---|---|
| IOT_CARRIER_TRACKINGNUM | Trip.carrierRefNum | IOT Carrier Tracking Number |
| IOT_DEVICE_HARDWARE_ID_1 | Trip.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_HARDWARE_ID_2 | Trip.trackers | IOT Cargo Monitoring Device 2 |
| IOT_DEVICE_NAME_1 | Trip.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_NAME_2 | Trip.trackers | IOT Cargo Monitoring Device 2 |
| OTM Reference Number Qualifier | IoT Field Name | Description |
|---|---|---|
| IOT_ASSET_NAME | Trip.ShipUnit.assetRef | IOT Asset Name |
| IOT_DEVICE_HARDWARE_ID_1 | Trip.ShipUnit.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_HARDWARE_ID_2 | Trip.ShipUnit.trackers | IOT Cargo Monitoring Device 2 |
| IOT_DEVICE_NAME_1 | Trip.ShipUnit.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_NAME_2 | Trip.ShipUnit.trackers | IOT Cargo Monitoring Device 2 |
| OTM Reference Number Qualifier | IoT Field Name | Description |
|---|---|---|
| IOT_ASSET_NAME | Trip.ShipItem | IOT Asset Name |
| IOT_DEVICE_HARDWARE_ID_1 | Trip.ShipItem.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_HARDWARE_ID_2 | Trip.ShipItem.trackers | IOT Cargo Monitoring Device 2 |
| IOT_DEVICE_NAME_1 | Trip.ShipItem.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_NAME_2 | Trip.ShipItem.trackers | IOT Cargo Monitoring Device 2 |
| OTM Reference Number Qualifier | IoT Field Name | Description |
|---|---|---|
| IOT_ASSET_NAME | assetRef | IOT Asset Name |
| IOT_DEVICE_HARDWARE_ID_1 | trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_HARDWARE_ID_2 | trackers | IOT Cargo Monitoring Device 2 |
| IOT_DEVICE_NAME_1 | trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_NAME_2 | trackers | IOT Cargo Monitoring Device 2 |
| OTM Reference Number Qualifier | IoT Field Name | Description |
|---|---|---|
| IOT_ASSET_NAME | assetRef | IOT Asset Name |
| IOT_DEVICE_HARDWARE_ID_1 | trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_HARDWARE_ID_2 | trackers | IOT Cargo Monitoring Device 2 |
| IOT_DEVICE_NAME_1 | trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_NAME_2 | trackers | IOT Cargo Monitoring Device 2 |
| OTM Equipment Attribute Qualifier | IoT Field Name | Description |
|---|---|---|
| IOT_ASSET_NAME | Trip.TripEquipmentInfo.assetRef | IOT Asset Name |
| IOT_DEVICE_HARDWARE_ID_1 | Trip.TripEquipmentInfo.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_HARDWARE_ID_2 | Trip.TripEquipmentInfo.trackers | IOT Cargo Monitoring Device 2 |
| IOT_DEVICE_NAME_1 | Trip.TripEquipmentInfo.trackers | IOT Cargo Monitoring Device 1 |
| IOT_DEVICE_NAME_2 | Trip.TripEquipmentInfo.trackers | IOT Cargo Monitoring Device 2 |
| IOT_EQUIPMENT_TYPE | Trip.Equipment.equipmentType | IOT Equipment Type |
| IOT_EQUIPMENT_LENGTH_UOM | Trip.Equipment.equipmentLength.unitOfMeasure | IOT Equipment Length UOM |
| IOT_EQUIPMENT_LENGTH_VALUE | Trip.Equipment.equipmentLength.value | IOT Equipment Length Value |
| IOT_EQUIPMENT_MAX_VOLUME_UOM | Trip.Equipment.equipmentMaxVolume.unitOfMeasure | IOT Equipment Max Volume UOM |
| IOT_EQUIPMENT_MAX_VOLUME_VALUE | Trip.Equipment.equipmentMaxVolume.value | IOT Equipment Max Volume Value |
| IOT_EQUIPMENT_MAX_WEIGHT_UOM | Trip.Equipment.equipmentMaxWeight.unitOfMeasure | IOT Equipment Max Weight UOM |
| IOT_EQUIPMENT_MAX_WEIGHT_VALUE | Trip.Equipment.equipmentMaxWeight.value | IOT Equipment Max Weight Value |
| OTM Remark Qualifier | IoT Field Name | Description |
|---|---|---|
| IOT_SPECIAL_INSTRUCTION | IOT Cargo Monitoring Special Instruction | |
| IOT_FM_LINK | IOT Fleet Monitoring Trip Link | |
| IOT_DELIVERY_NOTE | Delivery Note that Drivers can post on to IoT and sent back to OTM as part of a Tracking Event. | |
| IOT_DRIVER_EVENT | Driver Event that is recorded on the IoT side and sent to OTM as part of a Tracking Event. |