Skip to main content

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​

WorkOrder


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.

FieldTypeDescription
endDateAWSTimestampEnd of the route window, in epoch milliseconds.
idString!Unique identifier of the work order part.
nextTokenStringPagination token for retrieving the next page of results.
startDateAWSTimestampStart of the route window, in epoch milliseconds.

Returns​

WorkOrderPartRoutePayload

WorkOrderPartRoute​

A single leg of a work order part's travel route across locations.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
durationAWSTimestampTime spent at the location, in milliseconds.
endDateAWSTimestampEpoch-millisecond timestamp of last detection at the location.
locationLocationV2Location visited during this leg of the route.
startDateAWSTimestampEpoch-millisecond timestamp of first detection at the location.
stateStringState of the part at the location.
WorkOrderPartRoutePayload​

Result of the workOrderPartRoute query.

FieldTypeDescription
nextTokenStringPagination 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.

FieldTypeDescription
endDateAWSTimestampEnd of the history window, in epoch milliseconds.
idString!Unique identifier of the work order part.
nextTokenStringPagination token for retrieving the next page of results.
startDateAWSTimestampStart of the history window, in epoch milliseconds.

Returns​

WorkOrderPartShipmentHistoryPayload

WorkOrderPartShipmentHistory​

A single shipment event in a work order part's history.

FieldTypeDescription
commentStringOptional comment recorded with the event.
locationLocationV2Location associated with the shipment event.
shipmentDateAWSTimestampEpoch-millisecond timestamp when the event occurred.
stateWorkOrderPartShipmentStateShipment state of the part at the event.
statusStringStatus label for the event.
WorkOrderPartShipmentHistoryPayload​

Result of the workOrderPartShipmentHistory query.

FieldTypeDescription
nextTokenStringPagination 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.

ValueDescription
CANCELLEDPart shipment has been cancelled.
NONEPart has no shipment activity.
RECEIVEDPart has been received.
SHIPPEDPart has been shipped.
STAGEDPart 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.

FieldTypeDescription
endDateAWSTimestampEnd of the route window, in epoch milliseconds.
nextTokenStringPagination token for retrieving the next page of results.
numberString!Number of the work order to retrieve the process route for.
startDateAWSTimestampStart of the route window, in epoch milliseconds.

Returns​

WorkOrderProcessRoutePayload

WorkOrderProcessRoute​

A single leg of a work order's process route across locations.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
durationAWSTimestampTime spent at the location, in milliseconds.
endDateAWSTimestampEpoch-millisecond timestamp of last detection at the location.
locationLocationV2Location visited during this leg of the route.
operationUpdates[OperationUpdate!]Operation status updates recorded during this leg.
startDateAWSTimestampEpoch-millisecond timestamp of first detection at the location.
stateStringState of the work order at the location.
workOrderUpdates[WorkOrderUpdate!]Work order status updates recorded during this leg.
WorkOrderProcessRoutePayload​

Result of the workOrderProcessRoute query.

FieldTypeDescription
nextTokenStringPagination 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.

FieldTypeDescription
endDateAWSTimestampEnd of the route window, in epoch milliseconds.
nextTokenStringPagination token for retrieving the next page of results.
numberString!Number of the work order to retrieve the route for.
startDateAWSTimestampStart of the route window, in epoch milliseconds.

Returns​

WorkOrderRoutePayload

WorkOrderRoute​

A single leg of a work order's travel route across locations.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
durationAWSTimestampTime spent at the location, in milliseconds.
endDateAWSTimestampEpoch-millisecond timestamp of last detection at the location.
locationLocationV2Location visited during this leg of the route.
operationUpdates[OperationUpdate!]Operation status updates recorded during this leg.
startDateAWSTimestampEpoch-millisecond timestamp of first detection at the location.
stateStringState of the work order at the location.
workOrderUpdates[WorkOrderUpdate!]Work order status updates recorded during this leg.
WorkOrderRoutePayload​

Result of the workOrderRoute query.

FieldTypeDescription
nextTokenStringPagination 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.

FieldTypeDescription
filterStringFilter expression for work order properties.
nextTokenStringPagination token for retrieving the next page of results.

Returns​

WorkOrdersPayload

WorkOrdersPayload​

Result of the workOrders query.

FieldTypeDescription
nextTokenStringPagination 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.

