Work Orders

The Work Orders endpoint provides read access to manufacturing and assembly work orders.

The Work Order Object

{
  "woNo": "WO-2025-0038",
  "description": "Assemble Model X Bracket Kit",
  "status": "In Progress",
  "startDate": "2025-05-20T00:00:00Z",
  "dueDate": "2025-06-10T00:00:00Z",
  "assignee": "J. Martinez",
  "totalLines": 5,
  "lines": [
    {
      "lineNo": 1,
      "shortID": "BRKT-X100",
      "description": "Model X Bracket",
      "units": 50,
      "unitsCompleted": 20,
      "warehouse": 1,
      "warehouseName": "Main"
    }
  ],
  "notes": [
    {
      "noteDate": "2025-05-22T09:15:00Z",
      "author": "J. Martinez",
      "note": "First batch completed and staged."
    }
  ]
}

Fields

Field	Type	Description
`woNo`	string	Work order number
`description`	string	Work order description
`status`	string	`Open`, `In Progress`, or `Closed`
`startDate`	datetime	Scheduled start date
`dueDate`	datetime	Due date
`assignee`	string	Assigned user or group
`totalLines`	integer	Number of line items
`lines`	array	Line items (detail response only)
`notes`	array	Notes and comments (detail response only)

Line Fields

Field	Type	Description
`lineNo`	integer	Line sequence number
`shortID`	string	Part short ID
`description`	string	Part description
`units`	decimal	Quantity required
`unitsCompleted`	decimal	Quantity completed
`warehouse`	integer	Warehouse ID
`warehouseName`	string	Warehouse name

Note Fields

Field	Type	Description
`noteDate`	datetime	Date note was added
`author`	string	User who added the note
`note`	string	Note content

List Work Orders

GET /WorkOrder

Returns work orders. Maximum page size is 50.

Parameters

Field	Type	Required	Description
`page`	integer	No	Page number (default 1)
`pageSize`	integer	No	Results per page (max 50)
`sort`	string	No	Field to sort by
`direction`	string	No	`asc` or `desc`
`startDate`	datetime	No	Filter by start date on or after
`endDate`	datetime	No	Filter by due date on or before

Response

{
  "value": [
    {
      "woNo": "WO-2025-0038",
      "description": "Assemble Model X Bracket Kit",
      "status": "In Progress",
      "startDate": "2025-05-20T00:00:00Z",
      "dueDate": "2025-06-10T00:00:00Z",
      "assignee": "J. Martinez",
      "totalLines": 5
    },
    {
      "woNo": "WO-2025-0037",
      "description": "Rebuild Pump Assembly #4",
      "status": "Open",
      "startDate": "2025-05-25T00:00:00Z",
      "dueDate": "2025-06-20T00:00:00Z",
      "assignee": "Shop Floor",
      "totalLines": 12
    }
  ],
  "totalCount": 14,
  "page": 1,
  "pageSize": 25,
  "pageCount": 1,
  "hasMore": false
}

Get a Work Order

GET /WorkOrder/{id}

Returns the full work order including header, line items, notes, and details.

Response

{
  "woNo": "WO-2025-0038",
  "description": "Assemble Model X Bracket Kit",
  "status": "In Progress",
  "startDate": "2025-05-20T00:00:00Z",
  "dueDate": "2025-06-10T00:00:00Z",
  "assignee": "J. Martinez",
  "totalLines": 5,
  "lines": [
    {
      "lineNo": 1,
      "shortID": "BRKT-X100",
      "description": "Model X Bracket",
      "units": 50,
      "unitsCompleted": 20,
      "warehouse": 1,
      "warehouseName": "Main"
    },
    {
      "lineNo": 2,
      "shortID": "BOLT-M8-30",
      "description": "M8 x 30mm Hex Bolt",
      "units": 200,
      "unitsCompleted": 80,
      "warehouse": 1,
      "warehouseName": "Main"
    }
  ],
  "notes": [
    {
      "noteDate": "2025-05-22T09:15:00Z",
      "author": "J. Martinez",
      "note": "First batch completed and staged."
    }
  ]
}

Permissions

Action	Required Permission
List / Get work orders	All Work Orders (SecurityID 134)