Workshop
Manage workshop entries for equipment maintenance, repair, cleaning, and downtime. The workshop system tracks when inventory items are unavailable for rental.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/workshop | List workshop entries |
| GET | /v1/workshop/{id} | Get workshop entry |
| POST | /v1/workshop | Add to workshop |
| PATCH | /v1/workshop/{id} | Update workshop entry |
| DELETE | /v1/workshop/{id} | Remove from workshop |
| GET | /v1/workshop/{id}/notes | List notes |
| POST | /v1/workshop/{id}/notes | Add note |
| GET | /v1/workshop/templates | List checklist templates |
| GET | /v1/workshop/templates/{id} | Get checklist template |
| POST | /v1/workshop/templates | Create checklist template |
| PATCH | /v1/workshop/templates/{id} | Update checklist template |
| DELETE | /v1/workshop/templates/{id} | Archive checklist template |
| POST | /v1/workshop/templates/{id}/duplicate | Duplicate checklist template |
| GET | /v1/workshop/{id}/checklists | List workshop checklists |
| POST | /v1/workshop/{id}/checklists | Attach checklist |
| DELETE | /v1/workshop/{workshopId}/checklists/{checklistId} | Remove checklist |
| PATCH | /v1/workshop/{workshopId}/checklists/{checklistId}/items/{itemId} | Complete item |
| DELETE | /v1/workshop/{workshopId}/checklists/{checklistId}/items/{itemId} | Reset item |
| GET | /v1/products/{id}/checklist-defaults | List product checklist defaults |
| POST | /v1/products/{id}/checklist-defaults | Add product checklist default |
| DELETE | /v1/products/{id}/checklist-defaults/{templateId} | Remove product checklist default |
Authentication
All workshop endpoints require an API key with products:read scope for GET requests, and products:write scope for POST/PATCH/DELETE requests.
Workshop Status
| Status | Description |
|---|---|
scheduled | Item is scheduled to enter workshop at a future time |
in_workshop | Item is currently in the workshop |
completed | Item has been removed from workshop |
Workshop Reasons
| Reason | Description |
|---|---|
maintenance | Routine maintenance |
repair | Repair needed |
cleaning | Cleaning/sanitization |
other | Other reason |
Tracking Levels
Workshop works at two levels depending on your inventory tracking mode:
Item-Level Tracking
When inventory_id is provided, a specific inventory item is tracked:
- One workshop entry per inventory item
- Item cannot be rented while in workshop
- Affected bookings are automatically reassigned to alternative inventory
Group-Level Tracking
When only product_id is provided (no inventory_id), quantity is tracked:
- Reduces available quantity for the product
- Used for products with group-level inventory tracking
Scheduling
Workshop entries can be:
- Immediate: Item enters workshop right away (
start_immediately: true) - Scheduled: Item enters workshop at a future date (
scheduled_start_at)
Auto-complete can be enabled to automatically mark the entry as completed when scheduled_end_at is reached.
Overdue Entries
An entry is considered overdue when:
- Status is
in_workshop scheduled_end_athas passed
Use ?overdue=true to filter for overdue entries.