FieldTypeDescription
detachTrackerBooleanWhether to detach the tracker from any previous work order it was attached to. Defaults to false.
onboardingLocationStringXemelgo-verified location identifier the work order should be onboarded to.
reuseTrackerBooleanWhether the tracker may be reused from a previous work order if already in use. Defaults to false.
trackerSerialString!Serial number of the tracker to attach.
workOrderNumberString!Number of the work order to attach the tracker to.
WorkOrderProcessingOptions​

Options controlling work order processing behavior.

FieldTypeDescription
detachTrackerBooleanWhether to detach a tracker from its previous work order. Defaults to false.
enablePartialSuccessBooleanWhether the request may partially succeed instead of failing as a whole.
reuseTrackerBooleanWhether an existing tracker may be reused. Defaults to false.

Returns​

[WorkOrder]


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.

FieldTypeDescription
completeInputPartsBooleanWhether to mark the work orders' input parts as complete.
completeOutputPartsBooleanWhether to mark the work orders' output parts as complete.
detachTrackerBooleanWhether to detach trackers from the work orders on completion.
workOrderNumbers[String!]!Numbers of the work orders to complete.

Returns​

[WorkOrder]


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.

FieldTypeDescription
workOrderPartTypes[WorkOrderPartTypesInput!]Work order part types to create.

Returns​

CreateWorkOrderPartTypesPayload

CreateWorkOrderPartTypesPayload​

Result of the createWorkOrderPartTypes mutation.

FieldTypeDescription
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.

FieldTypeDescription
enablePartialSuccessBooleanWhether the request may partially succeed instead of failing as a whole.
reuseTrackerBooleanWhether an existing tracker may be reused.
WorkOrderOperation​

Input describing a single operation in a work order set creation request.

FieldTypeDescription
due_dateAWSTimestampEpoch-millisecond timestamp for the operation's due date.
nameString!Display name of the operation.
sequence_numberIntPosition of this operation within the work order's sequence.
start_dateAWSTimestampEpoch-millisecond timestamp for the operation's expected start.
WorkOrderSetInput​

Input describing a single work order to create as part of a set.

FieldTypeDescription
commentsStringFree-text comments on the work order.
completion_dateAWSTimestampExpected completion date for the work order, in epoch milliseconds.
custom_propertiesAWSJSONAdditional custom properties, serialized as a JSON string.
customerStringCustomer associated with the work order.
descriptionStringFree-text description of the work order.
due_dateAWSTimestampExpected completion date for the work order, in epoch milliseconds.
input_parts[WorkOrderSetPart]Input parts consumed by the work order.
onboarding_locationStringXemelgo-verified location identifier the work order should be onboarded to.
operations[WorkOrderOperation!]Operations making up the work order's process.
order_numberString!Work order (job) number.
output_parts[WorkOrderSetPart]Output parts produced by the work order.
po_numberStringPurchase order number associated with the work order.
priorityIntPriority level of the work order.
start_dateAWSTimestampExpected start date for the work order, in epoch milliseconds.
stateStringInitial state of the work order.
statusStringInitial 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.

FieldTypeDescription
categoryStringCategory the part is classified under.
idIDUnique identifier of the part.
part_numberStringPart number of the part.
product_numberStringProduct number of the part type.
quantityIntQuantity of the part.
ship_to_locationStringIdentifier of the location the part should ship to.
trackers[TrackerInput!]Trackers to associate with the part.

Returns​

WorkOrderSet

WorkOrderSet​

Result of the createWorkOrderSet mutation.

FieldTypeDescription
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.

FieldTypeDescription
categoryStringCategory the input part is classified under.
partNameStringDisplay name of the input part.
partNumberString!Part number of the input part.
partTypeNameStringPart type name of the input part.
partTypeNumberString!Part type number of the input part.
shipToLocationIdStringIdentifier of the location the input part should ship to.
trackers[TrackerInput!]Trackers to associate with the input part.
workOrderNumberString!Number of the work order to update.

Returns​

WorkOrder


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.

FieldTypeDescription
idString!Unique identifier of the part type to update.
updatesWorkOrderPartTypesInputUpdates to apply to the part type.
UpdateWorkOrderPartTypesInput​

Input for updating one or more work order part types.

FieldTypeDescription
workOrderPartTypes[UpdateWorkOrderPartTypeInput!]Work order part types to update.

Returns​

UpdateWorkOrderPartTypesPayload

UpdateWorkOrderPartTypesPayload​

Result of the updateWorkOrderPartTypes mutation.

FieldTypeDescription
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.

