Gate
Register a vehicle at the gate: compliance alerts from Fleet, a linked appointment moved to ARRIVED, dispatcher notifications. No document automation runs. Honours Idempotency-Key. (scope: gate:write)
POST
bearerAuthheader
AuthorizationBearer <token>API key as Bearer token
application/json- body
vehicle_plate*stringLength
2 <= length <= 20direction?stringDefault OUTBOUND.
Value in
"INBOUND""OUTBOUND""OTHER"trailer_plate?stringLength
length <= 20driver_name?stringLength
length <= 255carrier_id?stringFormat
uuidcarrier_name?stringLength
length <= 255partner_id?stringFormat
uuidlocation_id?stringFormat
uuiddock_name?stringLength
length <= 50purpose?stringLength
length <= 255notes?stringLength
length <= 2000expected_at?stringSet without appointment_id → the visit starts EXPECTED.
Format
date-timeappointment_id?stringA dock appointment of this organization; it moves to ARRIVED.
Format
uuidOK
application/json- response
data*The driver's identity-document number and phone are deliberately not exposed.
error*nullcurl -X POST "https://example.com/gate/visits" \ -H "Content-Type: application/json" \ -d '{ "vehicle_plate": "string" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "number": "string", "direction": "INBOUND", "status": "EXPECTED", "source": "MANUAL", "vehicle_plate": "string", "trailer_plate": "string", "fleet_vehicle_id": "ceaff20e-4a5b-4d27-b404-c40b42bbe6c7", "compliance_alerts": [ { "kind": "string", "expiresAt": "2019-08-24T14:15:22Z", "expired": true } ], "driver_name": "string", "carrier_id": "48e94619-563d-402c-b442-97b2c8fb116b", "carrier_name": "string", "partner_id": "6a3a39f6-861b-4a48-b868-5de838400e06", "location_id": "46910cc3-ab41-4b80-b4a7-94dab9f1b795", "dock_name": "string", "purpose": "string", "notes": "string", "expected_at": "2019-08-24T14:15:22Z", "arrived_at": "2019-08-24T14:15:22Z", "docked_at": "2019-08-24T14:15:22Z", "departed_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "error": null}