Update a gate queue entry
Logistics module
PATCH/gate-queue/{id}gateQueueEntries.update
A vehicle waiting at the venue gate. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability logistics.yard.write.
- OAuth scopes: logistics.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the gate queue entry. |
Request body: GateQueueEntryUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| vehicle_identifier | string | No | Plate or trailer number as written.Constraints: length 1 to 100 |
| arrived_at | string (date-time) | No | When the vehicle arrived. |
| shipment_id | string (uuid) | null | No | Identifier of the shipment the vehicle carries. |
| vehicle_type | string | null | No | Kind of vehicle at the gate.Constraints: length 1 to 100 |
| driver_name | string | null | No | Driver of the vehicle, as given at check-in.Constraints: length 1 to 200 |
{
"vehicle_identifier": "FL TRK-2231",
"arrived_at": "2026-10-08T14:30:00Z",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"vehicle_type": "53ft Tractor-Trailer",
"driver_name": "Luis Ortega"
}Response 200: GateQueueEntry
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the gate queue entry. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| vehicle_identifier | string | Yes | Plate or trailer number as written.Constraints: length 1 to 100 |
| arrived_at | string (date-time) | Yes | When the vehicle arrived. |
| released_at | string (date-time) | null | Yes | When the vehicle was released. |
| project_id | string (uuid) | Yes | Identifier of the project whose site the gate is at. |
| shipment_id | string (uuid) | null | Yes | Identifier of the shipment the vehicle carries. |
| released_by | string (uuid) | null | Yes | Identifier of the person who released the vehicle. |
| vehicle_type | string | null | Yes | Kind of vehicle at the gate.Constraints: length 1 to 100 |
| driver_name | string | null | Yes | Driver of the vehicle, as given at check-in.Constraints: length 1 to 200 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"vehicle_identifier": "FL TRK-2231",
"arrived_at": "2026-10-08T14:30:00Z",
"released_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"released_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"vehicle_type": "53ft Tractor-Trailer",
"driver_name": "Luis Ortega"
}Code samples
curl -X PATCH "$XOS_BASE_URL/gate-queue/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"vehicle_identifier":"FL TRK-2231","arrived_at":"2026-10-08T14:30:00Z","shipment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","vehicle_type":"53ft Tractor-Trailer","driver_name":"Luis Ortega"}'const { data, etag } = await xos.gateQueueEntries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"vehicle_identifier": "FL TRK-2231",
"arrived_at": "2026-10-08T14:30:00Z",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"vehicle_type": "53ft Tractor-Trailer",
"driver_name": "Luis Ortega"
}, { ifMatch: etag });response = xos.gate_queue_entries.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"vehicle_identifier": "FL TRK-2231", "arrived_at": "2026-10-08T14:30:00Z", "shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "vehicle_type": "53ft Tractor-Trailer", "driver_name": "Luis Ortega"}, if_match=etag)xos gate-queue-entries update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"vehicle_identifier":"FL TRK-2231","arrived_at":"2026-10-08T14:30:00Z","shipment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","vehicle_type":"53ft Tractor-Trailer","driver_name":"Luis Ortega"}' --if-match auto