Check in at a dock slot
Módulo Logistics
POST/dock-slots/{id}/check-indockSlots.checkIn
Records the vehicle's check-in at the dock slot. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requiere la capacidad logistics.yard.write.
- Alcances de OAuth: logistics.
- Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
- Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the dock slot. |
Respuesta 200: DockSlot
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the dock slot. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| shipment_id | string (uuid) | null | Sí | Identifier of the shipment. |
| starts_at | string (date-time) | Sí | Slot start. |
| ends_at | string (date-time) | Sí | Slot end. |
| checked_in_at | string (date-time) | null | Sí | When the vehicle checked in. |
| project_id | string (uuid) | Sí | Identifier of the project whose site the dock is at. |
| zone_id | string (uuid) | Sí | Identifier of the loading dock zone of the project. |
| checked_in_by | string (uuid) | null | Sí | Identifier of the person who checked the shipment in. |
{
"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",
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"checked_in_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"checked_in_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/dock-slots/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/check-in" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.dockSlots.checkIn("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.dock_slots.check_in("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos dock-slots check-in 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f