LineItem
Version: v6.0.0
Supporting model
A request/response or nested model — not a stored DynamoDB entity.
Overview
LineItem
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
line_item_id | str | ❌ | — | — |
part_id | str | ❌ | — | — |
tag_id | str | ❌ | — | — |
stock_id | str | ❌ | — | — |
vehicle_id | str | ❌ | — | — |
part_type | str | ❌ | — | — |
part_type_id | str | ❌ | — | — |
description | str | ✅ | — | — |
quantity | int | ❌ | — | — |
unit_price | float | ❌ | — | — |
status | StatusEnum (DRAFT, TODO, IN_PROGRESS, BLOCKED, COMPLETED, CANCELLED) | ❌ | DRAFT | Status |
department | str | ✅ | — | — |
department_id | str | ✅ | — | — |
location | str | ❌ | — | — |
location_id | str | ❌ | — | — |
users | List[User] | ❌ | — | — |
note | str | ❌ | — | — |
blocked_reason | str | ❌ | — | — |
blocked_reason_id | str | ❌ | — | — |
blocked_reason_comment | str | ❌ | — | — |
item_type | ItemTypeEnum (PART, OTHER) | ✅ | — | ItemType |
Embedded models
Models embedded in the fields above — shown inline; they have no separate page.
User — v2.0.0
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
user | str | ✅ | — | — |
user_id | str | ✅ | — | — |
department | str | ✅ | — | — |
department_id | str | ✅ | — | — |
Change history
v2.0.0· 2025-07-12 · Cian (shared account) · Removed fieldstage(breaking).; Removed fieldstage_id(breaking).; Added required fielddepartment.; Added required fielddepartment_id. (3713e7962)v1.0.0· 2025-07-11 · Cian (shared account) · Initial version. (abd0d451a)
APIs / Triggers
| Trigger | Endpoint / Source | Detail | Handler |
|---|---|---|---|
| API | POST /newworkOrder/pinnacle | — | src/pinnacle/work_order_handle_create.py |
| API | PUT /newworkOrder/updateStatus | — | src/work_order_status_update.py |
| API | PUT /newworkOrder/lineItemReplace | — | src/work_order_replace_line_item.py |
| API | PUT /newworkOrder/ | — | src/work_order_update.py |
| Event | EventBridge | ContactCreatedFromWebShop, ContactCreatedFromTradeMe, ContactCreatedFromEbay, ContactCreatedFromTuiPart, ContactCreatedFromWallabyPart | src/handle/work_order_handle_sales_channel_webhook.py |
Change history
v6.0.0 · 2025-07-12 · Cian (shared account) · 3713e7962
fx
- Removed field
stage(breaking). - Removed field
stage_id(breaking). - Added required field
department. - Added required field
department_id.
v5.0.0 · 2025-07-11 · Cian (shared account) · abd0d451a
fx
- Removed field
item_name(breaking). - Removed field
location_name(breaking). - Added optional field
blocked_reason. - Added optional field
blocked_reason_comment. - Added optional field
blocked_reason_id. - Added optional field
location. - Added optional field
note. - Added optional field
part_type. - Added optional field
part_type_id. - Added required field
stage. - Added required field
stage_id. - Added optional field
status. - Added optional field
stock_id. - Added optional field
users. - Added optional field
vehicle_id. - Field
descriptiontype changed: Optional[str] → str (breaking). - Field
descriptionbecame required (breaking). - Field
item_typetype changed: str → ItemTypeEnum (breaking). - Field
item_typeenum valueOTHERadded. - Field
item_typeenum valuePARTadded. - Field
quantitydefault changed: 1 → None.
v4.2.0 · 2025-05-05 · Cian (shared account) · 8b78eddb7
fx
- Added required field
item_type.
v4.1.0 · 2025-04-11 · Cian (shared account) · 706dfc159
migration scripts
- Added optional field
location_id. - Added optional field
location_name.
v4.0.0 · 2025-04-03 · Olaniyi Ajayi · 8889db892
ebay fx
- Field
part_idtype changed: str → Optional[str] (breaking). - Field
part_idbecame optional. - Field
tag_idtype changed: str → Optional[str] (breaking). - Field
tag_idbecame optional. - Field
unit_pricetype changed: float → Optional[float] (breaking). - Field
unit_pricebecame optional.
v3.0.0 · 2025-03-29 · Olaniyi Ajayi · f703b906b
quote fx
- Field
part_idtype changed: Optional[str] → str (breaking). - Field
part_idbecame required (breaking). - Field
tag_idtype changed: Optional[str] → str (breaking). - Field
tag_idbecame required (breaking). - Field
unit_pricetype changed: Optional[float] → float (breaking). - Field
unit_pricebecame required (breaking).
v2.0.0 · 2025-03-29 · Cian (shared account) · fd4f0f8b9
wo
- Field
part_idtype changed: str → Optional[str] (breaking). - Field
part_idbecame optional. - Field
tag_idtype changed: str → Optional[str] (breaking). - Field
tag_idbecame optional. - Field
unit_pricetype changed: float → Optional[float] (breaking). - Field
unit_pricebecame optional.
v1.0.0 · 2025-03-17 · Olaniyi Ajayi · 0beb2163a
updated wo and qs
- Initial version.
Generated from
dismantly-backend/Microservices/WorkOrder/dependencies/models.py. Do not edit by hand.