Beta Feature: This functionality is currently in beta. You
may experience changes or limited support as we continue to improve it.
movement.cargo. commodities
movement.cargo.commodities. description
movement.cargo.commodities. isStackable
movement.cargo.commodities. itemReference
movement.cargo.commodities.itemReference. type
Typically one of the ReferenceType enum values
but subject to change
Available options:
ORDER_REFERENCE,
PURCHASE_ORDER,
BILL_OF_LADING,
INVOICE,
SHIPMENT,
SALES_ORDER,
TRACKING,
DELIVERY,
CUSTOMER_REFERENCE,
LOAD,
CONTAINER,
MASTER_BILL_OF_LADING,
BOOKING,
SEAL,
PICKUP,
APPOINTMENT,
OTHER
movement.cargo.commodities.itemReference. value
movement.cargo.commodities. dimensions
movement.cargo.commodities.dimensions. height
movement.cargo.commodities.dimensions.height. value
movement.cargo.commodities.dimensions.height. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.cargo.commodities.dimensions. width
movement.cargo.commodities.dimensions.width. value
movement.cargo.commodities.dimensions.width. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.cargo.commodities.dimensions. length
movement.cargo.commodities.dimensions.length. value
movement.cargo.commodities.dimensions.length. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.cargo.commodities. weight
movement.cargo.commodities.weight. units
Available options:
LB,
KG
movement.cargo.commodities.weight. value
movement.cargo.commodities. hazmat
movement.cargo.commodities.hazmat. classifications
movement.cargo.commodities.hazmat.classifications. qualifier
movement.cargo.commodities.hazmat.classifications. hazardClass
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
1.1,
1.2,
1.3,
1.4,
1.5,
1.6,
2.1,
2.2,
2.3,
4.1,
4.2,
4.3,
5.1,
5.2,
6.1,
6.2
movement.cargo.commodities.hazmat. contact
movement.cargo.commodities.hazmat.contact. carrierId
movement.cargo.commodities.hazmat.contact. customerId
movement.cargo.commodities.hazmat.contact. email
movement.cargo.commodities.hazmat.contact. phone
movement.cargo.commodities.hazmat.contact. name
movement.cargo.commodities.hazmat.contact. id
movement.cargo.commodities.hazmat.contact. reference
movement.cargo.commodities.hazmat.contact.reference. type
Typically one of the ReferenceType enum values
but subject to change
Available options:
ORDER_REFERENCE,
PURCHASE_ORDER,
BILL_OF_LADING,
INVOICE,
SHIPMENT,
SALES_ORDER,
TRACKING,
DELIVERY,
CUSTOMER_REFERENCE,
LOAD,
CONTAINER,
MASTER_BILL_OF_LADING,
BOOKING,
SEAL,
PICKUP,
APPOINTMENT,
OTHER
movement.cargo.commodities.hazmat.contact.reference. value
movement.cargo.commodities.hazmat. packingGroup
movement.cargo.commodities.hazmat. unNumber
movement.cargo.commodities.hazmat. weight
movement.cargo.commodities.hazmat.weight. units
Available options:
LB,
KG
movement.cargo.commodities.hazmat.weight. value
movement.cargo.commodities. nmfcCode
movement.cargo.commodities. freightClass
movement.cargo.commodities. pieceUnits
Available options:
BAGS,
BALES,
BOTTLES,
BOXES,
BUNDLES,
CARTONS,
CASES,
CRATES,
DRUMS,
PACKAGES,
PAILS,
PALLETS,
PIECES,
ROLLS,
SKIDS,
TRUCKLOADS,
TUBES,
UNITS,
VEHICLES
movement.cargo.commodities. pieceQuantity
movement.cargo.commodities. handlingUnits
Available options:
BAGS,
BALES,
BOTTLES,
BOXES,
BUNDLES,
CARTONS,
CASES,
CRATES,
DRUMS,
PACKAGES,
PAILS,
PALLETS,
PIECES,
ROLLS,
SKIDS,
TRUCKLOADS,
TUBES,
UNITS,
VEHICLES
movement.cargo.commodities. handlingQuantity
movement.cargo. declaredValue
movement.cargo.declaredValue. uom
Available options:
USD,
CAD
movement.cargo.declaredValue. value
movement.cargo. dimensions
movement.cargo.dimensions. height
movement.cargo.dimensions.height. value
movement.cargo.dimensions.height. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.cargo.dimensions. width
movement.cargo.dimensions.width. value
movement.cargo.dimensions.width. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.cargo.dimensions. length
movement.cargo.dimensions.length. value
movement.cargo.dimensions.length. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.cargo. totalWeight
movement.cargo.totalWeight. units
Available options:
LB,
KG
movement.cargo.totalWeight. value
movement. equipmentOptions
movement.equipmentOptions. type
Typically one of the EquipmentType enum values but subject to change
Available options:
BOX_TRUCK,
CARGO_VAN,
CONESTOGA,
CONTAINER,
DOUBLE_DROP,
DRY_VAN,
FLATBED,
HOT_SHOT,
LOW_BOY,
POWER_ONLY,
REEFER,
REMOVABLE_GOOSENECK,
SPRINTER_VAN,
STEP_DECK,
STRAIGHT_TRUCK,
AUTO_CARRIER,
VAN_OR_REEFER,
FLATBED_OR_STEP_DECK,
OTHER
movement.equipmentOptions. equipmentLength
movement.equipmentOptions.equipmentLength. value
movement.equipmentOptions.equipmentLength. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.equipmentOptions. temperature
movement.equipmentOptions.temperature. units
movement.equipmentOptions.temperature. max
movement.equipmentOptions.temperature. min
movement.equipmentOptions. description
movement.customer. externalIds
movement.customer.externalIds. type
Typically one of the CustomerExternalIdentifierType enum values
but subject to change
Available options:
ALJEX,
AVRL,
BITFREIGHTER_RATING,
CUSTOM,
DAT,
GENLOGS,
GREENSCREENS,
HIGHWAY,
HOSTED_MCLEOD,
LEGACY_MERCURYGATE,
MCLEOD,
MCLEOD_HOSTED,
MERCURYGATE,
ORDERFUL,
SONAR,
STEDI,
STRATEGY_LIVE,
TABI,
TAI,
TEST,
THREE_PL,
TRANSFIX_RATING,
TURVO,
TRUCKSTOP,
VOOMA_PUBLIC_API,
MICROSOFT,
MICROSOFT_TEAMS,
SLACK
movement.customer.externalIds. value
movement.customer. contacts
movement.customer.contacts. carrierId
movement.customer.contacts. customerId
movement.customer.contacts. email
movement.customer.contacts. phone
movement.customer.contacts. name
movement.customer.contacts. id
movement.route.stops. location
movement.route.stops.location. externalIds
movement.route.stops.location.externalIds. type
Typically one of the LocationExternalIdentifierType enum values
but subject to change
Available options:
CUSTOM,
GOOGLE_PLACES,
TURVO
movement.route.stops.location.externalIds. value
movement.route.stops.location. address
movement.route.stops.location.address. country
movement.route.stops.location.address. postalCode
movement.route.stops.location.address. city
movement.route.stops.location.address. state
movement.route.stops.location.address. addressTwo
movement.route.stops.location.address. addressOne
movement.route.stops.location. geoCoordinates
movement.route.stops.location.geoCoordinates. longitude
movement.route.stops.location.geoCoordinates. latitude
movement.route.stops.location. name
movement.route.stops.location. id
movement.route.stops. type
Available options:
PICKUP,
DELIVERY
movement.route.stops. stopReferences
movement.route.stops.stopReferences. type
Typically one of the ReferenceType enum values
but subject to change
Available options:
ORDER_REFERENCE,
PURCHASE_ORDER,
BILL_OF_LADING,
INVOICE,
SHIPMENT,
SALES_ORDER,
TRACKING,
DELIVERY,
CUSTOMER_REFERENCE,
LOAD,
CONTAINER,
MASTER_BILL_OF_LADING,
BOOKING,
SEAL,
PICKUP,
APPOINTMENT,
OTHER
movement.route.stops.stopReferences. value
movement.route.stops. externalNotes
movement.route.stops. internalNotes
movement.route.stops. accessorials
Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12
Option 13
Option 14
Option 15
Option 16
Option 17
Option 18
Option 19
Option 20
Option 21
Option 22
Option 23
movement.route.stops.accessorials. size
movement.route.stops.accessorials.size. value
movement.route.stops.accessorials.size. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.route.stops.accessorials. type
Available options:
TARPING
movement.route.stops. contact
movement.route.stops.contact. carrierId
movement.route.stops.contact. customerId
movement.route.stops.contact. email
movement.route.stops.contact. phone
movement.route.stops.contact. name
movement.route.stops.contact. id
movement.route.stops. commodities
movement.route.stops.commodities. description
movement.route.stops.commodities. isStackable
movement.route.stops.commodities. itemReference
movement.route.stops.commodities.itemReference. type
Typically one of the ReferenceType enum values
but subject to change
Available options:
ORDER_REFERENCE,
PURCHASE_ORDER,
BILL_OF_LADING,
INVOICE,
SHIPMENT,
SALES_ORDER,
TRACKING,
DELIVERY,
CUSTOMER_REFERENCE,
LOAD,
CONTAINER,
MASTER_BILL_OF_LADING,
BOOKING,
SEAL,
PICKUP,
APPOINTMENT,
OTHER
movement.route.stops.commodities.itemReference. value
movement.route.stops.commodities. dimensions
movement.route.stops.commodities.dimensions. height
movement.route.stops.commodities.dimensions.height. value
movement.route.stops.commodities.dimensions.height. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.route.stops.commodities.dimensions. width
movement.route.stops.commodities.dimensions.width. value
movement.route.stops.commodities.dimensions.width. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.route.stops.commodities.dimensions. length
movement.route.stops.commodities.dimensions.length. value
movement.route.stops.commodities.dimensions.length. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.route.stops.commodities. weight
movement.route.stops.commodities.weight. units
Available options:
LB,
KG
movement.route.stops.commodities.weight. value
movement.route.stops.commodities. hazmat
movement.route.stops.commodities.hazmat. classifications
movement.route.stops.commodities.hazmat.classifications. qualifier
movement.route.stops.commodities.hazmat.classifications. hazardClass
Available options:
1,
2,
3,
4,
5,
6,
7,
8,
9,
1.1,
1.2,
1.3,
1.4,
1.5,
1.6,
2.1,
2.2,
2.3,
4.1,
4.2,
4.3,
5.1,
5.2,
6.1,
6.2
movement.route.stops.commodities.hazmat. contact
movement.route.stops.commodities.hazmat.contact. carrierId
movement.route.stops.commodities.hazmat.contact. customerId
movement.route.stops.commodities.hazmat.contact. email
movement.route.stops.commodities.hazmat.contact. phone
movement.route.stops.commodities.hazmat.contact. name
movement.route.stops.commodities.hazmat.contact. id
movement.route.stops.commodities.hazmat.contact. reference
movement.route.stops.commodities.hazmat.contact.reference. type
Typically one of the ReferenceType enum values
but subject to change
Available options:
ORDER_REFERENCE,
PURCHASE_ORDER,
BILL_OF_LADING,
INVOICE,
SHIPMENT,
SALES_ORDER,
TRACKING,
DELIVERY,
CUSTOMER_REFERENCE,
LOAD,
CONTAINER,
MASTER_BILL_OF_LADING,
BOOKING,
SEAL,
PICKUP,
APPOINTMENT,
OTHER
movement.route.stops.commodities.hazmat.contact.reference. value
movement.route.stops.commodities.hazmat. packingGroup
movement.route.stops.commodities.hazmat. unNumber
movement.route.stops.commodities.hazmat. weight
movement.route.stops.commodities.hazmat.weight. units
Available options:
LB,
KG
movement.route.stops.commodities.hazmat.weight. value
movement.route.stops.commodities. nmfcCode
movement.route.stops.commodities. freightClass
movement.route.stops.commodities. pieceUnits
Available options:
BAGS,
BALES,
BOTTLES,
BOXES,
BUNDLES,
CARTONS,
CASES,
CRATES,
DRUMS,
PACKAGES,
PAILS,
PALLETS,
PIECES,
ROLLS,
SKIDS,
TRUCKLOADS,
TUBES,
UNITS,
VEHICLES
movement.route.stops.commodities. pieceQuantity
movement.route.stops.commodities. handlingUnits
Available options:
BAGS,
BALES,
BOTTLES,
BOXES,
BUNDLES,
CARTONS,
CASES,
CRATES,
DRUMS,
PACKAGES,
PAILS,
PALLETS,
PIECES,
ROLLS,
SKIDS,
TRUCKLOADS,
TUBES,
UNITS,
VEHICLES
movement.route.stops.commodities. handlingQuantity
movement.route.stops. weight
movement.route.stops.weight. units
Available options:
LB,
KG
movement.route.stops.weight. value
movement.route.stops. notes
movement.route.stops. dateTimeRanges
movement.route.stops.dateTimeRanges. startDate
Start date in YYYY-MM-DD format
movement.route.stops.dateTimeRanges. endDate
Optional end date in YYYY-MM-DD format
movement.route.stops.dateTimeRanges. startTime
Optional start time in HH:mm:ss format.
If timezone timezone
movement.route.stops.dateTimeRanges. endTime
Optional end time in HH:mm:ss format
If timezone timezone
movement.route.stops.dateTimeRanges. timezone
Optional timezone in tz database format e.g. "America/New_York" or "UTC".
movement.route.stops.dateTimeRanges. type
Available options:
FACILITY_HOURS,
APPOINTMENT
movement.route.stops. externalIds
movement.route.stops.externalIds. type
Available options:
CUSTOM
movement.route.stops.externalIds. value
movement.route.mileage. uom
Available options:
MI,
KM
movement.route.mileage. value
Typically one of the ReferenceType enum values
but subject to change
Available options:
ORDER_REFERENCE,
PURCHASE_ORDER,
BILL_OF_LADING,
INVOICE,
SHIPMENT,
SALES_ORDER,
TRACKING,
DELIVERY,
CUSTOMER_REFERENCE,
LOAD,
CONTAINER,
MASTER_BILL_OF_LADING,
BOOKING,
SEAL,
PICKUP,
APPOINTMENT,
OTHER
movement.references. value
movement.externalIds. type
Available options:
CUSTOM
movement.externalIds. value
Construct a type with a set of properties K of type T
movement.carrier.carrier. name
movement.carrier.carrier. equipment
movement.carrier.carrier.equipment. equipment
movement.carrier.carrier.equipment.equipment. type
Typically one of the EquipmentType enum values but subject to change
Available options:
BOX_TRUCK,
CARGO_VAN,
CONESTOGA,
CONTAINER,
DOUBLE_DROP,
DRY_VAN,
FLATBED,
HOT_SHOT,
LOW_BOY,
POWER_ONLY,
REEFER,
REMOVABLE_GOOSENECK,
SPRINTER_VAN,
STEP_DECK,
STRAIGHT_TRUCK,
AUTO_CARRIER,
VAN_OR_REEFER,
FLATBED_OR_STEP_DECK,
OTHER
movement.carrier.carrier.equipment.equipment. equipmentLength
movement.carrier.carrier.equipment.equipment.equipmentLength. value
movement.carrier.carrier.equipment.equipment.equipmentLength. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.carrier.carrier.equipment.equipment. temperature
movement.carrier.carrier.equipment.equipment.temperature. units
movement.carrier.carrier.equipment.equipment.temperature. max
movement.carrier.carrier.equipment.equipment.temperature. min
movement.carrier.carrier.equipment.equipment. description
movement.carrier.carrier.equipment. trailerNumber
movement.carrier.carrier.equipment. truckNumber
movement.carrier.carrier. contacts
movement.carrier.carrier.contacts. contact
movement.carrier.carrier.contacts.contact. carrierId
movement.carrier.carrier.contacts.contact. customerId
movement.carrier.carrier.contacts.contact. email
movement.carrier.carrier.contacts.contact. phone
movement.carrier.carrier.contacts.contact. name
movement.carrier.carrier.contacts.contact. id
movement.carrier.carrier.contacts. type
Available options:
DRIVER,
DISPATCH
movement.carrier.carrier. dotNumber
movement.carrier.carrier. mcNumber
movement.carrier.carrier. id
movement.carrier. assignedDispatch
movement.carrier.assignedDispatch. contact
movement.carrier.assignedDispatch.contact. carrierId
movement.carrier.assignedDispatch.contact. customerId
movement.carrier.assignedDispatch.contact. email
movement.carrier.assignedDispatch.contact. phone
movement.carrier.assignedDispatch.contact. name
movement.carrier.assignedDispatch.contact. id
movement.carrier.assignedDispatch. type
Available options:
DRIVER,
DISPATCH
movement.carrier. assignedDriver
movement.carrier.assignedDriver. contact
movement.carrier.assignedDriver.contact. carrierId
movement.carrier.assignedDriver.contact. customerId
movement.carrier.assignedDriver.contact. email
movement.carrier.assignedDriver.contact. phone
movement.carrier.assignedDriver.contact. name
movement.carrier.assignedDriver.contact. id
movement.carrier.assignedDriver. type
Available options:
DRIVER,
DISPATCH
movement.carrier. assignedEquipment
movement.carrier.assignedEquipment. equipment
movement.carrier.assignedEquipment.equipment. type
Typically one of the EquipmentType enum values but subject to change
Available options:
BOX_TRUCK,
CARGO_VAN,
CONESTOGA,
CONTAINER,
DOUBLE_DROP,
DRY_VAN,
FLATBED,
HOT_SHOT,
LOW_BOY,
POWER_ONLY,
REEFER,
REMOVABLE_GOOSENECK,
SPRINTER_VAN,
STEP_DECK,
STRAIGHT_TRUCK,
AUTO_CARRIER,
VAN_OR_REEFER,
FLATBED_OR_STEP_DECK,
OTHER
movement.carrier.assignedEquipment.equipment. equipmentLength
movement.carrier.assignedEquipment.equipment.equipmentLength. value
movement.carrier.assignedEquipment.equipment.equipmentLength. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.carrier.assignedEquipment.equipment. temperature
movement.carrier.assignedEquipment.equipment.temperature. units
movement.carrier.assignedEquipment.equipment.temperature. max
movement.carrier.assignedEquipment.equipment.temperature. min
movement.carrier.assignedEquipment.equipment. description
movement.carrier.assignedEquipment. trailerNumber
movement.carrier.assignedEquipment. truckNumber
movement.financials. costs
movement.financials.costs. lineItems
movement.financials.costs.lineItems. description
movement.financials.costs.lineItems. amount
movement.financials.costs.lineItems.amount. uom
Available options:
USD,
CAD
movement.financials.costs.lineItems.amount. value
movement.financials.costs.lineItems. type
Typically one of the LineItemType enum values but subject to change
Available options:
FREIGHT_FLAT,
FUEL_FLAT,
OTHER
movement.financials. chargesToCustomer
movement.financials.chargesToCustomer. lineItems
movement.financials.chargesToCustomer.lineItems. description
movement.financials.chargesToCustomer.lineItems. amount
movement.financials.chargesToCustomer.lineItems.amount. uom
Available options:
USD,
CAD
movement.financials.chargesToCustomer.lineItems.amount. value
movement.financials.chargesToCustomer.lineItems. type
Typically one of the LineItemType enum values but subject to change
Available options:
FREIGHT_FLAT,
FUEL_FLAT,
OTHER
movement.financials. paymentTerms
Available options:
PREPAID,
COLLECT,
THIRD_PARTY
movement.financials. costNegotiationGuidance
movement.financials.costNegotiationGuidance. maxPrice
movement.financials.costNegotiationGuidance.maxPrice. uom
Available options:
USD,
CAD
movement.financials.costNegotiationGuidance.maxPrice. value
movement.financials.costNegotiationGuidance. startingPrice
movement.financials.costNegotiationGuidance.startingPrice. uom
Available options:
USD,
CAD
movement.financials.costNegotiationGuidance.startingPrice. value
Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12
Option 13
Option 14
Option 15
Option 16
Option 17
Option 18
Option 19
Option 20
Option 21
Option 22
Option 23
movement.accessorials. size
movement.accessorials.size. value
movement.accessorials.size. units
Typically one of the DimensionUnits enum values but subject to change
Available options:
IN,
CM,
FT
movement.accessorials. type
Available options:
TARPING
movement. freightModeDetails
movement.freightModeDetails. mode
Available options:
TRUCKLOAD,
LTL,
PARTIAL_TRUCKLOAD,
INTERMODAL,
DRAYAGE,
PARCEL
movement.freightModeDetails. drayageSubtype
Available options:
IMPORT,
EXPORT
movement.responsibleUser. externalIds
movement.responsibleUser.externalIds. type
Typically one of the UserExternalIdentifierType enum values
but subject to change
Available options:
CUSTOM,
EMAIL,
PHONE,
VOOMA_USERNAME
movement.responsibleUser.externalIds. value
movement.responsibleUser. id
Available options:
movement.updated