FieldTypeDescription
commentsStringUpdated comments for the work order.
completionDateAWSTimestampUpdated expected completion date for the work order, in epoch milliseconds.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
customerStringUpdated customer for the work order.
descriptionStringUpdated description of the work order.
dueDateAWSTimestampUpdated due date for the work order, in epoch milliseconds.
poNumberStringUpdated purchase order number for the work order.
priorityIntUpdated priority level of the work order.
startDateAWSTimestampUpdated expected start date for the work order, in epoch milliseconds.
stateStringUpdated state of the work order.
statusStatusUpdated status of the work order.
workOrderNumberString!Number of the work order to update.
UpdateWorkOrderPropertiesOptions​

Options controlling work order property updates.

FieldTypeDescription
enablePartialSuccessBooleanWhether the request may partially succeed instead of failing as a whole.

Returns​

[WorkOrder]

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.

FieldTypeDescription
delayedStartSeverityOperationSeveritySeverity applied when the operation's start is delayed.
severityOperationSeveritySeverity of the current operation condition.
startStatusOperationStartStatusStatus of the operation relative to its expected start time.
statusOperationStatusCurrent lifecycle status of the operation.

Location​

A location where items are tracked. Legacy shape; newer APIs return LocationV2.

FieldTypeDescription
categoryStringName of the location's category.
idIDUnique identifier of the location.
identifierStringHuman-readable location identifier.
nameStringDisplay name of the location.

LocationV2​

A location in the tenant's location hierarchy.

FieldTypeDescription
categoryIdStringIdentifier of the location category this location is classified under.
childLocationIds[String!]Identifiers of locations nested directly beneath this one.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
customerIdStringIdentifier of the customer this location belongs to, if any.
descriptionStringFree-text description of the location.
idStringUnique identifier of the location.
nameStringDisplay name of the location.
parentLocationIdStringIdentifier of the parent location in the hierarchy, if any.
roleIdStringIdentifier of the location role describing how this location is used.

Operation​

A single operation (step) within a work order's process.

FieldTypeDescription
cancelledOnAWSTimestampEpoch-millisecond timestamp when the operation was cancelled.
completedOnAWSTimestampEpoch-millisecond timestamp when the operation was completed.
dueDateAWSTimestampEpoch-millisecond timestamp for the operation's due date.
idIDUnique identifier of the operation.
nameString!Display name of the operation.
sequenceNumberIntPosition of this operation within the work order's sequence.
startDateAWSTimestampEpoch-millisecond timestamp for the operation's expected start.
startedOnAWSTimestampEpoch-millisecond timestamp when the operation actually started.
statusOperationStatusCurrent lifecycle status of the operation.

OperationSeverity​

Severity level applied to an operation condition.

ValueDescription
CRITICALCondition is critical.
WARNINGCondition is a warning.

OperationStartStatus​

Status of an operation relative to its expected start time.

ValueDescription
DELAYEDOperation started later than expected.
NOT_STARTEDOperation has not started yet.
ON_TIMEOperation started on time.

OperationStatus​

Lifecycle status of a single work order operation.

ValueDescription
CANCELLEDOperation has been cancelled.
COMPLETEDOperation has been completed.
INDETERMINATEOperation status could not be determined.
IN_PROGRESSOperation is currently in progress.
NOT_STARTEDOperation has not started yet.
TIME_EXCEEDEDOperation has run past its allotted time.

OperationUpdate​

A status update applied to an operation at a point in time.

FieldTypeDescription
severityStringSeverity of the operation condition at the time of the update.
statusOperationStatusStatus of the operation at the time of the update.
updateDateAWSTimestampEpoch-millisecond timestamp of the update.

Status​

Lifecycle status shared by work orders and other process entities.

ValueDescription
CANCELLEDCancelled before completion.
COMPLETEDFinished successfully.
IN_PROGRESSCurrently being worked.
PLANNEDCreated but not yet started.

Tracker​

An identifier tracker (e.g. RFID tag or barcode) attached to a tracked item.

FieldTypeDescription
attachDateAWSTimestampEpoch-millisecond timestamp when the tracker was attached to the item.
customPropertiesAWSJSONTenant-specific sensor profile custom properties.
encodingFormatStringRFID tag encoding format for this tracker.
serialStringEPC 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.

