Work Orders API
Authentication: every request needs an
IdToken— see Authentication. Error shapes: Errors.
Endpoint: POST https://api.xemelgo.com/graphql
Queries
workOrder
Retrieves a single work order by its number.
query WorkOrder($number: String) {
workOrder(number: $number) {
comments
completionDate
creationDate
customer
customProperties
description
dueDate
isActive
lastDetectedAtLocationEntryDate
lastDetectionDate
lastUpdatedDate
number
poNumber
priority
startDate
state
status
statusFlags
trackerSerialAttachDate
uuid
currentOperation {
delayedStartSeverity
severity
startStatus
status
}
inputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
lastDetectedAtLocation {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
location {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
operations {
cancelledOn
completedOn
dueDate
id
name
sequenceNumber
startDate
startedOn
status
}
outputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
routeHistory {
duration
entryTime
exitTime
location {
id
name
}
}
trackers {
attachDate
customProperties
encodingFormat
serial
}
}
}
Example variables
{
"number": "AST-1024"
}
Example response
{
"data": {
"workOrder": {
"comments": "Inspected and approved",
"completionDate": 1719792000000,
"creationDate": 1719792000000,
"customer": "example",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"isActive": true,
"lastDetectedAtLocationEntryDate": 1719792000000,
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"number": "AST-1024",
"poNumber": "example",
"priority": 10,
"startDate": 1719792000000,
"state": "ACTIVE",
"status": "CANCELLED",
"statusFlags": [
"example"
],
"trackerSerialAttachDate": 1719792000000,
"uuid": "uu-001",
"currentOperation": {
"delayedStartSeverity": "CRITICAL",
"severity": "CRITICAL",
"startStatus": "DELAYED",
"status": "CANCELLED"
},
"inputs": [
{
"category": "example",
"id": "workorder-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"lastDetectedAtLocation": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"location": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"operations": [
{
"cancelledOn": 1719792000000,
"completedOn": 1719792000000,
"dueDate": 1719792000000,
"id": "operation-001",
"name": "Forklift 7",
"sequenceNumber": 10,
"startDate": 1719792000000,
"startedOn": 1719792000000,
"status": "CANCELLED"
}
],
"outputs": [
{
"category": "example",
"id": "workorderoutput-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"routeHistory": [
{
"duration": 10,
"entryTime": 1719792000000,
"exitTime": 1719792000000,
"location": {
"id": "location-001",
"name": "Forklift 7"
}
}
],
"trackers": [
{
"attachDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"serial": "E28011700000020ABC12345"
}
]
}
}
}
Arguments
number · String
Returns
workOrderPartRoute
Retrieves the travel route of a work order part across locations.
query WorkOrderPartRoute($input: WorkOrderPartRouteInput) {
workOrderPartRoute(input: $input) {
nextToken
route {
customProperties
duration
endDate
startDate
state
location {
id
name
}
}
}
}
Example variables
{
"input": {
"endDate": 1719792000000,
"id": "workorderpartroute-001",
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"startDate": 1719792000000
}
}
Example response
{
"data": {
"workOrderPartRoute": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"route": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"duration": 1719792000000,
"endDate": 1719792000000,
"startDate": 1719792000000,
"state": "ACTIVE",
"location": {
"id": "location-001",
"name": "Forklift 7"
}
}
]
}
}
}
Arguments
input · WorkOrderPartRouteInput
WorkOrderPartRouteInput
Input for retrieving a work order part's travel route.
| Field | Type | Description |
|---|---|---|
endDate | AWSTimestamp | End of the route window, in epoch milliseconds. |
id | String! | Unique identifier of the work order part. |
nextToken | String | Pagination token for retrieving the next page of results. |
startDate | AWSTimestamp | Start of the route window, in epoch milliseconds. |
Returns
WorkOrderPartRoute
A single leg of a work order part's travel route across locations.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
duration | AWSTimestamp | Time spent at the location, in milliseconds. |
endDate | AWSTimestamp | Epoch-millisecond timestamp of last detection at the location. |
location | LocationV2 | Location visited during this leg of the route. |
startDate | AWSTimestamp | Epoch-millisecond timestamp of first detection at the location. |
state | String | State of the part at the location. |
WorkOrderPartRoutePayload
Result of the workOrderPartRoute query.
| Field | Type | Description |
|---|---|---|
nextToken | String | Pagination token for retrieving the next page of results. |
route | [WorkOrderPartRoute!] | Legs of the work order part's travel route. |
workOrderPartShipmentHistory
Retrieves the shipment history of a work order part.
query WorkOrderPartShipmentHistory($input: WorkOrderPartShipmentHistoryInput) {
workOrderPartShipmentHistory(input: $input) {
nextToken
shipmentHistory {
comment
shipmentDate
state
status
location {
id
name
}
}
}
}
Example variables
{
"input": {
"endDate": 1719792000000,
"id": "workorderpartshipmenthistory-001",
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"startDate": 1719792000000
}
}
Example response
{
"data": {
"workOrderPartShipmentHistory": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"shipmentHistory": [
{
"comment": "example",
"shipmentDate": 1719792000000,
"state": "CANCELLED",
"status": "ACTIVE",
"location": {
"id": "location-001",
"name": "Forklift 7"
}
}
]
}
}
}
Arguments
input · WorkOrderPartShipmentHistoryInput
WorkOrderPartShipmentHistoryInput
Input for retrieving a work order part's shipment history.
| Field | Type | Description |
|---|---|---|
endDate | AWSTimestamp | End of the history window, in epoch milliseconds. |
id | String! | Unique identifier of the work order part. |
nextToken | String | Pagination token for retrieving the next page of results. |
startDate | AWSTimestamp | Start of the history window, in epoch milliseconds. |
Returns
WorkOrderPartShipmentHistoryPayload
WorkOrderPartShipmentHistory
A single shipment event in a work order part's history.
| Field | Type | Description |
|---|---|---|
comment | String | Optional comment recorded with the event. |
location | LocationV2 | Location associated with the shipment event. |
shipmentDate | AWSTimestamp | Epoch-millisecond timestamp when the event occurred. |
state | WorkOrderPartShipmentState | Shipment state of the part at the event. |
status | String | Status label for the event. |
WorkOrderPartShipmentHistoryPayload
Result of the workOrderPartShipmentHistory query.
| Field | Type | Description |
|---|---|---|
nextToken | String | Pagination token for retrieving the next page of results. |
shipmentHistory | [WorkOrderPartShipmentHistory!] | Shipment events for the work order part. |
WorkOrderPartShipmentState
Shipment state of a work order part.
| Value | Description |
|---|---|
CANCELLED | Part shipment has been cancelled. |
NONE | Part has no shipment activity. |
RECEIVED | Part has been received. |
SHIPPED | Part has been shipped. |
STAGED | Part has been staged for shipment. |
workOrderProcessRoute
Retrieves the process route of a work order across locations.
query WorkOrderProcessRoute($input: WorkOrderProcessRouteInput) {
workOrderProcessRoute(input: $input) {
nextToken
route {
customProperties
duration
endDate
startDate
state
location {
id
name
}
operationUpdates {
severity
status
}
workOrderUpdates {
priority
status
}
}
}
}
Example variables
{
"input": {
"endDate": 1719792000000,
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"number": "AST-1024",
"startDate": 1719792000000
}
}
Example response
{
"data": {
"workOrderProcessRoute": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"route": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"duration": 1719792000000,
"endDate": 1719792000000,
"startDate": 1719792000000,
"state": "ACTIVE",
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"operationUpdates": [
{
"severity": "example",
"status": "CANCELLED"
}
],
"workOrderUpdates": [
{
"priority": 10,
"status": "CANCELLED"
}
]
}
]
}
}
}
Arguments
input · WorkOrderProcessRouteInput
WorkOrderProcessRouteInput
Input for retrieving a work order's process route.
| Field | Type | Description |
|---|---|---|
endDate | AWSTimestamp | End of the route window, in epoch milliseconds. |
nextToken | String | Pagination token for retrieving the next page of results. |
number | String! | Number of the work order to retrieve the process route for. |
startDate | AWSTimestamp | Start of the route window, in epoch milliseconds. |
Returns
WorkOrderProcessRoute
A single leg of a work order's process route across locations.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
duration | AWSTimestamp | Time spent at the location, in milliseconds. |
endDate | AWSTimestamp | Epoch-millisecond timestamp of last detection at the location. |
location | LocationV2 | Location visited during this leg of the route. |
operationUpdates | [OperationUpdate!] | Operation status updates recorded during this leg. |
startDate | AWSTimestamp | Epoch-millisecond timestamp of first detection at the location. |
state | String | State of the work order at the location. |
workOrderUpdates | [WorkOrderUpdate!] | Work order status updates recorded during this leg. |
WorkOrderProcessRoutePayload
Result of the workOrderProcessRoute query.
| Field | Type | Description |
|---|---|---|
nextToken | String | Pagination token for retrieving the next page of results. |
route | [WorkOrderProcessRoute!] | Legs of the work order's process route. |
workOrderRoute
Retrieves the travel route of a work order across locations.
query WorkOrderRoute($input: WorkOrderRouteInput) {
workOrderRoute(input: $input) {
nextToken
route {
customProperties
duration
endDate
startDate
state
location {
id
name
}
operationUpdates {
severity
status
}
workOrderUpdates {
priority
status
}
}
}
}
Example variables
{
"input": {
"endDate": 1719792000000,
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"number": "AST-1024",
"startDate": 1719792000000
}
}
Example response
{
"data": {
"workOrderRoute": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"route": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"duration": 1719792000000,
"endDate": 1719792000000,
"startDate": 1719792000000,
"state": "ACTIVE",
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"operationUpdates": [
{
"severity": "example",
"status": "CANCELLED"
}
],
"workOrderUpdates": [
{
"priority": 10,
"status": "CANCELLED"
}
]
}
]
}
}
}
Arguments
input · WorkOrderRouteInput
WorkOrderRouteInput
Input for retrieving a work order's travel route.
| Field | Type | Description |
|---|---|---|
endDate | AWSTimestamp | End of the route window, in epoch milliseconds. |
nextToken | String | Pagination token for retrieving the next page of results. |
number | String! | Number of the work order to retrieve the route for. |
startDate | AWSTimestamp | Start of the route window, in epoch milliseconds. |
Returns
WorkOrderRoute
A single leg of a work order's travel route across locations.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
duration | AWSTimestamp | Time spent at the location, in milliseconds. |
endDate | AWSTimestamp | Epoch-millisecond timestamp of last detection at the location. |
location | LocationV2 | Location visited during this leg of the route. |
operationUpdates | [OperationUpdate!] | Operation status updates recorded during this leg. |
startDate | AWSTimestamp | Epoch-millisecond timestamp of first detection at the location. |
state | String | State of the work order at the location. |
workOrderUpdates | [WorkOrderUpdate!] | Work order status updates recorded during this leg. |
WorkOrderRoutePayload
Result of the workOrderRoute query.
| Field | Type | Description |
|---|---|---|
nextToken | String | Pagination token for retrieving the next page of results. |
route | [WorkOrderRoute!] | Legs of the work order's travel route. |
workOrders
Lists work orders, with optional filtering and pagination.
query WorkOrders($input: WorkOrdersInput) {
workOrders(input: $input) {
nextToken
workOrders {
comments
completionDate
creationDate
customer
customProperties
description
dueDate
isActive
lastDetectedAtLocationEntryDate
lastDetectionDate
lastUpdatedDate
number
poNumber
priority
startDate
state
status
statusFlags
trackerSerialAttachDate
uuid
currentOperation {
delayedStartSeverity
severity
}
inputs {
id
name
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
operations {
id
name
}
outputs {
id
name
}
routeHistory {
duration
entryTime
}
trackers {
serial
}
}
}
}
Example variables
{
"input": {
"filter": "name:\"Forklift*\"",
"nextToken": "eyJpZCI6IjEwMjQifQ=="
}
}
Example response
{
"data": {
"workOrders": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"workOrders": [
{
"comments": "Inspected and approved",
"completionDate": 1719792000000,
"creationDate": 1719792000000,
"customer": "example",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"isActive": true,
"lastDetectedAtLocationEntryDate": 1719792000000,
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"number": "AST-1024",
"poNumber": "example",
"priority": 10,
"startDate": 1719792000000,
"state": "ACTIVE",
"status": "CANCELLED",
"statusFlags": [
"example"
],
"trackerSerialAttachDate": 1719792000000,
"uuid": "uu-001",
"currentOperation": {
"delayedStartSeverity": "CRITICAL",
"severity": "CRITICAL"
},
"inputs": [
{
"id": "workorder-001",
"name": "Forklift 7"
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"operations": [
{
"id": "operation-001",
"name": "Forklift 7"
}
],
"outputs": [
{
"id": "workorderoutput-001",
"name": "Forklift 7"
}
],
"routeHistory": [
{
"duration": 10,
"entryTime": 1719792000000
}
],
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
]
}
]
}
}
}
Arguments
input · WorkOrdersInput
WorkOrdersInput
Input for listing work orders, with optional filtering and pagination.
| Field | Type | Description |
|---|---|---|
filter | String | Filter expression for work order properties. |
nextToken | String | Pagination token for retrieving the next page of results. |
Returns
WorkOrdersPayload
Result of the workOrders query.
| Field | Type | Description |
|---|---|---|
nextToken | String | Pagination token for retrieving the next page of results. |
workOrders | [WorkOrder!]! | Page of work orders matching the query. |
Mutations
attachWorkOrderTracker
Associates RFID tracker serial numbers with work orders and returns the updated work orders.
mutation AttachWorkOrderTracker($input: [AttachWorkOrderTrackerInput!]!, $options: WorkOrderProcessingOptions) {
attachWorkOrderTracker(input: $input, options: $options) {
comments
completionDate
creationDate
customer
customProperties
description
dueDate
isActive
lastDetectedAtLocationEntryDate
lastDetectionDate
lastUpdatedDate
number
poNumber
priority
startDate
state
status
statusFlags
trackerSerialAttachDate
uuid
currentOperation {
delayedStartSeverity
severity
startStatus
status
}
inputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
lastDetectedAtLocation {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
location {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
operations {
cancelledOn
completedOn
dueDate
id
name
sequenceNumber
startDate
startedOn
status
}
outputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
routeHistory {
duration
entryTime
exitTime
location {
id
name
}
}
trackers {
attachDate
customProperties
encodingFormat
serial
}
}
}
Example variables
{
"input": [
{
"detachTracker": true,
"onboardingLocation": "example",
"reuseTracker": true,
"trackerSerial": "E28011700000020ABC12345",
"workOrderNumber": "example"
}
],
"options": {
"detachTracker": true,
"enablePartialSuccess": true,
"reuseTracker": true
}
}
Example response
{
"data": {
"attachWorkOrderTracker": [
{
"comments": "Inspected and approved",
"completionDate": 1719792000000,
"creationDate": 1719792000000,
"customer": "example",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"isActive": true,
"lastDetectedAtLocationEntryDate": 1719792000000,
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"number": "AST-1024",
"poNumber": "example",
"priority": 10,
"startDate": 1719792000000,
"state": "ACTIVE",
"status": "CANCELLED",
"statusFlags": [
"example"
],
"trackerSerialAttachDate": 1719792000000,
"uuid": "uu-001",
"currentOperation": {
"delayedStartSeverity": "CRITICAL",
"severity": "CRITICAL",
"startStatus": "DELAYED",
"status": "CANCELLED"
},
"inputs": [
{
"category": "example",
"id": "workorder-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"lastDetectedAtLocation": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"location": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"operations": [
{
"cancelledOn": 1719792000000,
"completedOn": 1719792000000,
"dueDate": 1719792000000,
"id": "operation-001",
"name": "Forklift 7",
"sequenceNumber": 10,
"startDate": 1719792000000,
"startedOn": 1719792000000,
"status": "CANCELLED"
}
],
"outputs": [
{
"category": "example",
"id": "workorderoutput-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"routeHistory": [
{
"duration": 10,
"entryTime": 1719792000000,
"exitTime": 1719792000000,
"location": {
"id": "location-001",
"name": "Forklift 7"
}
}
],
"trackers": [
{
"attachDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"serial": "E28011700000020ABC12345"
}
]
}
]
}
}
Arguments
input · [AttachWorkOrderTrackerInput!]!
options · WorkOrderProcessingOptions
AttachWorkOrderTrackerInput
Input for attaching a tracker to a single work order.
| Field | Type | Description |
|---|---|---|
detachTracker | Boolean | Whether to detach the tracker from any previous work order it was attached to. Defaults to false. |
onboardingLocation | String | Xemelgo-verified location identifier the work order should be onboarded to. |
reuseTracker | Boolean | Whether the tracker may be reused from a previous work order if already in use. Defaults to false. |
trackerSerial | String! | Serial number of the tracker to attach. |
workOrderNumber | String! | Number of the work order to attach the tracker to. |
WorkOrderProcessingOptions
Options controlling work order processing behavior.
| Field | Type | Description |
|---|---|---|
detachTracker | Boolean | Whether to detach a tracker from its previous work order. Defaults to false. |
enablePartialSuccess | Boolean | Whether the request may partially succeed instead of failing as a whole. |
reuseTracker | Boolean | Whether an existing tracker may be reused. Defaults to false. |
Returns
completeWorkOrders
Completes the given work orders and returns the updated work orders.
mutation CompleteWorkOrders($input: CompleteWorkOrdersInput!) {
completeWorkOrders(input: $input) {
comments
completionDate
creationDate
customer
customProperties
description
dueDate
isActive
lastDetectedAtLocationEntryDate
lastDetectionDate
lastUpdatedDate
number
poNumber
priority
startDate
state
status
statusFlags
trackerSerialAttachDate
uuid
currentOperation {
delayedStartSeverity
severity
startStatus
status
}
inputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
lastDetectedAtLocation {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
location {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
operations {
cancelledOn
completedOn
dueDate
id
name
sequenceNumber
startDate
startedOn
status
}
outputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
routeHistory {
duration
entryTime
exitTime
location {
id
name
}
}
trackers {
attachDate
customProperties
encodingFormat
serial
}
}
}
Example variables
{
"input": {
"completeInputParts": true,
"completeOutputParts": true,
"detachTracker": true,
"workOrderNumbers": [
"example"
]
}
}
Example response
{
"data": {
"completeWorkOrders": [
{
"comments": "Inspected and approved",
"completionDate": 1719792000000,
"creationDate": 1719792000000,
"customer": "example",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"isActive": true,
"lastDetectedAtLocationEntryDate": 1719792000000,
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"number": "AST-1024",
"poNumber": "example",
"priority": 10,
"startDate": 1719792000000,
"state": "ACTIVE",
"status": "CANCELLED",
"statusFlags": [
"example"
],
"trackerSerialAttachDate": 1719792000000,
"uuid": "uu-001",
"currentOperation": {
"delayedStartSeverity": "CRITICAL",
"severity": "CRITICAL",
"startStatus": "DELAYED",
"status": "CANCELLED"
},
"inputs": [
{
"category": "example",
"id": "workorder-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"lastDetectedAtLocation": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"location": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"operations": [
{
"cancelledOn": 1719792000000,
"completedOn": 1719792000000,
"dueDate": 1719792000000,
"id": "operation-001",
"name": "Forklift 7",
"sequenceNumber": 10,
"startDate": 1719792000000,
"startedOn": 1719792000000,
"status": "CANCELLED"
}
],
"outputs": [
{
"category": "example",
"id": "workorderoutput-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"routeHistory": [
{
"duration": 10,
"entryTime": 1719792000000,
"exitTime": 1719792000000,
"location": {
"id": "location-001",
"name": "Forklift 7"
}
}
],
"trackers": [
{
"attachDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"serial": "E28011700000020ABC12345"
}
]
}
]
}
}
Arguments
input · CompleteWorkOrdersInput!
CompleteWorkOrdersInput
Input for completing one or more work orders.
| Field | Type | Description |
|---|---|---|
completeInputParts | Boolean | Whether to mark the work orders' input parts as complete. |
completeOutputParts | Boolean | Whether to mark the work orders' output parts as complete. |
detachTracker | Boolean | Whether to detach trackers from the work orders on completion. |
workOrderNumbers | [String!]! | Numbers of the work orders to complete. |
Returns
createWorkOrderPartTypes
Creates work order part types and returns their identifiers.
mutation CreateWorkOrderPartTypes($input: CreateWorkOrderPartTypesInput!) {
createWorkOrderPartTypes(input: $input) {
typeIds
}
}
Example variables
{
"input": {
"workOrderPartTypes": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "workorderparttypes-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"name": "Forklift 7",
"number": "AST-1024",
"quantity": 10,
"unit": "EA"
}
]
}
}
Example response
{
"data": {
"createWorkOrderPartTypes": {
"typeIds": [
"example"
]
}
}
}
Arguments
input · CreateWorkOrderPartTypesInput!
CreateWorkOrderPartTypesInput
Input for creating one or more work order part types.
| Field | Type | Description |
|---|---|---|
workOrderPartTypes | [WorkOrderPartTypesInput!] | Work order part types to create. |
Returns
CreateWorkOrderPartTypesPayload
CreateWorkOrderPartTypesPayload
Result of the createWorkOrderPartTypes mutation.
| Field | Type | Description |
|---|---|---|
typeIds | [String] | Identifiers of the created part types. |
createWorkOrderSet
Creates a set of work orders and returns their numbers.
mutation CreateWorkOrderSet($input: [WorkOrderSetInput!]!, $options: CreateWorkOrderSetOptions) {
createWorkOrderSet(input: $input, options: $options) {
work_order_numbers
}
}
Example variables
{
"input": [
{
"comments": "Inspected and approved",
"completion_date": 1719792000000,
"custom_properties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"customer": "example",
"description": "Electric counterbalance forklift",
"due_date": 1719792000000,
"input_parts": [
{
"category": "example",
"id": "workordersetpart-001",
"part_number": "example",
"product_number": "example",
"quantity": 10,
"ship_to_location": "example",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"onboarding_location": "example",
"operations": [
{
"due_date": 1719792000000,
"name": "Forklift 7",
"sequence_number": 10,
"start_date": 1719792000000
}
],
"order_number": "example",
"output_parts": [
{
"category": "example",
"id": "workordersetpart-001",
"part_number": "example",
"product_number": "example",
"quantity": 10,
"ship_to_location": "example",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"po_number": "example",
"priority": 10,
"start_date": 1719792000000,
"state": "ACTIVE",
"status": "ACTIVE",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"options": {
"enablePartialSuccess": true,
"reuseTracker": true
}
}
Example response
{
"data": {
"createWorkOrderSet": {
"work_order_numbers": [
"example"
]
}
}
}
Arguments
input · [WorkOrderSetInput!]!
options · CreateWorkOrderSetOptions
CreateWorkOrderSetOptions
Options controlling work order set creation behavior.
| Field | Type | Description |
|---|---|---|
enablePartialSuccess | Boolean | Whether the request may partially succeed instead of failing as a whole. |
reuseTracker | Boolean | Whether an existing tracker may be reused. |
WorkOrderOperation
Input describing a single operation in a work order set creation request.
| Field | Type | Description |
|---|---|---|
due_date | AWSTimestamp | Epoch-millisecond timestamp for the operation's due date. |
name | String! | Display name of the operation. |
sequence_number | Int | Position of this operation within the work order's sequence. |
start_date | AWSTimestamp | Epoch-millisecond timestamp for the operation's expected start. |
WorkOrderSetInput
Input describing a single work order to create as part of a set.
| Field | Type | Description |
|---|---|---|
comments | String | Free-text comments on the work order. |
completion_date | AWSTimestamp | Expected completion date for the work order, in epoch milliseconds. |
custom_properties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customer | String | Customer associated with the work order. |
description | String | Free-text description of the work order. |
due_date | AWSTimestamp | Expected completion date for the work order, in epoch milliseconds. |
input_parts | [WorkOrderSetPart] | Input parts consumed by the work order. |
onboarding_location | String | Xemelgo-verified location identifier the work order should be onboarded to. |
operations | [WorkOrderOperation!] | Operations making up the work order's process. |
order_number | String! | Work order (job) number. |
output_parts | [WorkOrderSetPart] | Output parts produced by the work order. |
po_number | String | Purchase order number associated with the work order. |
priority | Int | Priority level of the work order. |
start_date | AWSTimestamp | Expected start date for the work order, in epoch milliseconds. |
state | String | Initial state of the work order. |
status | String | Initial status of the work order. |
trackers | [TrackerInput!] | Trackers to associate with the work order. |
WorkOrderSetPart
Input describing a single part in a work order set creation request.
| Field | Type | Description |
|---|---|---|
category | String | Category the part is classified under. |
id | ID | Unique identifier of the part. |
part_number | String | Part number of the part. |
product_number | String | Product number of the part type. |
quantity | Int | Quantity of the part. |
ship_to_location | String | Identifier of the location the part should ship to. |
trackers | [TrackerInput!] | Trackers to associate with the part. |
Returns
WorkOrderSet
Result of the createWorkOrderSet mutation.
| Field | Type | Description |
|---|---|---|
work_order_numbers | [String] | Numbers of the work orders that were created. |
updateWorkOrderInputPart
Updates an input part on a work order and returns the updated work order.
mutation UpdateWorkOrderInputPart($input: UpdateWorkOrderInputPartInput!) {
updateWorkOrderInputPart(input: $input) {
comments
completionDate
creationDate
customer
customProperties
description
dueDate
isActive
lastDetectedAtLocationEntryDate
lastDetectionDate
lastUpdatedDate
number
poNumber
priority
startDate
state
status
statusFlags
trackerSerialAttachDate
uuid
currentOperation {
delayedStartSeverity
severity
startStatus
status
}
inputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
lastDetectedAtLocation {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
location {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
operations {
cancelledOn
completedOn
dueDate
id
name
sequenceNumber
startDate
startedOn
status
}
outputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
routeHistory {
duration
entryTime
exitTime
location {
id
name
}
}
trackers {
attachDate
customProperties
encodingFormat
serial
}
}
}
Example variables
{
"input": {
"category": "example",
"partName": "example",
"partNumber": "example",
"partTypeName": "example",
"partTypeNumber": "example",
"shipToLocationId": "shiptolocation-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"workOrderNumber": "example"
}
}
Example response
{
"data": {
"updateWorkOrderInputPart": {
"comments": "Inspected and approved",
"completionDate": 1719792000000,
"creationDate": 1719792000000,
"customer": "example",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"isActive": true,
"lastDetectedAtLocationEntryDate": 1719792000000,
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"number": "AST-1024",
"poNumber": "example",
"priority": 10,
"startDate": 1719792000000,
"state": "ACTIVE",
"status": "CANCELLED",
"statusFlags": [
"example"
],
"trackerSerialAttachDate": 1719792000000,
"uuid": "uu-001",
"currentOperation": {
"delayedStartSeverity": "CRITICAL",
"severity": "CRITICAL",
"startStatus": "DELAYED",
"status": "CANCELLED"
},
"inputs": [
{
"category": "example",
"id": "workorder-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"lastDetectedAtLocation": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"location": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"operations": [
{
"cancelledOn": 1719792000000,
"completedOn": 1719792000000,
"dueDate": 1719792000000,
"id": "operation-001",
"name": "Forklift 7",
"sequenceNumber": 10,
"startDate": 1719792000000,
"startedOn": 1719792000000,
"status": "CANCELLED"
}
],
"outputs": [
{
"category": "example",
"id": "workorderoutput-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"routeHistory": [
{
"duration": 10,
"entryTime": 1719792000000,
"exitTime": 1719792000000,
"location": {
"id": "location-001",
"name": "Forklift 7"
}
}
],
"trackers": [
{
"attachDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"serial": "E28011700000020ABC12345"
}
]
}
}
}
Arguments
input · UpdateWorkOrderInputPartInput!
UpdateWorkOrderInputPartInput
Input for updating an input part on a work order.
| Field | Type | Description |
|---|---|---|
category | String | Category the input part is classified under. |
partName | String | Display name of the input part. |
partNumber | String! | Part number of the input part. |
partTypeName | String | Part type name of the input part. |
partTypeNumber | String! | Part type number of the input part. |
shipToLocationId | String | Identifier of the location the input part should ship to. |
trackers | [TrackerInput!] | Trackers to associate with the input part. |
workOrderNumber | String! | Number of the work order to update. |
Returns
updateWorkOrderPartTypes
Updates work order part types and returns their identifiers.
mutation UpdateWorkOrderPartTypes($input: UpdateWorkOrderPartTypesInput!) {
updateWorkOrderPartTypes(input: $input) {
typeIds
}
}
Example variables
{
"input": {
"workOrderPartTypes": [
{
"id": "updateworkorderparttype-001",
"updates": {
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "workorderparttypes-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"name": "Forklift 7",
"number": "AST-1024",
"quantity": 10,
"unit": "EA"
}
}
]
}
}
Example response
{
"data": {
"updateWorkOrderPartTypes": {
"typeIds": [
"example"
]
}
}
}
Arguments
input · UpdateWorkOrderPartTypesInput!
UpdateWorkOrderPartTypeInput
Input describing a single work order part type entry for an update operation.
| Field | Type | Description |
|---|---|---|
id | String! | Unique identifier of the part type to update. |
updates | WorkOrderPartTypesInput | Updates to apply to the part type. |
UpdateWorkOrderPartTypesInput
Input for updating one or more work order part types.
| Field | Type | Description |
|---|---|---|
workOrderPartTypes | [UpdateWorkOrderPartTypeInput!] | Work order part types to update. |
Returns
UpdateWorkOrderPartTypesPayload
UpdateWorkOrderPartTypesPayload
Result of the updateWorkOrderPartTypes mutation.
| Field | Type | Description |
|---|---|---|
typeIds | [String] | Identifiers of the updated part types. |
updateWorkOrderProperties
Updates properties on the given work orders and returns the updated work orders.
mutation UpdateWorkOrderProperties($input: [UpdateWorkOrderPropertiesInput!]!, $options: UpdateWorkOrderPropertiesOptions) {
updateWorkOrderProperties(input: $input, options: $options) {
comments
completionDate
creationDate
customer
customProperties
description
dueDate
isActive
lastDetectedAtLocationEntryDate
lastDetectionDate
lastUpdatedDate
number
poNumber
priority
startDate
state
status
statusFlags
trackerSerialAttachDate
uuid
currentOperation {
delayedStartSeverity
severity
startStatus
status
}
inputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
lastDetectedAtLocation {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
location {
categoryId
childLocationIds
customerId
customProperties
description
id
name
parentLocationId
roleId
}
operations {
cancelledOn
completedOn
dueDate
id
name
sequenceNumber
startDate
startedOn
status
}
outputs {
category
id
isActive
name
quantity
shipmentState
uuid
trackers {
serial
}
type {
id
name
number
}
}
routeHistory {
duration
entryTime
exitTime
location {
id
name
}
}
trackers {
attachDate
customProperties
encodingFormat
serial
}
}
}
Example variables
{
"input": [
{
"comments": "Inspected and approved",
"completionDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"customer": "example",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"poNumber": "example",
"priority": 10,
"startDate": 1719792000000,
"state": "ACTIVE",
"status": "CANCELLED",
"workOrderNumber": "example"
}
],
"options": {
"enablePartialSuccess": true
}
}
Example response
{
"data": {
"updateWorkOrderProperties": [
{
"comments": "Inspected and approved",
"completionDate": 1719792000000,
"creationDate": 1719792000000,
"customer": "example",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"isActive": true,
"lastDetectedAtLocationEntryDate": 1719792000000,
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"number": "AST-1024",
"poNumber": "example",
"priority": 10,
"startDate": 1719792000000,
"state": "ACTIVE",
"status": "CANCELLED",
"statusFlags": [
"example"
],
"trackerSerialAttachDate": 1719792000000,
"uuid": "uu-001",
"currentOperation": {
"delayedStartSeverity": "CRITICAL",
"severity": "CRITICAL",
"startStatus": "DELAYED",
"status": "CANCELLED"
},
"inputs": [
{
"category": "example",
"id": "workorder-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"lastDetectedAtLocation": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"location": {
"categoryId": "category-001",
"childLocationIds": [
"example"
],
"customerId": "customer-001",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "location-001",
"name": "Forklift 7",
"parentLocationId": "parentlocation-001",
"roleId": "role-001"
},
"operations": [
{
"cancelledOn": 1719792000000,
"completedOn": 1719792000000,
"dueDate": 1719792000000,
"id": "operation-001",
"name": "Forklift 7",
"sequenceNumber": 10,
"startDate": 1719792000000,
"startedOn": 1719792000000,
"status": "CANCELLED"
}
],
"outputs": [
{
"category": "example",
"id": "workorderoutput-001",
"isActive": true,
"name": "Forklift 7",
"quantity": 10,
"shipmentState": "example",
"uuid": "uu-001",
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "workorderparttype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
],
"routeHistory": [
{
"duration": 10,
"entryTime": 1719792000000,
"exitTime": 1719792000000,
"location": {
"id": "location-001",
"name": "Forklift 7"
}
}
],
"trackers": [
{
"attachDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"serial": "E28011700000020ABC12345"
}
]
}
]
}
}
Arguments
input · [UpdateWorkOrderPropertiesInput!]!
options · UpdateWorkOrderPropertiesOptions
UpdateWorkOrderPropertiesInput
Input describing the properties to update on a single work order.
| Field | Type | Description |
|---|---|---|
comments | String | Updated comments for the work order. |
completionDate | AWSTimestamp | Updated expected completion date for the work order, in epoch milliseconds. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customer | String | Updated customer for the work order. |
description | String | Updated description of the work order. |
dueDate | AWSTimestamp | Updated due date for the work order, in epoch milliseconds. |
poNumber | String | Updated purchase order number for the work order. |
priority | Int | Updated priority level of the work order. |
startDate | AWSTimestamp | Updated expected start date for the work order, in epoch milliseconds. |
state | String | Updated state of the work order. |
status | Status | Updated status of the work order. |
workOrderNumber | String! | Number of the work order to update. |
UpdateWorkOrderPropertiesOptions
Options controlling work order property updates.
| Field | Type | Description |
|---|---|---|
enablePartialSuccess | Boolean | Whether the request may partially succeed instead of failing as a whole. |
Returns
Shared types
Entity types used across multiple operations on this page. Type names throughout link here.
CurrentOperation
Status summary of the work order's currently active operation.
| Field | Type | Description |
|---|---|---|
delayedStartSeverity | OperationSeverity | Severity applied when the operation's start is delayed. |
severity | OperationSeverity | Severity of the current operation condition. |
startStatus | OperationStartStatus | Status of the operation relative to its expected start time. |
status | OperationStatus | Current lifecycle status of the operation. |
Location
A location where items are tracked. Legacy shape; newer APIs return LocationV2.
| Field | Type | Description |
|---|---|---|
category | String | Name of the location's category. |
id | ID | Unique identifier of the location. |
identifier | String | Human-readable location identifier. |
name | String | Display name of the location. |
LocationV2
A location in the tenant's location hierarchy.
| Field | Type | Description |
|---|---|---|
categoryId | String | Identifier of the location category this location is classified under. |
childLocationIds | [String!] | Identifiers of locations nested directly beneath this one. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customerId | String | Identifier of the customer this location belongs to, if any. |
description | String | Free-text description of the location. |
id | String | Unique identifier of the location. |
name | String | Display name of the location. |
parentLocationId | String | Identifier of the parent location in the hierarchy, if any. |
roleId | String | Identifier of the location role describing how this location is used. |
Operation
A single operation (step) within a work order's process.
| Field | Type | Description |
|---|---|---|
cancelledOn | AWSTimestamp | Epoch-millisecond timestamp when the operation was cancelled. |
completedOn | AWSTimestamp | Epoch-millisecond timestamp when the operation was completed. |
dueDate | AWSTimestamp | Epoch-millisecond timestamp for the operation's due date. |
id | ID | Unique identifier of the operation. |
name | String! | Display name of the operation. |
sequenceNumber | Int | Position of this operation within the work order's sequence. |
startDate | AWSTimestamp | Epoch-millisecond timestamp for the operation's expected start. |
startedOn | AWSTimestamp | Epoch-millisecond timestamp when the operation actually started. |
status | OperationStatus | Current lifecycle status of the operation. |
OperationSeverity
Severity level applied to an operation condition.
| Value | Description |
|---|---|
CRITICAL | Condition is critical. |
WARNING | Condition is a warning. |
OperationStartStatus
Status of an operation relative to its expected start time.
| Value | Description |
|---|---|
DELAYED | Operation started later than expected. |
NOT_STARTED | Operation has not started yet. |
ON_TIME | Operation started on time. |
OperationStatus
Lifecycle status of a single work order operation.
| Value | Description |
|---|---|
CANCELLED | Operation has been cancelled. |
COMPLETED | Operation has been completed. |
INDETERMINATE | Operation status could not be determined. |
IN_PROGRESS | Operation is currently in progress. |
NOT_STARTED | Operation has not started yet. |
TIME_EXCEEDED | Operation has run past its allotted time. |
OperationUpdate
A status update applied to an operation at a point in time.
| Field | Type | Description |
|---|---|---|
severity | String | Severity of the operation condition at the time of the update. |
status | OperationStatus | Status of the operation at the time of the update. |
updateDate | AWSTimestamp | Epoch-millisecond timestamp of the update. |
Status
Lifecycle status shared by work orders and other process entities.
| Value | Description |
|---|---|
CANCELLED | Cancelled before completion. |
COMPLETED | Finished successfully. |
IN_PROGRESS | Currently being worked. |
PLANNED | Created but not yet started. |
Tracker
An identifier tracker (e.g. RFID tag or barcode) attached to a tracked item.
| Field | Type | Description |
|---|---|---|
attachDate | AWSTimestamp | Epoch-millisecond timestamp when the tracker was attached to the item. |
customProperties | AWSJSON | Tenant-specific sensor profile custom properties. |
encodingFormat | String | RFID tag encoding format for this tracker. |
serial | String | EPC or tracker serial identifying this tracker. |
TrackerInput
Input for specifying a tracker to attach when creating or updating an item. Replaces the per-field trackerSerial / reuseTrackerSerial pattern.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Tracker-level custom properties as a JSON object. |
encodingFormat | String | RFID tag encoding format for this tracker. |
reuseTrackerSerial | Boolean | Whether to reuse a tracker serial already attached to another item. |
serial | String! | EPC or tracker serial to attach. |
TravelRoute
A single leg of a work order's travel through locations.
| Field | Type | Description |
|---|---|---|
duration | Int | Time spent at the location, in seconds. |
entryTime | AWSTimestamp | Epoch-millisecond timestamp when the work order entered the location. |
exitTime | AWSTimestamp | Epoch-millisecond timestamp when the work order exited the location. |
location | Location | Location visited during this leg of the route. |
WorkOrder
A work order (job) tracked through the production process.
| Field | Type | Description |
|---|---|---|
comments | String | Free-text comments on the work order. |
completionDate | AWSTimestamp | Epoch-millisecond timestamp when the work order was completed. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the work order was created. |
currentOperation | CurrentOperation | Status of the work order's currently active operation. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customer | String | Customer associated with the work order. |
description | String | Free-text description of the work order. |
dueDate | AWSTimestamp | Epoch-millisecond timestamp for the work order's due date. |
inputs | [WorkOrderInput] | Input parts consumed by the work order. |
isActive | Boolean | Whether the work order is currently active. |
lastDetectedAtLocation | LocationV2 | Location where the work order was last detected. |
lastDetectedAtLocationEntryDate | AWSTimestamp | Epoch-millisecond timestamp when the work order entered its last detected location. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the work order was last detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the work order was last updated. |
location | LocationV2 | Location the work order is currently associated with. |
number | String | Work order number. |
operations | [Operation!] | Operations making up the work order's process. |
outputs | [WorkOrderOutput] | Output parts produced by the work order. |
poNumber | String | Purchase order number associated with the work order. |
priority | Int | Priority level of the work order. |
routeHistory | [TravelRoute] | Recent legs of the work order's travel route, optionally limited. |
startDate | AWSTimestamp | Epoch-millisecond timestamp for the work order's expected start. |
state | String | Current state of the work order. |
status | Status | Current status of the work order. |
statusFlags | [String!] | Status flags currently applied to the work order. |
trackerSerialAttachDate | AWSTimestamp | Epoch-millisecond timestamp when the tracker was attached to the work order. |
trackers | [Tracker] | Trackers attached to the work order. |
uuid | String | Globally unique identifier of the work order. |
WorkOrderInput
An input part consumed by a work order.
| Field | Type | Description |
|---|---|---|
category | String | Category the input part is classified under. |
id | String | Unique identifier of the input part. |
isActive | Boolean | Whether the input part is currently active. |
name | String | Display name of the input part. |
quantity | Int | Quantity of the input part. |
shipmentState | String | Latest shipment state of the input part. |
trackers | [Tracker!] | Trackers attached to the input part. |
type | WorkOrderPartType | Part type of the input part. |
uuid | String | Globally unique identifier of the input part. |
WorkOrderOutput
An output part produced by a work order.
| Field | Type | Description |
|---|---|---|
category | String | Category the output part is classified under. |
id | String | Unique identifier of the output part. |
isActive | Boolean | Whether the output part is currently active. |
name | String | Display name of the output part. |
quantity | Int | Quantity of the output part. |
shipmentState | String | Latest shipment state of the output part. |
trackers | [Tracker!] | Trackers attached to the output part. |
type | WorkOrderPartType | Part type of the output part. |
uuid | String | Globally unique identifier of the output part. |
WorkOrderPartType
A part type used for work order input and output parts.
| Field | Type | Description |
|---|---|---|
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the part type was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the part type. |
id | String | Unique identifier of the part type. |
images | [String!] | Image paths associated with the part type. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the part type was last updated. |
name | String | Display name of the part type. |
number | String | Part type number. |
quantity | Int | Default quantity for the part type. |
unit | String | Unit of measure for the part type. |
uuid | String | Globally unique identifier of the part type. |
WorkOrderPartTypesInput
Input describing a single work order part type to create.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the part type. |
id | String! | Unique identifier of the part type. |
images | [String!] | Image paths associated with the part type. |
name | String | Display name of the part type. |
number | String | Part type number. |
quantity | Int | Default quantity for the part type. |
unit | String | Unit of measure for the part type. |
WorkOrderUpdate
A status update applied to a work order at a point in time.
| Field | Type | Description |
|---|---|---|
priority | Int | Priority level at the time of the update. |
status | Status | Status of the work order at the time of the update. |
statusFlags | [String!] | Status flags applied at the time of the update. |
updateDate | AWSTimestamp | Epoch-millisecond timestamp of the update. |