object WorkOrderIdentifiableType

Fields

FieldTypeDescription
idString

Public API ID for this identifiable.

legacy_idBigInt

Numeric legacy ID for this identifiable; use only where legacy IDs are required.

account_idID

Public API account ID that identifies the related record.

warehouse_idID

Public API warehouse ID. Use this when passing or filtering by a warehouse; warehouse fields are display values or nested objects.

nameString

Human-readable name for this work order identifiable.

configurationString

Configuration for this work order identifiable.

typeWorkOrderType

Type for this work order identifiable.

scheduled_dateDateTime

Scheduled date in ISO-8601 date or datetime format, returned in UTC when time is included.

requested_dateDateTime

Requested date in ISO-8601 date or datetime format, returned in UTC when time is included.

started_atDateTime

Started at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

ended_atDateTime

Ended at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

ready_to_pick_atDateTime

Ready to pick at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

assembly_in_progress_atDateTime

Assembly in progress at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

completed_atDateTime

Completed at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

created_atDateTime

Created at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

updated_atDateTime

Updated at as an ISO-8601 datetime, returned in UTC unless otherwise noted.

statusWorkOrderStatus

Current status; use the API status values returned by this field when filtering or updating.

has_special_projectBoolean

True when this work order identifiable has special project; false otherwise.

priorityWorkOrderPriority

Priority for this work order identifiable.

notes[WorkOrderNotesType]

Human-readable notes for this work order identifiable.

assembly_skuWorkOrderAssemblySkuType

Assembly sku. SKU matching is case-insensitive and ignores surrounding whitespace.

fees[WorkOrderFeeType]

List of fees for this work order identifiable.

Referenced By

Example

{
  "id": "UmVjb3JkOjEyMzQ=",
  "legacy_id": 1234,
  "account_id": "QWNjb3VudDoxMjM0",
  "warehouse_id": "V2FyZWhvdXNlOjEyMzQ=",
  "name": "Build Blue Tee Bundle",
  "configuration": "default",
  "type": "{id: \"T3JkZXI6MTIzNA==\", order_number: \"SO-100045\"}",
  "scheduled_date": "2026-07-09T15:30:00Z",
  "requested_date": "2026-07-09T15:30:00Z",
  "started_at": "2026-07-09T15:30:00Z",
  "ended_at": "2026-07-09T15:30:00Z",
  "ready_to_pick_at": "2026-07-09T15:30:00Z",
  "assembly_in_progress_at": "2026-07-09T15:30:00Z",
  "completed_at": "2026-07-09T15:30:00Z",
  "created_at": "2026-07-09T15:30:00Z",
  "updated_at": "2026-07-09T15:30:00Z",
  "status": "{id: \"T3JkZXI6MTIzNA==\", order_number: \"SO-100045\"}",
  "has_special_project": true,
  "priority": "{id: \"T3JkZXI6MTIzNA==\", order_number: \"SO-100045\"}",
  "notes": ["V29ya09yZGVyTm90ZXNUeXBlOjEyMzQ=", "V29ya09yZGVyTm90ZXNUeXBlOjU2Nzg="],
  "assembly_sku": {id: "T3JkZXI6MTIzNA==", order_number: "SO-100045"},
  "fees": ["V29ya09yZGVyRmVlVHlwZToxMjM0", "V29ya09yZGVyRmVlVHlwZTo1Njc4"]
}