Skip to main content

Transfer Orders API

Authentication: every request needs an IdToken — see Authentication. Error shapes: Errors.

Endpoint: POST https://api.xemelgo.com/graphql

Queries​

assetTransferOrder​

Retrieves a single asset transfer order and its status.

query AssetTransferOrder($input: AssetTransferOrderInput) {
assetTransferOrder(input: $input) {
assetTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"id": "assettransferorder-001"
}
}
Example response
{
"data": {
"assetTransferOrder": {
"assetTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "assettransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · AssetTransferOrderInput

AssetTransferOrderInput​

Input identifying a single asset transfer order to retrieve.

FieldTypeDescription
idStringIdentifier of the asset transfer order to retrieve.

Returns​

AssetTransferOrderPayload

AssetTransferOrderPayload​

Result of the assetTransferOrder query.

FieldTypeDescription
assetTransferOrderAssetTransferOrderThe requested asset transfer order.

assetTransferOrders​

Lists asset transfer orders with their statuses.

query AssetTransferOrders($input: AssetTransferOrdersInput) {
assetTransferOrders(input: $input) {
nextToken
assetTransferOrders {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"filter": "name:\"Forklift*\"",
"nextToken": "eyJpZCI6IjEwMjQifQ=="
}
}
Example response
{
"data": {
"assetTransferOrders": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"assetTransferOrders": [
{
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "assettransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
]
}
}
}

Arguments​

input · AssetTransferOrdersInput

AssetTransferOrdersInput​

Input for listing asset transfer orders with optional filtering and pagination.

FieldTypeDescription
filterStringFilter expression applied to asset transfer order properties.
nextTokenStringPagination token returned by a previous call to fetch the next page.

Returns​

AssetTransferOrdersPayload

AssetTransferOrdersPayload​

Result of the assetTransferOrders query.

FieldTypeDescription
assetTransferOrders[AssetTransferOrder!]The matching asset transfer orders.
nextTokenStringPagination token to pass to the next call, if more results remain.

inventoryTransferOrder​

Retrieves a single inventory transfer order and its status.

query InventoryTransferOrder($input: InventoryTransferOrderInput) {
inventoryTransferOrder(input: $input) {
inventoryTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"id": "inventorytransferorder-001"
}
}
Example response
{
"data": {
"inventoryTransferOrder": {
"inventoryTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "inventorytransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · InventoryTransferOrderInput

InventoryTransferOrderInput​

Input identifying a single inventory transfer order to retrieve.

FieldTypeDescription
idStringIdentifier of the inventory transfer order to retrieve.

Returns​

InventoryTransferOrderPayload

InventoryTransferOrderPayload​

Result of the inventoryTransferOrder query.

FieldTypeDescription
inventoryTransferOrderInventoryTransferOrderThe requested inventory transfer order.

inventoryTransferOrders​

Lists inventory transfer orders with their statuses.

query InventoryTransferOrders($input: InventoryTransferOrdersInput) {
inventoryTransferOrders(input: $input) {
nextToken
inventoryTransferOrders {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"filter": "name:\"Forklift*\"",
"nextToken": "eyJpZCI6IjEwMjQifQ=="
}
}
Example response
{
"data": {
"inventoryTransferOrders": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"inventoryTransferOrders": [
{
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "inventorytransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
]
}
}
}

Arguments​

input · InventoryTransferOrdersInput

InventoryTransferOrdersInput​

Input for listing inventory transfer orders with optional filtering and pagination.

FieldTypeDescription
filterStringFilter expression applied to inventory transfer order properties.
nextTokenStringPagination token returned by a previous call to fetch the next page.

Returns​

InventoryTransferOrdersPayload

InventoryTransferOrdersPayload​

Result of the inventoryTransferOrders query.

FieldTypeDescription
inventoryTransferOrders[InventoryTransferOrder!]The matching inventory transfer orders.
nextTokenStringPagination token to pass to the next call, if more results remain.

packageTransferOrder​

Retrieves a single package transfer order and its status.

query PackageTransferOrder($input: PackageTransferOrderInput!) {
packageTransferOrder(input: $input) {
packageTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
receivedQuantity
shippedDate
shippedQuantity
stagedDate
stagedQuantity
startDate
status
totalQuantity
uuid
verifiedDate
verifiedQuantity
lastDetectedAtLocation {
id
name
}
location {
id
name
}
packages {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"id": "packagetransferorder-001"
}
}
Example response
{
"data": {
"packageTransferOrder": {
"packageTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "packagetransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"receivedQuantity": 10,
"shippedDate": 1719792000000,
"shippedQuantity": 10,
"stagedDate": 1719792000000,
"stagedQuantity": 10,
"startDate": 1719792000000,
"status": "CANCELLED",
"totalQuantity": 10,
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"verifiedQuantity": 10,
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"packages": [
{
"id": "package-001",
"name": "Forklift 7"
}
],
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · PackageTransferOrderInput!

PackageTransferOrderInput​

Input identifying a single package transfer order to retrieve.

FieldTypeDescription
idStringIdentifier of the package transfer order to retrieve.

Returns​

PackageTransferOrderPayload

PackageTransferOrderPayload​

Result of the packageTransferOrder query.

FieldTypeDescription
packageTransferOrderPackageTransferOrderThe requested package transfer order.

packageTransferOrders​

Lists package transfer orders with their statuses.

query PackageTransferOrders($input: PackageTransferOrdersInput!) {
packageTransferOrders(input: $input) {
nextToken
packageTransferOrders {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
receivedQuantity
shippedDate
shippedQuantity
stagedDate
stagedQuantity
startDate
status
totalQuantity
uuid
verifiedDate
verifiedQuantity
lastDetectedAtLocation {
id
name
}
location {
id
name
}
packages {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"filter": "name:\"Forklift*\"",
"nextToken": "eyJpZCI6IjEwMjQifQ=="
}
}
Example response
{
"data": {
"packageTransferOrders": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"packageTransferOrders": [
{
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "packagetransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"receivedQuantity": 10,
"shippedDate": 1719792000000,
"shippedQuantity": 10,
"stagedDate": 1719792000000,
"stagedQuantity": 10,
"startDate": 1719792000000,
"status": "CANCELLED",
"totalQuantity": 10,
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"verifiedQuantity": 10,
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"packages": [
{
"id": "package-001",
"name": "Forklift 7"
}
],
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
]
}
}
}

Arguments​

input · PackageTransferOrdersInput!

PackageTransferOrdersInput​

Input for listing package transfer orders with optional filtering and pagination.

FieldTypeDescription
filterStringFilter expression applied to package transfer order properties.
nextTokenStringPagination token returned by a previous call to fetch the next page.

Returns​

PackageTransferOrdersPayload

PackageTransferOrdersPayload​

Result of the packageTransferOrders query.

FieldTypeDescription
nextTokenStringPagination token to pass to the next call, if more results remain.
packageTransferOrders[PackageTransferOrder!]The matching package transfer orders.

Mutations​

createAssetTransferOrder​

Creates an asset transfer order and returns the created order.

mutation CreateAssetTransferOrder($input: CreateAssetTransferOrderInput) {
createAssetTransferOrder(input: $input) {
assetTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"entries": [
{
"assets": [
{
"id": "createassettransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"totalQuantity": 10,
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"typeId": "type-001",
"unit": "EA"
}
],
"id": "createassettransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"transferFromId": "transferfrom-001",
"transferToId": "transferto-001"
}
}
Example response
{
"data": {
"createAssetTransferOrder": {
"assetTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "assettransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · CreateAssetTransferOrderInput

CreateAssetTransferOrderInput​

Input for creating an asset transfer order and its entries.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
entries[CreateAssetTransferOrderEntryInput!]!Asset entries (asset types and quantities) included in the transfer order.
idString!Identifier (transfer order number) to assign to the new asset transfer order.
images[String!]Image keys associated with the transfer order.
trackers[TrackerInput!]Trackers to attach to the transfer order.
transferFromIdStringIdentifier of the source location to transfer from.
transferToIdStringIdentifier of the destination location to transfer to.

Returns​

CreateAssetTransferOrderPayload

CreateAssetTransferOrderPayload​

Result of the createAssetTransferOrder mutation.

FieldTypeDescription
assetTransferOrderAssetTransferOrderThe newly created asset transfer order.

createInventoryTransferOrder​

Creates an inventory transfer order and returns the created order.

mutation CreateInventoryTransferOrder($input: CreateInventoryTransferOrderInput) {
createInventoryTransferOrder(input: $input) {
inventoryTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"entries": [
{
"inventory": [
{
"id": "createinventorytransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"partId": "part-001",
"totalQuantity": 10,
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"unit": "EA"
}
],
"id": "createinventorytransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"transferFromId": "transferfrom-001",
"transferToId": "transferto-001"
}
}
Example response
{
"data": {
"createInventoryTransferOrder": {
"inventoryTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "inventorytransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · CreateInventoryTransferOrderInput

CreateInventoryTransferOrderInput​

Input for creating an inventory transfer order and its part entries.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
entries[CreateInventoryTransferOrderEntryInput!]!Part entries (SKUs and quantities) included in the transfer order.
idString!Identifier (transfer order number) to assign to the new inventory transfer order.
images[String!]Image keys associated with the transfer order.
trackers[TrackerInput!]Trackers to attach to the transfer order.
transferFromIdStringIdentifier of the source location to transfer from.
transferToIdStringIdentifier of the destination location to transfer to.

Returns​

CreateInventoryTransferOrderPayload

CreateInventoryTransferOrderPayload​

Result of the createInventoryTransferOrder mutation.

FieldTypeDescription
inventoryTransferOrderInventoryTransferOrderThe newly created inventory transfer order.

createPackageTransferOrder​

Creates a package transfer order and returns the created order.

mutation CreatePackageTransferOrder($input: CreatePackageTransferOrderInput!) {
createPackageTransferOrder(input: $input) {
packageTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
receivedQuantity
shippedDate
shippedQuantity
stagedDate
stagedQuantity
startDate
status
totalQuantity
uuid
verifiedDate
verifiedQuantity
lastDetectedAtLocation {
id
name
}
location {
id
name
}
packages {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "createpackagetransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"packages": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "package-001",
"locationId": "location-001",
"name": "Forklift 7",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"totalQuantity": 10,
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"transferFromId": "transferfrom-001",
"transferToId": "transferto-001"
}
}
Example response
{
"data": {
"createPackageTransferOrder": {
"packageTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "packagetransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"receivedQuantity": 10,
"shippedDate": 1719792000000,
"shippedQuantity": 10,
"stagedDate": 1719792000000,
"stagedQuantity": 10,
"startDate": 1719792000000,
"status": "CANCELLED",
"totalQuantity": 10,
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"verifiedQuantity": 10,
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"packages": [
{
"id": "package-001",
"name": "Forklift 7"
}
],
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · CreatePackageTransferOrderInput!

CreatePackageTransferOrderInput​

Input for creating a package transfer order and its packages.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
idString!Identifier (transfer order number) to assign to the new package transfer order.
images[String!]Image keys associated with the transfer order.
packages[PackageInput!]Packages included in the transfer order.
totalQuantityIntTotal quantity of packages in the transfer order.
trackers[TrackerInput!]Trackers to attach to the transfer order.
transferFromIdStringIdentifier of the source location to transfer from.
transferToIdStringIdentifier of the destination location to transfer to.

Returns​

CreatePackageTransferOrderPayload

CreatePackageTransferOrderPayload​

Result of the createPackageTransferOrder mutation.

FieldTypeDescription
packageTransferOrderPackageTransferOrderThe newly created package transfer order.

deleteAssetTransferOrder​

Deletes an asset transfer order and returns the deleted order.

mutation DeleteAssetTransferOrder($input: DeleteAssetTransferOrderInput) {
deleteAssetTransferOrder(input: $input) {
assetTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"id": "deleteassettransferorder-001"
}
}
Example response
{
"data": {
"deleteAssetTransferOrder": {
"assetTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "assettransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · DeleteAssetTransferOrderInput

DeleteAssetTransferOrderInput​

Input identifying the asset transfer order to delete.

FieldTypeDescription
idString!Identifier of the asset transfer order to delete.

Returns​

DeleteAssetTransferOrderPayload

DeleteAssetTransferOrderPayload​

Result of the deleteAssetTransferOrder mutation.

FieldTypeDescription
assetTransferOrderAssetTransferOrderThe deleted asset transfer order.

deleteInventoryTransferOrder​

Deletes an inventory transfer order and returns the deleted order.

mutation DeleteInventoryTransferOrder($input: DeleteInventoryTransferOrderInput) {
deleteInventoryTransferOrder(input: $input) {
inventoryTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"id": "deleteinventorytransferorder-001"
}
}
Example response
{
"data": {
"deleteInventoryTransferOrder": {
"inventoryTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "inventorytransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · DeleteInventoryTransferOrderInput

DeleteInventoryTransferOrderInput​

Input identifying the inventory transfer order to delete.

FieldTypeDescription
idString!Identifier of the inventory transfer order to delete.

Returns​

DeleteInventoryTransferOrderPayload

DeleteInventoryTransferOrderPayload​

Result of the deleteInventoryTransferOrder mutation.

FieldTypeDescription
inventoryTransferOrderInventoryTransferOrderThe deleted inventory transfer order.

deletePackageTransferOrder​

Deletes a package transfer order and returns the deleted order.

mutation DeletePackageTransferOrder($input: DeletePackageTransferOrderInput!) {
deletePackageTransferOrder(input: $input) {
packageTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
receivedQuantity
shippedDate
shippedQuantity
stagedDate
stagedQuantity
startDate
status
totalQuantity
uuid
verifiedDate
verifiedQuantity
lastDetectedAtLocation {
id
name
}
location {
id
name
}
packages {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"id": "deletepackagetransferorder-001"
}
}
Example response
{
"data": {
"deletePackageTransferOrder": {
"packageTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "packagetransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"receivedQuantity": 10,
"shippedDate": 1719792000000,
"shippedQuantity": 10,
"stagedDate": 1719792000000,
"stagedQuantity": 10,
"startDate": 1719792000000,
"status": "CANCELLED",
"totalQuantity": 10,
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"verifiedQuantity": 10,
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"packages": [
{
"id": "package-001",
"name": "Forklift 7"
}
],
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · DeletePackageTransferOrderInput!

DeletePackageTransferOrderInput​

Input identifying the package transfer order to delete.

FieldTypeDescription
idString!Identifier of the package transfer order to delete.

Returns​

DeletePackageTransferOrderPayload

DeletePackageTransferOrderPayload​

Result of the deletePackageTransferOrder mutation.

FieldTypeDescription
packageTransferOrderPackageTransferOrderThe deleted package transfer order.

updateAssetTransferOrder​

Updates an asset transfer order and returns the updated order.

mutation UpdateAssetTransferOrder($input: UpdateAssetTransferOrderInput) {
updateAssetTransferOrder(input: $input) {
assetTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"addTrackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"addTypes": [
{
"assets": [
{
"id": "createassettransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"totalQuantity": 10,
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"typeId": "type-001",
"unit": "EA"
}
],
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "updateassettransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"removeTypeIds": [
"example"
],
"removedTrackerSerials": [
"E28011700000020ABC12345"
],
"transferFromId": "transferfrom-001",
"transferToId": "transferto-001",
"updateTypes": [
{
"addAssets": [
{
"id": "createassettransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"removeAssets": [
{
"id": "createassettransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"totalQuantity": 10,
"typeId": "type-001"
}
]
}
}
Example response
{
"data": {
"updateAssetTransferOrder": {
"assetTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "assettransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · UpdateAssetTransferOrderInput

UpdateAssetTransferOrderEntryInput​

Input for updating a single asset entry of an asset transfer order.

FieldTypeDescription
addAssets[CreateAssetTransferOrderItemInput!]Assets to add to the entry.
removeAssets[CreateAssetTransferOrderItemInput!]Assets to remove from the entry.
totalQuantityIntUpdated total quantity for the asset type in the transfer order.
typeIdString!Identifier of the asset type for the entry to update.
UpdateAssetTransferOrderInput​

Input for updating an asset transfer order's locations, tracker, asset types, and custom properties.

FieldTypeDescription
addTrackers[TrackerInput!]Trackers to add to the transfer order.
addTypes[CreateAssetTransferOrderEntryInput!]New asset type entries to add to the transfer order.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
idString!Identifier of the asset transfer order to update.
images[String!]Updated image keys associated with the transfer order.
removeTypeIds[String!]Identifiers of asset type entries to remove from the transfer order.
removedTrackerSerials[String!]Tracker serials to remove from the transfer order.
transferFromIdStringUpdated identifier of the source location.
transferToIdStringUpdated identifier of the destination location.
updateTypes[UpdateAssetTransferOrderEntryInput!]Existing asset type entries to update in the transfer order.

Returns​

UpdateAssetTransferOrderPayload

UpdateAssetTransferOrderPayload​

Result of the updateAssetTransferOrder mutation.

FieldTypeDescription
assetTransferOrderAssetTransferOrderThe updated asset transfer order.

updateInventoryTransferOrder​

Updates an inventory transfer order and returns the updated order.

mutation UpdateInventoryTransferOrder($input: UpdateInventoryTransferOrderInput) {
updateInventoryTransferOrder(input: $input) {
inventoryTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
shippedDate
stagedDate
startDate
status
uuid
verifiedDate
entries {
lastUpdatedDate
receivedQuantity
}
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"addParts": [
{
"inventory": [
{
"id": "createinventorytransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"partId": "part-001",
"totalQuantity": 10,
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"unit": "EA"
}
],
"addTrackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "updateinventorytransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"removePartIds": [
"example"
],
"removedTrackerSerials": [
"E28011700000020ABC12345"
],
"transferFromId": "transferfrom-001",
"transferToId": "transferto-001",
"updateParts": [
{
"addInventory": [
{
"id": "createinventorytransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"partId": "part-001",
"removeInventory": [
{
"id": "createinventorytransferorderitem-001",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"totalQuantity": 10
}
]
}
}
Example response
{
"data": {
"updateInventoryTransferOrder": {
"inventoryTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "inventorytransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"shippedDate": 1719792000000,
"stagedDate": 1719792000000,
"startDate": 1719792000000,
"status": "CANCELLED",
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"entries": [
{
"lastUpdatedDate": 1719792000000,
"receivedQuantity": 10
}
],
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · UpdateInventoryTransferOrderInput

UpdateInventoryTransferOrderEntryInput​

Input for updating a single part entry of an inventory transfer order.

FieldTypeDescription
addInventory[CreateInventoryTransferOrderItemInput!]Inventory items to add to the entry.
partIdString!Identifier of the part type or SKU for the entry to update.
removeInventory[CreateInventoryTransferOrderItemInput!]Inventory items to remove from the entry.
totalQuantityIntUpdated total quantity for the part in the transfer order.
UpdateInventoryTransferOrderInput​

Input for updating an inventory transfer order's locations, tracker, parts, and custom properties.

FieldTypeDescription
addParts[CreateInventoryTransferOrderEntryInput!]New part entries to add to the transfer order.
addTrackers[TrackerInput!]Trackers to add to the transfer order.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
idString!Identifier of the inventory transfer order to update.
images[String!]Updated image keys associated with the transfer order.
removePartIds[String!]Identifiers of part entries to remove from the transfer order.
removedTrackerSerials[String!]Tracker serials to remove from the transfer order.
transferFromIdStringUpdated identifier of the source location.
transferToIdStringUpdated identifier of the destination location.
updateParts[UpdateInventoryTransferOrderEntryInput!]Existing part entries to update in the transfer order.

Returns​

UpdateInventoryTransferOrderPayload

UpdateInventoryTransferOrderPayload​

Result of the updateInventoryTransferOrder mutation.

FieldTypeDescription
inventoryTransferOrderInventoryTransferOrderThe updated inventory transfer order.

updatePackageTransferOrder​

Updates a package transfer order and returns the updated order.

mutation UpdatePackageTransferOrder($input: UpdatePackageTransferOrderInput!) {
updatePackageTransferOrder(input: $input) {
packageTransferOrder {
cancelledDate
creationDate
customProperties
id
images
lastDetectionDate
lastUpdatedDate
receivedDate
receivedQuantity
shippedDate
shippedQuantity
stagedDate
stagedQuantity
startDate
status
totalQuantity
uuid
verifiedDate
verifiedQuantity
lastDetectedAtLocation {
id
name
}
location {
id
name
}
packages {
id
name
}
trackers {
serial
}
transferFrom {
id
name
}
transferTo {
id
name
}
}
}
}
Example variables
{
"input": {
"addTrackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "updatepackagetransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"packageIdsToRemove": [
"example"
],
"packagesToAdd": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "package-001",
"locationId": "location-001",
"name": "Forklift 7",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"removedTrackerSerials": [
"E28011700000020ABC12345"
],
"totalQuantity": 10,
"transferFromId": "transferfrom-001",
"transferToId": "transferto-001"
}
}
Example response
{
"data": {
"updatePackageTransferOrder": {
"packageTransferOrder": {
"cancelledDate": 1719792000000,
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"id": "packagetransferorder-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"receivedDate": 1719792000000,
"receivedQuantity": 10,
"shippedDate": 1719792000000,
"shippedQuantity": 10,
"stagedDate": 1719792000000,
"stagedQuantity": 10,
"startDate": 1719792000000,
"status": "CANCELLED",
"totalQuantity": 10,
"uuid": "uu-001",
"verifiedDate": 1719792000000,
"verifiedQuantity": 10,
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"packages": [
{
"id": "package-001",
"name": "Forklift 7"
}
],
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"transferFrom": {
"id": "location-001",
"name": "Forklift 7"
},
"transferTo": {
"id": "location-001",
"name": "Forklift 7"
}
}
}
}
}

Arguments​

input · UpdatePackageTransferOrderInput!

UpdatePackageTransferOrderInput​

Input for updating a package transfer order's locations, tracker, packages, and custom properties.

FieldTypeDescription
addTrackers[TrackerInput!]Trackers to add to the transfer order.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
idString!Identifier of the package transfer order to update.
images[String!]Updated image keys associated with the transfer order.
packageIdsToRemove[String!]Identifiers of packages to remove from the transfer order.
packagesToAdd[PackageInput!]Packages to add to the transfer order.
removedTrackerSerials[String!]Tracker serials to remove from the transfer order.
totalQuantityIntUpdated total quantity of packages in the transfer order.
transferFromIdStringUpdated identifier of the source location.
transferToIdStringUpdated identifier of the destination location.

Returns​

UpdatePackageTransferOrderPayload

UpdatePackageTransferOrderPayload​

Result of the updatePackageTransferOrder mutation.

FieldTypeDescription
packageTransferOrderPackageTransferOrderThe updated package transfer order.

Shared types​

Entity types used across multiple operations on this page. Type names throughout link here.

Address​

A business address.

FieldTypeDescription
address[String!]Up to 4 street address lines.
adminAreaStringState or administrative area.
contactNameStringName of the contact person at this address.
countryCodeStringISO 3166-1 alpha-2 country code (e.g. US).
countryNameStringFull country name (e.g. United States).
customPropertiesAWSJSONAdditional custom properties as a JSON object.
emailStringEmail address for this contact.
localityStringCity or locality.
phoneNumberStringPhone number for this address.
postalCodeStringPostal or zip code.

Asset​

A tracked asset.

FieldTypeDescription
commentsStringAny comments or remarks for the asset.
containerIdStringIdentifier of the container holding this asset, if any.
creationDateAWSTimestampEpoch-millisecond timestamp when the asset was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
descriptionStringFree-text description of the asset.
dueDateAWSTimestampEpoch-millisecond timestamp when the asset is due for maintenance or calibration.
idStringUnique identifier of the asset, usually the asset number.
images[String]Public image URLs for the asset.
lastDetectedAtLocationLocationV2Location where the asset was last detected.
lastDetectionDateAWSTimestampEpoch-millisecond timestamp when the asset was last detected.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the asset was last updated.
locationLocationV2Location where the asset is currently tracked.
nameStringDisplay name of the asset.
ownerAssetOwnerCurrent owner of the asset, set via an Owner Change asset request.
quantityFloatQuantity represented by this asset record.
requestStatusRequestStatusCurrent asset request status of the asset.
stateStringCurrent state of the asset at its location (e.g. onhand, removed).
trackers[Tracker]Trackers currently attached to this asset.
transferOrderIdStringIdentifier of the transfer order this asset belongs to, if any.
transferStatusStringCurrent transfer status of the asset, if part of a transfer order.
typeAssetTypeAsset type of the asset.
uuidStringGlobally unique identifier of the asset.

AssetOwner​

The current owner of a tracked asset, set via an Owner Change asset request.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
firstNameStringFirst name.
idString!Unique identifier of the owner.
lastNameStringLast name.
uuidID!Globally unique identifier of the owner.

AssetTransferOrder​

A transfer order moving assets between locations.

FieldTypeDescription
cancelledDateAWSTimestampEpoch-millisecond timestamp when the transfer order was cancelled.
creationDateAWSTimestampEpoch-millisecond timestamp when the transfer order was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
entries[AssetTransferOrderEntry!]!Asset entries included in the transfer order.
idStringUnique identifier of the asset transfer order.
images[String]Image keys associated with the transfer order.
lastDetectedAtLocationLocationV2Location where the transfer order was last detected.
lastDetectionDateAWSTimestampEpoch-millisecond timestamp when the transfer order was last detected.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was last updated.
locationLocationV2Current location of the transfer order.
receivedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was received.
shippedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was shipped.
stagedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was staged.
startDateAWSTimestampEpoch-millisecond timestamp when the transfer order was started.
statusTransferOrderStatusCurrent lifecycle status of the transfer order.
trackers[Tracker]Trackers attached to the transfer order.
transferFromLocationV2Source location the assets are transferred from.
transferToLocationV2Destination location the assets are transferred to.
uuidStringGlobally unique identifier of the asset transfer order.
verifiedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was verified.

AssetTransferOrderEntry​

A single asset-type entry within an asset transfer order.

FieldTypeDescription
assets[Asset!]Assets associated with this entry.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when this entry was last updated.
receivedQuantityIntQuantity that has been received for this entry.
shippedQuantityIntQuantity that has been shipped for this entry.
stagedQuantityIntQuantity that has been staged for this entry.
statusTransferOrderStatusCurrent lifecycle status of this entry.
totalQuantityIntTotal quantity to transfer for this entry.
typeAssetTypeThe asset type being transferred in this entry.
unitStringUnit of measure for the quantities, if applicable.
verifiedQuantityIntQuantity that has been verified for this entry.

AssetType​

A type (template) describing a class of assets.

FieldTypeDescription
categories[AssetTypeCategory]Categories this asset type belongs to.
creationDateAWSTimestampEpoch-millisecond timestamp when the asset type was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
customerAssetTypes[CustomerAssetType!]Per-customer asset types mapped to this asset type.
descriptionStringFree-text description of the asset type.
idStringUnique identifier of the asset type, usually the asset type number or SKU.
images[String!]Public image URLs for the asset type.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the asset type was last updated.
nameStringDisplay name of the asset type.
numberStringAsset type number.
quantityIntExpected quantity of the asset type.
unitStringUnit of measure of the asset type.
uuidStringGlobally unique identifier of the asset type.

AssetTypeCategory​

A category grouping asset types, resolved through the asset's type.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
descriptionStringFree-text description of the category.
idID!Unique identifier of the category.
nameStringDisplay name of the category.
parentAssetTypeCategoryParent category, if the category is not a root category.
uuidStringGlobally unique identifier of the category.

CreateAssetTransferOrderEntryInput​

Input describing a single asset entry (asset type and quantity) of an asset transfer order.

FieldTypeDescription
assets[CreateAssetTransferOrderItemInput!]Detailed assets associated with this entry.
totalQuantityInt!Quantity of the asset type to transfer.
trackers[TrackerInput!]Trackers identifying the assets in this entry.
typeIdString!Identifier of the asset type for this entry.
unitStringUnit of measure for the quantity, if applicable.

CreateAssetTransferOrderItemInput​

Input identifying a single asset to include in a transfer order entry.

FieldTypeDescription
idStringUnique identifier of the asset.
trackers[TrackerInput!]Trackers identifying the asset.

CreateInventoryTransferOrderEntryInput​

Input describing a single part entry (SKU and quantity) of an inventory transfer order.

FieldTypeDescription
inventory[CreateInventoryTransferOrderItemInput!]Detailed inventory items associated with the part.
partIdString!Identifier of the part type or SKU for this entry.
totalQuantityInt!Quantity of the part type or SKU to transfer.
trackers[TrackerInput!]Trackers identifying the inventory items in this entry.
unitStringUnit of measure for the quantity, if applicable.

CreateInventoryTransferOrderItemInput​

Input identifying a single inventory item to include in a transfer order entry.

FieldTypeDescription
idStringUnique identifier of the inventory item.
trackers[TrackerInput!]Trackers identifying the inventory item.

CustomerAssetType​

A customer-specific asset type mapped to an asset type.

FieldTypeDescription
customerAssetTypeIdString!The customer's asset type for this asset type.
customerIdString!Unique identifier of the customer.

CustomerPartNumber​

A customer-specific part number mapped to an inventory part.

FieldTypeDescription
customerIdString!Unique identifier of the customer.
customerPartNumberString!The customer's part number for this part.

CustomerV2​

A customer, supplier, or other external organization associated with tracked items.

FieldTypeDescription
addresses[Address!]Business addresses of this organization.
customPropertiesAWSJSONAdditional custom properties as a JSON object.
descriptionStringFree-text description of the organization.
idStringUnique identifier of the organization.
nameStringDisplay name of the organization.

Inventory​

A tracked inventory item.

FieldTypeDescription
commentsStringFree-text comments on the inventory item.
consumedDateAWSTimestampEpoch-millisecond timestamp when the item was consumed.
containerIdStringIdentifier of the container holding this item, if any.
creationDateAWSTimestampEpoch-millisecond timestamp when the item was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
customerPartNumberStringCustomer-specific part number for this item, if any.
descriptionStringFree-text description of the inventory item.
expirationDateAWSTimestampEpoch-millisecond timestamp when the item expires.
idStringUnique identifier of the inventory item.
images[String]Image URLs for the inventory item.
isConsumedBooleanWhether the item has been consumed.
lastDetectedAtLocationLocationV2Location where the inventory item was last detected.
lastDetectionDateAWSTimestampEpoch-millisecond timestamp when the item was last detected.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the item was last updated.
locationLocationV2Current location of the inventory item.
lotNumberStringLot number of the lot this item belongs to.
nameStringDisplay name of the inventory item.
partInventoryPartThe part (item type) this inventory item is an instance of.
quantityFloatQuantity represented by this inventory item.
stateStringCurrent state of the inventory item (e.g. OnHand).
trackers[Tracker]Trackers attached to this inventory item.
transferOrderIdStringIdentifier of the transfer order this item is part of, if any.
transferStatusStringTransfer status of the inventory item.
uuidStringGlobally unique identifier of the inventory item.

InventoryPart​

An inventory part (item type) describing a class of inventory items.

FieldTypeDescription
categories[InventoryPartCategory!]Categories the part is directly assigned to. Each category links to its parent category, if any.
creationDateAWSTimestampEpoch-millisecond timestamp when the part was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
customerPartNumbers[CustomerPartNumber!]Per-customer part numbers mapped to this part.
descriptionStringFree-text description of the part.
idStringUnique identifier of the inventory part (item type), usually the item or SKU number.
images[String!]Image URLs for the part.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the part was last updated.
nameStringDisplay name of the part.
numberStringPart number.
quantityIntExpected quantity represented by the part.
supplierCustomerV2Supplier for this inventory part, if one is attached.
unitStringUnit of measure for the part.
uuidStringGlobally unique identifier of the inventory part.

InventoryPartCategory​

A category an inventory part belongs to. Categories form a tree through their parent.

FieldTypeDescription
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
descriptionStringFree-text description of the category.
idID!Unique identifier of the category.
nameStringDisplay name of the category.
parentInventoryPartCategoryParent category, if the category is not a root category.
uuidStringGlobally unique identifier of the category.

InventoryTransferOrder​

A transfer order moving inventory parts between locations.

FieldTypeDescription
cancelledDateAWSTimestampEpoch-millisecond timestamp when the transfer order was cancelled.
creationDateAWSTimestampEpoch-millisecond timestamp when the transfer order was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
entries[InventoryTransferOrderEntry!]!Part entries included in the transfer order.
idStringUnique identifier of the inventory transfer order.
images[String]Image keys associated with the transfer order.
lastDetectedAtLocationLocationV2Location where the transfer order was last detected.
lastDetectionDateAWSTimestampEpoch-millisecond timestamp when the transfer order was last detected.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was last updated.
locationLocationV2Current location of the transfer order.
receivedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was received.
shippedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was shipped.
stagedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was staged.
startDateAWSTimestampEpoch-millisecond timestamp when the transfer order was started.
statusTransferOrderStatusCurrent lifecycle status of the transfer order.
trackers[Tracker]Trackers attached to the transfer order.
transferFromLocationV2Source location the inventory is transferred from.
transferToLocationV2Destination location the inventory is transferred to.
uuidStringGlobally unique identifier of the inventory transfer order.
verifiedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was verified.

InventoryTransferOrderEntry​

A single part entry within an inventory transfer order.

FieldTypeDescription
inventory[Inventory!]Inventory items associated with this entry.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when this entry was last updated.
partInventoryPartThe part type or SKU being transferred in this entry.
receivedQuantityIntQuantity that has been received for this entry.
shippedQuantityIntQuantity that has been shipped for this entry.
stagedQuantityIntQuantity that has been staged for this entry.
statusTransferOrderStatusCurrent lifecycle status of this entry.
totalQuantityIntTotal quantity to transfer for this entry.
unitStringUnit of measure for the quantities, if applicable.
verifiedQuantityIntQuantity that has been verified for this entry.

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.

Package​

A tracked package, identified by its package ID and optional tracker.

FieldTypeDescription
commentsStringAny comments or remarks recorded for the package.
containerIdStringIdentifier of the container holding this package, if any.
creationDateAWSTimestampEpoch-millisecond timestamp when the package was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
descriptionStringFree-text description of the package.
idString!Unique identifier of the package.
lastDetectedAtLocationLocationV2Location where the package was last detected.
lastDetectionDateAWSTimestampEpoch-millisecond timestamp when the package was last detected.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the package was last updated.
locationLocationV2Current location of the package.
nameStringDisplay name of the package.
stateStringCurrent state of the package.
trackers[Tracker]Trackers currently attached to the package.
transferOrderIdStringIdentifier of the transfer order this package belongs to, if any.
transferStatusStringCurrent transfer status of the package.
uuidStringGlobally unique identifier of the package.

PackageInput​

A single package to create.

FieldTypeDescription
commentsStringAny comments or remarks recorded for the package.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
descriptionStringFree-text description of the package.
idString!Serial or unique identifier for the package.
locationIdStringIdentifier of the location the package is at.
nameStringDisplay name of the package.
trackers[TrackerInput!]Trackers to attach to the package.

PackageTransferOrder​

A transfer order moving packages between locations.

FieldTypeDescription
cancelledDateAWSTimestampEpoch-millisecond timestamp when the transfer order was cancelled.
creationDateAWSTimestampEpoch-millisecond timestamp when the transfer order was created.
customPropertiesAWSJSONAdditional custom properties, serialized as a JSON string.
idString!Unique identifier of the package transfer order.
images[String]Image keys associated with the transfer order.
lastDetectedAtLocationLocationV2Location where the transfer order was last detected.
lastDetectionDateAWSTimestampEpoch-millisecond timestamp when the transfer order was last detected.
lastUpdatedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was last updated.
locationLocationV2Current location of the transfer order.
packages[Package!]Packages included in the transfer order.
receivedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was received.
receivedQuantityIntQuantity of packages that have been received.
shippedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was shipped.
shippedQuantityIntQuantity of packages that have been shipped.
stagedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was staged.
stagedQuantityIntQuantity of packages that have been staged.
startDateAWSTimestampEpoch-millisecond timestamp when the transfer order was started.
statusTransferOrderStatusCurrent lifecycle status of the transfer order.
totalQuantityIntTotal quantity of packages in the transfer order.
trackers[Tracker]Trackers attached to the transfer order.
transferFromLocationV2Source location the packages are transferred from.
transferToLocationV2Destination location the packages are transferred to.
uuidStringGlobally unique identifier of the package transfer order.
verifiedDateAWSTimestampEpoch-millisecond timestamp when the transfer order was verified.
verifiedQuantityIntQuantity of packages that have been verified.

RequestStatus​

The current status of a tracked asset as driven by the asset-request lifecycle.

ValueDescription
AVAILABLENot currently held against any active request.
CHECKED_OUTChecked out and not yet returned.
ON_HOLDReserved against a pending or approved CheckOut or Loan request.
ON_LOANLoaned out and not yet returned.
RETIREDRetired via a Scrap request.

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.

TransferOrderStatus​

Lifecycle status of a transfer order as it moves from creation through verification.

ValueDescription
CANCELLEDThe transfer order has been cancelled.
CREATEDThe transfer order has been created but not yet started.
RECEIVEDAll items for the transfer order have been received at the destination.
RECEIVING_IN_PROGRESSItems for the transfer order are being received at the destination.
SHIPPEDAll items for the transfer order have been shipped.
SHIPPING_IN_PROGRESSItems for the transfer order are being shipped.
STAGEDAll items for the transfer order have been staged.
STAGING_IN_PROGRESSItems for the transfer order are being staged for shipment.
VERIFIEDAll received items for the transfer order have been verified.
VERIFYING_IN_PROGRESSReceived items for the transfer order are being verified.