WorkOrder
Version: v2.1.0
Stored entity
Partition key pk, sort key sk
Overview
WorkOrder
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
pk | str | ✅ | — | — |
sk | str | ✅ | — | — |
type | str | ✅ | — | — |
tenant_id | str | ✅ | — | — |
work_order_id | str | ✅ | — | — |
work_order_display_id | str | ✅ | — | — |
contact | str | ✅ | — | — |
contact_id | str | ✅ | — | — |
started_at | str | ❌ | — | — |
ended_at | str | ❌ | — | — |
due_date | str | ❌ | — | — |
issue_date | str | ❌ | — | — |
reference | str | ❌ | — | — |
sales_channel | str | ❌ | — | — |
sales_person | str | ❌ | — | — |
sales_person_id | str | ❌ | — | — |
quote_id | str | ❌ | — | — |
quote_display_id | str | ❌ | — | — |
comments | str | ❌ | — | — |
invoice_id | str | ❌ | — | — |
invoice_display_id | str | ❌ | — | — |
line_items | List[LineItem] | ✅ | — | — |
cancellation_reason | str | ❌ | — | — |
cancellation_reason_id | str | ❌ | — | — |
cancellation_reason_comment | str | ❌ | — | — |
status | StatusEnum (DRAFT, TODO, IN_PROGRESS, BLOCKED, COMPLETED, CANCELLED) | ❌ | DRAFT | Status |
replaced_items | List[LineItem] | ✅ | — | — |
total | float | ✅ | — | — |
created_at | str | ✅ | — | — |
updated_at | str | ✅ | — | — |
meta_data | dict | ❌ | {} | — |
APIs / Triggers
| Trigger | Endpoint / Source | Detail | Handler |
|---|---|---|---|
| API | POST /newworkOrder/pinnacle | — | src/pinnacle/work_order_handle_create.py |
| API | POST /newworkOrder/ | — | src/work_order_create.py |
| Event | EventBridge | ContactCreatedFromWebShop, ContactCreatedFromTradeMe, ContactCreatedFromEbay, ContactCreatedFromTuiPart, ContactCreatedFromWallabyPart | src/handle/work_order_handle_sales_channel_webhook.py |
| API | GET /newworkOrder/rowDetailsColumnPreferences | — | src/work_order_get_row_details_column_preferences.py |
| API | GET /newworkOrder/flatViewColumnPreferences | — | src/work_order_get_flat_view_column_preferences.py |
| Stream | DynamoDB stream | table items where type = WORK_ORDER | src/work_order_opensearch_sync.py |
| Stream | DynamoDB stream | table items where type = WORK_ORDER | src/history/work_order_history_process.py |
| API | GET /newworkOrder/history | — | src/history/work_order_history_get.py |
| API | GET /newworkOrder/department | — | src/department/work_order_department_get.py |
| Event | EventBridge | WorkOrderStatusUpdated | src/handle/work_order_handle_status_notification.py |
| Event | EventBridge | PartWorkOrderDeleted | src/pinnacle/work_order_handle_delete.py |
| Event | EventBridge | WorkOrderSelfHealRequested | src/work_order_self_heal.py |
Change history
v2.1.0 · 2026-06-04 · Cian (shared account) · c5ba5e1a9
Add Work Order parity tests and history support
- Added optional field
meta_data.
v2.0.0 · 2025-11-06 · Olaniyi Ajayi · d7da4dc45
fx
- Removed field
dpc_id(breaking). - Removed field
dpc_number(breaking).
v1.2.0 · 2025-11-06 · Olaniyi Ajayi · 31dce240f
fx
- Added optional field
dpc_id. - Added optional field
dpc_number.
v1.1.0 · 2025-07-12 · Cian (shared account) · 3713e7962
fx
- Added required field
replaced_items.
v1.0.0 · 2025-07-11 · Cian (shared account) · abd0d451a
fx
- Initial version.
Generated from
dismantly-backend/Microservices/WorkOrder/dependencies/models.py. Do not edit by hand.