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.
| Field | Type | Description |
|---|---|---|
id | String | Identifier of the asset transfer order to retrieve. |
Returns
AssetTransferOrderPayload
Result of the assetTransferOrder query.
| Field | Type | Description |
|---|---|---|
assetTransferOrder | AssetTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
filter | String | Filter expression applied to asset transfer order properties. |
nextToken | String | Pagination token returned by a previous call to fetch the next page. |
Returns
AssetTransferOrdersPayload
Result of the assetTransferOrders query.
| Field | Type | Description |
|---|---|---|
assetTransferOrders | [AssetTransferOrder!] | The matching asset transfer orders. |
nextToken | String | Pagination 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.
| Field | Type | Description |
|---|---|---|
id | String | Identifier of the inventory transfer order to retrieve. |
Returns
InventoryTransferOrderPayload
Result of the inventoryTransferOrder query.
| Field | Type | Description |
|---|---|---|
inventoryTransferOrder | InventoryTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
filter | String | Filter expression applied to inventory transfer order properties. |
nextToken | String | Pagination token returned by a previous call to fetch the next page. |
Returns
InventoryTransferOrdersPayload
InventoryTransferOrdersPayload
Result of the inventoryTransferOrders query.
| Field | Type | Description |
|---|---|---|
inventoryTransferOrders | [InventoryTransferOrder!] | The matching inventory transfer orders. |
nextToken | String | Pagination 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.
| Field | Type | Description |
|---|---|---|
id | String | Identifier of the package transfer order to retrieve. |
Returns
PackageTransferOrderPayload
Result of the packageTransferOrder query.
| Field | Type | Description |
|---|---|---|
packageTransferOrder | PackageTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
filter | String | Filter expression applied to package transfer order properties. |
nextToken | String | Pagination token returned by a previous call to fetch the next page. |
Returns
PackageTransferOrdersPayload
Result of the packageTransferOrders query.
| Field | Type | Description |
|---|---|---|
nextToken | String | Pagination 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.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
entries | [CreateAssetTransferOrderEntryInput!]! | Asset entries (asset types and quantities) included in the transfer order. |
id | String! | 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. |
transferFromId | String | Identifier of the source location to transfer from. |
transferToId | String | Identifier of the destination location to transfer to. |
Returns
CreateAssetTransferOrderPayload
CreateAssetTransferOrderPayload
Result of the createAssetTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
assetTransferOrder | AssetTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
entries | [CreateInventoryTransferOrderEntryInput!]! | Part entries (SKUs and quantities) included in the transfer order. |
id | String! | 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. |
transferFromId | String | Identifier of the source location to transfer from. |
transferToId | String | Identifier of the destination location to transfer to. |
Returns
CreateInventoryTransferOrderPayload
CreateInventoryTransferOrderPayload
Result of the createInventoryTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
inventoryTransferOrder | InventoryTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
id | String! | 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. |
totalQuantity | Int | Total quantity of packages in the transfer order. |
trackers | [TrackerInput!] | Trackers to attach to the transfer order. |
transferFromId | String | Identifier of the source location to transfer from. |
transferToId | String | Identifier of the destination location to transfer to. |
Returns
CreatePackageTransferOrderPayload
CreatePackageTransferOrderPayload
Result of the createPackageTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
packageTransferOrder | PackageTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
id | String! | Identifier of the asset transfer order to delete. |
Returns
DeleteAssetTransferOrderPayload
DeleteAssetTransferOrderPayload
Result of the deleteAssetTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
assetTransferOrder | AssetTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
id | String! | Identifier of the inventory transfer order to delete. |
Returns
DeleteInventoryTransferOrderPayload
DeleteInventoryTransferOrderPayload
Result of the deleteInventoryTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
inventoryTransferOrder | InventoryTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
id | String! | Identifier of the package transfer order to delete. |
Returns
DeletePackageTransferOrderPayload
DeletePackageTransferOrderPayload
Result of the deletePackageTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
packageTransferOrder | PackageTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
addAssets | [CreateAssetTransferOrderItemInput!] | Assets to add to the entry. |
removeAssets | [CreateAssetTransferOrderItemInput!] | Assets to remove from the entry. |
totalQuantity | Int | Updated total quantity for the asset type in the transfer order. |
typeId | String! | 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.
| Field | Type | Description |
|---|---|---|
addTrackers | [TrackerInput!] | Trackers to add to the transfer order. |
addTypes | [CreateAssetTransferOrderEntryInput!] | New asset type entries to add to the transfer order. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
id | String! | 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. |
transferFromId | String | Updated identifier of the source location. |
transferToId | String | Updated 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.
| Field | Type | Description |
|---|---|---|
assetTransferOrder | AssetTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
addInventory | [CreateInventoryTransferOrderItemInput!] | Inventory items to add to the entry. |
partId | String! | Identifier of the part type or SKU for the entry to update. |
removeInventory | [CreateInventoryTransferOrderItemInput!] | Inventory items to remove from the entry. |
totalQuantity | Int | Updated total quantity for the part in the transfer order. |
UpdateInventoryTransferOrderInput
Input for updating an inventory transfer order's locations, tracker, parts, and custom properties.
| Field | Type | Description |
|---|---|---|
addParts | [CreateInventoryTransferOrderEntryInput!] | New part entries to add to the transfer order. |
addTrackers | [TrackerInput!] | Trackers to add to the transfer order. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
id | String! | 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. |
transferFromId | String | Updated identifier of the source location. |
transferToId | String | Updated identifier of the destination location. |
updateParts | [UpdateInventoryTransferOrderEntryInput!] | Existing part entries to update in the transfer order. |
Returns
UpdateInventoryTransferOrderPayload
UpdateInventoryTransferOrderPayload
Result of the updateInventoryTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
inventoryTransferOrder | InventoryTransferOrder | The 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.
| Field | Type | Description |
|---|---|---|
addTrackers | [TrackerInput!] | Trackers to add to the transfer order. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
id | String! | 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. |
totalQuantity | Int | Updated total quantity of packages in the transfer order. |
transferFromId | String | Updated identifier of the source location. |
transferToId | String | Updated identifier of the destination location. |
Returns
UpdatePackageTransferOrderPayload
UpdatePackageTransferOrderPayload
Result of the updatePackageTransferOrder mutation.
| Field | Type | Description |
|---|---|---|
packageTransferOrder | PackageTransferOrder | The updated package transfer order. |
Shared types
Entity types used across multiple operations on this page. Type names throughout link here.
Address
A business address.
| Field | Type | Description |
|---|---|---|
address | [String!] | Up to 4 street address lines. |
adminArea | String | State or administrative area. |
contactName | String | Name of the contact person at this address. |
countryCode | String | ISO 3166-1 alpha-2 country code (e.g. US). |
countryName | String | Full country name (e.g. United States). |
customProperties | AWSJSON | Additional custom properties as a JSON object. |
email | String | Email address for this contact. |
locality | String | City or locality. |
phoneNumber | String | Phone number for this address. |
postalCode | String | Postal or zip code. |
Asset
A tracked asset.
| Field | Type | Description |
|---|---|---|
comments | String | Any comments or remarks for the asset. |
containerId | String | Identifier of the container holding this asset, if any. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the asset was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the asset. |
dueDate | AWSTimestamp | Epoch-millisecond timestamp when the asset is due for maintenance or calibration. |
id | String | Unique identifier of the asset, usually the asset number. |
images | [String] | Public image URLs for the asset. |
lastDetectedAtLocation | LocationV2 | Location where the asset was last detected. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the asset was last detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the asset was last updated. |
location | LocationV2 | Location where the asset is currently tracked. |
name | String | Display name of the asset. |
owner | AssetOwner | Current owner of the asset, set via an Owner Change asset request. |
quantity | Float | Quantity represented by this asset record. |
requestStatus | RequestStatus | Current asset request status of the asset. |
state | String | Current state of the asset at its location (e.g. onhand, removed). |
trackers | [Tracker] | Trackers currently attached to this asset. |
transferOrderId | String | Identifier of the transfer order this asset belongs to, if any. |
transferStatus | String | Current transfer status of the asset, if part of a transfer order. |
type | AssetType | Asset type of the asset. |
uuid | String | Globally unique identifier of the asset. |
AssetOwner
The current owner of a tracked asset, set via an Owner Change asset request.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
firstName | String | First name. |
id | String! | Unique identifier of the owner. |
lastName | String | Last name. |
uuid | ID! | Globally unique identifier of the owner. |
AssetTransferOrder
A transfer order moving assets between locations.
| Field | Type | Description |
|---|---|---|
cancelledDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was cancelled. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
entries | [AssetTransferOrderEntry!]! | Asset entries included in the transfer order. |
id | String | Unique identifier of the asset transfer order. |
images | [String] | Image keys associated with the transfer order. |
lastDetectedAtLocation | LocationV2 | Location where the transfer order was last detected. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was last detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was last updated. |
location | LocationV2 | Current location of the transfer order. |
receivedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was received. |
shippedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was shipped. |
stagedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was staged. |
startDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was started. |
status | TransferOrderStatus | Current lifecycle status of the transfer order. |
trackers | [Tracker] | Trackers attached to the transfer order. |
transferFrom | LocationV2 | Source location the assets are transferred from. |
transferTo | LocationV2 | Destination location the assets are transferred to. |
uuid | String | Globally unique identifier of the asset transfer order. |
verifiedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was verified. |
AssetTransferOrderEntry
A single asset-type entry within an asset transfer order.
| Field | Type | Description |
|---|---|---|
assets | [Asset!] | Assets associated with this entry. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when this entry was last updated. |
receivedQuantity | Int | Quantity that has been received for this entry. |
shippedQuantity | Int | Quantity that has been shipped for this entry. |
stagedQuantity | Int | Quantity that has been staged for this entry. |
status | TransferOrderStatus | Current lifecycle status of this entry. |
totalQuantity | Int | Total quantity to transfer for this entry. |
type | AssetType | The asset type being transferred in this entry. |
unit | String | Unit of measure for the quantities, if applicable. |
verifiedQuantity | Int | Quantity that has been verified for this entry. |
AssetType
A type (template) describing a class of assets.
| Field | Type | Description |
|---|---|---|
categories | [AssetTypeCategory] | Categories this asset type belongs to. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the asset type was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customerAssetTypes | [CustomerAssetType!] | Per-customer asset types mapped to this asset type. |
description | String | Free-text description of the asset type. |
id | String | Unique identifier of the asset type, usually the asset type number or SKU. |
images | [String!] | Public image URLs for the asset type. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the asset type was last updated. |
name | String | Display name of the asset type. |
number | String | Asset type number. |
quantity | Int | Expected quantity of the asset type. |
unit | String | Unit of measure of the asset type. |
uuid | String | Globally unique identifier of the asset type. |
AssetTypeCategory
A category grouping asset types, resolved through the asset's type.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the category. |
id | ID! | Unique identifier of the category. |
name | String | Display name of the category. |
parent | AssetTypeCategory | Parent category, if the category is not a root category. |
uuid | String | Globally unique identifier of the category. |
CreateAssetTransferOrderEntryInput
Input describing a single asset entry (asset type and quantity) of an asset transfer order.
| Field | Type | Description |
|---|---|---|
assets | [CreateAssetTransferOrderItemInput!] | Detailed assets associated with this entry. |
totalQuantity | Int! | Quantity of the asset type to transfer. |
trackers | [TrackerInput!] | Trackers identifying the assets in this entry. |
typeId | String! | Identifier of the asset type for this entry. |
unit | String | Unit of measure for the quantity, if applicable. |
CreateAssetTransferOrderItemInput
Input identifying a single asset to include in a transfer order entry.
| Field | Type | Description |
|---|---|---|
id | String | Unique 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.
| Field | Type | Description |
|---|---|---|
inventory | [CreateInventoryTransferOrderItemInput!] | Detailed inventory items associated with the part. |
partId | String! | Identifier of the part type or SKU for this entry. |
totalQuantity | Int! | Quantity of the part type or SKU to transfer. |
trackers | [TrackerInput!] | Trackers identifying the inventory items in this entry. |
unit | String | Unit of measure for the quantity, if applicable. |
CreateInventoryTransferOrderItemInput
Input identifying a single inventory item to include in a transfer order entry.
| Field | Type | Description |
|---|---|---|
id | String | Unique identifier of the inventory item. |
trackers | [TrackerInput!] | Trackers identifying the inventory item. |
CustomerAssetType
A customer-specific asset type mapped to an asset type.
| Field | Type | Description |
|---|---|---|
customerAssetTypeId | String! | The customer's asset type for this asset type. |
customerId | String! | Unique identifier of the customer. |
CustomerPartNumber
A customer-specific part number mapped to an inventory part.
| Field | Type | Description |
|---|---|---|
customerId | String! | Unique identifier of the customer. |
customerPartNumber | String! | The customer's part number for this part. |
CustomerV2
A customer, supplier, or other external organization associated with tracked items.
| Field | Type | Description |
|---|---|---|
addresses | [Address!] | Business addresses of this organization. |
customProperties | AWSJSON | Additional custom properties as a JSON object. |
description | String | Free-text description of the organization. |
id | String | Unique identifier of the organization. |
name | String | Display name of the organization. |
Inventory
A tracked inventory item.
| Field | Type | Description |
|---|---|---|
comments | String | Free-text comments on the inventory item. |
consumedDate | AWSTimestamp | Epoch-millisecond timestamp when the item was consumed. |
containerId | String | Identifier of the container holding this item, if any. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the item was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customerPartNumber | String | Customer-specific part number for this item, if any. |
description | String | Free-text description of the inventory item. |
expirationDate | AWSTimestamp | Epoch-millisecond timestamp when the item expires. |
id | String | Unique identifier of the inventory item. |
images | [String] | Image URLs for the inventory item. |
isConsumed | Boolean | Whether the item has been consumed. |
lastDetectedAtLocation | LocationV2 | Location where the inventory item was last detected. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the item was last detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the item was last updated. |
location | LocationV2 | Current location of the inventory item. |
lotNumber | String | Lot number of the lot this item belongs to. |
name | String | Display name of the inventory item. |
part | InventoryPart | The part (item type) this inventory item is an instance of. |
quantity | Float | Quantity represented by this inventory item. |
state | String | Current state of the inventory item (e.g. OnHand). |
trackers | [Tracker] | Trackers attached to this inventory item. |
transferOrderId | String | Identifier of the transfer order this item is part of, if any. |
transferStatus | String | Transfer status of the inventory item. |
uuid | String | Globally unique identifier of the inventory item. |
InventoryPart
An inventory part (item type) describing a class of inventory items.
| Field | Type | Description |
|---|---|---|
categories | [InventoryPartCategory!] | Categories the part is directly assigned to. Each category links to its parent category, if any. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the part was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customerPartNumbers | [CustomerPartNumber!] | Per-customer part numbers mapped to this part. |
description | String | Free-text description of the part. |
id | String | Unique identifier of the inventory part (item type), usually the item or SKU number. |
images | [String!] | Image URLs for the part. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the part was last updated. |
name | String | Display name of the part. |
number | String | Part number. |
quantity | Int | Expected quantity represented by the part. |
supplier | CustomerV2 | Supplier for this inventory part, if one is attached. |
unit | String | Unit of measure for the part. |
uuid | String | Globally unique identifier of the inventory part. |
InventoryPartCategory
A category an inventory part belongs to. Categories form a tree through their parent.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the category. |
id | ID! | Unique identifier of the category. |
name | String | Display name of the category. |
parent | InventoryPartCategory | Parent category, if the category is not a root category. |
uuid | String | Globally unique identifier of the category. |
InventoryTransferOrder
A transfer order moving inventory parts between locations.
| Field | Type | Description |
|---|---|---|
cancelledDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was cancelled. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
entries | [InventoryTransferOrderEntry!]! | Part entries included in the transfer order. |
id | String | Unique identifier of the inventory transfer order. |
images | [String] | Image keys associated with the transfer order. |
lastDetectedAtLocation | LocationV2 | Location where the transfer order was last detected. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was last detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was last updated. |
location | LocationV2 | Current location of the transfer order. |
receivedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was received. |
shippedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was shipped. |
stagedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was staged. |
startDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was started. |
status | TransferOrderStatus | Current lifecycle status of the transfer order. |
trackers | [Tracker] | Trackers attached to the transfer order. |
transferFrom | LocationV2 | Source location the inventory is transferred from. |
transferTo | LocationV2 | Destination location the inventory is transferred to. |
uuid | String | Globally unique identifier of the inventory transfer order. |
verifiedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was verified. |
InventoryTransferOrderEntry
A single part entry within an inventory transfer order.
| Field | Type | Description |
|---|---|---|
inventory | [Inventory!] | Inventory items associated with this entry. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when this entry was last updated. |
part | InventoryPart | The part type or SKU being transferred in this entry. |
receivedQuantity | Int | Quantity that has been received for this entry. |
shippedQuantity | Int | Quantity that has been shipped for this entry. |
stagedQuantity | Int | Quantity that has been staged for this entry. |
status | TransferOrderStatus | Current lifecycle status of this entry. |
totalQuantity | Int | Total quantity to transfer for this entry. |
unit | String | Unit of measure for the quantities, if applicable. |
verifiedQuantity | Int | Quantity that has been verified for this entry. |
LocationV2
A location in the tenant's location hierarchy.
| Field | Type | Description |
|---|---|---|
categoryId | String | Identifier of the location category this location is classified under. |
childLocationIds | [String!] | Identifiers of locations nested directly beneath this one. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
customerId | String | Identifier of the customer this location belongs to, if any. |
description | String | Free-text description of the location. |
id | String | Unique identifier of the location. |
name | String | Display name of the location. |
parentLocationId | String | Identifier of the parent location in the hierarchy, if any. |
roleId | String | Identifier of the location role describing how this location is used. |
Package
A tracked package, identified by its package ID and optional tracker.
| Field | Type | Description |
|---|---|---|
comments | String | Any comments or remarks recorded for the package. |
containerId | String | Identifier of the container holding this package, if any. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the package was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the package. |
id | String! | Unique identifier of the package. |
lastDetectedAtLocation | LocationV2 | Location where the package was last detected. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the package was last detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the package was last updated. |
location | LocationV2 | Current location of the package. |
name | String | Display name of the package. |
state | String | Current state of the package. |
trackers | [Tracker] | Trackers currently attached to the package. |
transferOrderId | String | Identifier of the transfer order this package belongs to, if any. |
transferStatus | String | Current transfer status of the package. |
uuid | String | Globally unique identifier of the package. |
PackageInput
A single package to create.
| Field | Type | Description |
|---|---|---|
comments | String | Any comments or remarks recorded for the package. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the package. |
id | String! | Serial or unique identifier for the package. |
locationId | String | Identifier of the location the package is at. |
name | String | Display name of the package. |
trackers | [TrackerInput!] | Trackers to attach to the package. |
PackageTransferOrder
A transfer order moving packages between locations.
| Field | Type | Description |
|---|---|---|
cancelledDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was cancelled. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
id | String! | Unique identifier of the package transfer order. |
images | [String] | Image keys associated with the transfer order. |
lastDetectedAtLocation | LocationV2 | Location where the transfer order was last detected. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was last detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was last updated. |
location | LocationV2 | Current location of the transfer order. |
packages | [Package!] | Packages included in the transfer order. |
receivedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was received. |
receivedQuantity | Int | Quantity of packages that have been received. |
shippedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was shipped. |
shippedQuantity | Int | Quantity of packages that have been shipped. |
stagedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was staged. |
stagedQuantity | Int | Quantity of packages that have been staged. |
startDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was started. |
status | TransferOrderStatus | Current lifecycle status of the transfer order. |
totalQuantity | Int | Total quantity of packages in the transfer order. |
trackers | [Tracker] | Trackers attached to the transfer order. |
transferFrom | LocationV2 | Source location the packages are transferred from. |
transferTo | LocationV2 | Destination location the packages are transferred to. |
uuid | String | Globally unique identifier of the package transfer order. |
verifiedDate | AWSTimestamp | Epoch-millisecond timestamp when the transfer order was verified. |
verifiedQuantity | Int | Quantity of packages that have been verified. |
RequestStatus
The current status of a tracked asset as driven by the asset-request lifecycle.
| Value | Description |
|---|---|
AVAILABLE | Not currently held against any active request. |
CHECKED_OUT | Checked out and not yet returned. |
ON_HOLD | Reserved against a pending or approved CheckOut or Loan request. |
ON_LOAN | Loaned out and not yet returned. |
RETIRED | Retired via a Scrap request. |
Tracker
An identifier tracker (e.g. RFID tag or barcode) attached to a tracked item.
| Field | Type | Description |
|---|---|---|
attachDate | AWSTimestamp | Epoch-millisecond timestamp when the tracker was attached to the item. |
customProperties | AWSJSON | Tenant-specific sensor profile custom properties. |
encodingFormat | String | RFID tag encoding format for this tracker. |
serial | String | EPC or tracker serial identifying this tracker. |
TrackerInput
Input for specifying a tracker to attach when creating or updating an item. Replaces the per-field trackerSerial / reuseTrackerSerial pattern.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Tracker-level custom properties as a JSON object. |
encodingFormat | String | RFID tag encoding format for this tracker. |
reuseTrackerSerial | Boolean | Whether to reuse a tracker serial already attached to another item. |
serial | String! | EPC or tracker serial to attach. |
TransferOrderStatus
Lifecycle status of a transfer order as it moves from creation through verification.
| Value | Description |
|---|---|
CANCELLED | The transfer order has been cancelled. |
CREATED | The transfer order has been created but not yet started. |
RECEIVED | All items for the transfer order have been received at the destination. |
RECEIVING_IN_PROGRESS | Items for the transfer order are being received at the destination. |
SHIPPED | All items for the transfer order have been shipped. |
SHIPPING_IN_PROGRESS | Items for the transfer order are being shipped. |
STAGED | All items for the transfer order have been staged. |
STAGING_IN_PROGRESS | Items for the transfer order are being staged for shipment. |
VERIFIED | All received items for the transfer order have been verified. |
VERIFYING_IN_PROGRESS | Received items for the transfer order are being verified. |