Release a vehicle
Logistics module
POST/gate-queue/{id}/releasegateQueueEntries.release
Releases the vehicle from the gate queue to its dock. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requires the capability logistics.release.approve.
- OAuth scopes: logistics.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 404, 409, 422, 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. |
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 POST "$XOS_BASE_URL/gate-queue/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/release" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.gateQueueEntries.release("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.gate_queue_entries.release("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos gate-queue-entries release 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f