Create a dock slot
Logistics module
POST/dock-slotsdockSlots.create
A dock slot booking. Creates a dock slot. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.
- Requires the capability logistics.dock_slot.write.
- OAuth scopes: logistics.
- Send an Idempotency-Key header. A replay with the same key returns the original response.
- Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.
Request body: DockSlotCreate
| Field | Type | Required | Description |
|---|---|---|---|
| shipment_id | string (uuid) | null | No | Identifier of the shipment. |
| starts_at | string (date-time) | Yes | Slot start. |
| ends_at | string (date-time) | Yes | Slot end. |
| project_id | string (uuid) | Yes | Identifier of the project whose site the dock is at. |
| zone_id | string (uuid) | Yes | Identifier of the loading dock zone of the project. |
{
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Response 201: DockSlot
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the dock slot. |
| 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. |
| shipment_id | string (uuid) | null | Yes | Identifier of the shipment. |
| starts_at | string (date-time) | Yes | Slot start. |
| ends_at | string (date-time) | Yes | Slot end. |
| checked_in_at | string (date-time) | null | Yes | When the vehicle checked in. |
| project_id | string (uuid) | Yes | Identifier of the project whose site the dock is at. |
| zone_id | string (uuid) | Yes | Identifier of the loading dock zone of the project. |
| checked_in_by | string (uuid) | null | Yes | 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"
}Code samples
curl -X POST "$XOS_BASE_URL/dock-slots" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"shipment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'const { data } = await xos.dockSlots.create({
"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"starts_at": "2026-10-08T14:30:00Z",
"ends_at": "2026-10-08T14:30:00Z",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
});response = xos.dock_slots.create({"shipment_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "starts_at": "2026-10-08T14:30:00Z", "ends_at": "2026-10-08T14:30:00Z", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"})xos dock-slots create --data '{"shipment_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","starts_at":"2026-10-08T14:30:00Z","ends_at":"2026-10-08T14:30:00Z","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","zone_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'