agreement field to the LoadTrackingVehicleAssignmentRead schema on both load tracking endpoints. When a vehicle was declared on the load, agreement reports whether vehicles matched independently from location data corroborate that declaration. The endpoint descriptions have been updated to explain this behaviour.
Minor Release: Backward-compatible addition. The
agreement field is new and required in the response schema; existing integrations that do not read it are unaffected.Schema Changes
agreement field on vehicle_assignment — declared assignments
agreement field on vehicle_assignment — declared assignments
Updated endpoints:After:Impact:
GET /v2/visibility/loads/trackingGET /v2/visibility/loads/{load_id}/tracking
LoadTrackingVehicleAssignmentRead schema now includes a required agreement field. This field is present when source is declared and indicates whether vehicles matched from location data back up the declared vehicle assignment.The endpoint descriptions have been updated to reflect this: “For a declared vehicle, agreement says whether the vehicles matched from location data back it up.”Before:- The
agreementfield is new and required in the response schema - It only applies to
declaredvehicle assignments (i.e. when you sent vehicle identifiers when posting or editing the load) - Integrations that do not read
agreementrequire no changes
Integration Notes
1
Read the agreement field for declared assignments
If your integration uses declared vehicle assignments, you can now read
agreement to understand whether location data corroborates the declared vehicle:2
No action required for existing integrations
The
agreement field is additive. If your integration does not read it, no changes are needed. The field is only present on declared vehicle assignments.Need Help?
API Reference
View complete endpoint documentation for the Visibility API
Contact Support
Questions about your integration? Our team is here to help