FieldTypeDescription
customPropertiesAWSJSONTracker-level custom properties as a JSON object.
encodingFormatStringRFID tag encoding format for this tracker.
reuseTrackerSerialBooleanWhether to reuse a tracker serial already attached to another item.
serialString!EPC or tracker serial to attach.

TravelRoute​

A single leg of a work order's travel through locations.

FieldTypeDescription
durationIntTime spent at the location, in seconds.
entryTimeAWSTimestampEpoch-millisecond timestamp when the work order entered the location.
exitTimeAWSTimestampEpoch-millisecond timestamp when the work order exited the location.
locationLocationLocation visited during this leg of the route.

WorkOrder​

A work order (job) tracked through the production process.

FieldTypeDescription
commentsStringFree-text comments on the work order.
completionDateAWSTimestampEpoch-millisecond timestamp when the work order was completed.
creationDateAWSTimestampEpoch-millisecond timestamp when the work order was created.
currentOperationCurrentOperationStatus of the work order's currently active operation.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
customerStringCustomer associated with the work order.
descriptionStringFree-text description of the work order.
dueDateAWSTimestampEpoch-millisecond timestamp for the work order's due date.
inputs[WorkOrderInput]Input parts consumed by the work order.
isActiveBooleanWhether the work order is currently active.
lastDetectedAtLocationLocationV2Location where the work order was last detected.
lastDetectedAtLocationEntryDateAWSTimestampEpoch-millisecond timestamp when the work order entered its last detected location.
lastDetectionDateAWSTimestampEpoch-millisecond timestamp when the work order was last detected.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the work order was last updated.
locationLocationV2Location the work order is currently associated with.
numberStringWork order number.
operations[Operation!]Operations making up the work order's process.
outputs[WorkOrderOutput]Output parts produced by the work order.
poNumberStringPurchase order number associated with the work order.
priorityIntPriority level of the work order.
routeHistory[TravelRoute]Recent legs of the work order's travel route, optionally limited.
startDateAWSTimestampEpoch-millisecond timestamp for the work order's expected start.
stateStringCurrent state of the work order.
statusStatusCurrent status of the work order.
statusFlags[String!]Status flags currently applied to the work order.
trackerSerialAttachDateAWSTimestampEpoch-millisecond timestamp when the tracker was attached to the work order.
trackers[Tracker]Trackers attached to the work order.
uuidStringGlobally unique identifier of the work order.

WorkOrderInput​

An input part consumed by a work order.

FieldTypeDescription
categoryStringCategory the input part is classified under.
idStringUnique identifier of the input part.
isActiveBooleanWhether the input part is currently active.
nameStringDisplay name of the input part.
quantityIntQuantity of the input part.
shipmentStateStringLatest shipment state of the input part.
trackers[Tracker!]Trackers attached to the input part.
typeWorkOrderPartTypePart type of the input part.
uuidStringGlobally unique identifier of the input part.

WorkOrderOutput​

An output part produced by a work order.

FieldTypeDescription
categoryStringCategory the output part is classified under.
idStringUnique identifier of the output part.
isActiveBooleanWhether the output part is currently active.
nameStringDisplay name of the output part.
quantityIntQuantity of the output part.
shipmentStateStringLatest shipment state of the output part.
trackers[Tracker!]Trackers attached to the output part.
typeWorkOrderPartTypePart type of the output part.
uuidStringGlobally unique identifier of the output part.

WorkOrderPartType​

A part type used for work order input and output parts.

FieldTypeDescription
creationDateAWSTimestampEpoch-millisecond timestamp when the part type was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
descriptionStringFree-text description of the part type.
idStringUnique identifier of the part type.
images[String!]Image paths associated with the part type.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the part type was last updated.
nameStringDisplay name of the part type.
numberStringPart type number.
quantityIntDefault quantity for the part type.
unitStringUnit of measure for the part type.
uuidStringGlobally unique identifier of the part type.

WorkOrderPartTypesInput​

Input describing a single work order part type to create.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
descriptionStringFree-text description of the part type.
idString!Unique identifier of the part type.
images[String!]Image paths associated with the part type.
nameStringDisplay name of the part type.
numberStringPart type number.
quantityIntDefault quantity for the part type.
unitStringUnit of measure for the part type.

WorkOrderUpdate​

A status update applied to a work order at a point in time.

FieldTypeDescription
priorityIntPriority level at the time of the update.
statusStatusStatus of the work order at the time of the update.
statusFlags[String!]Status flags applied at the time of the update.
updateDateAWSTimestampEpoch-millisecond timestamp of the update.