Containers API
Authentication: every request needs an
IdToken— see Authentication. Error shapes: Errors.
Endpoint: POST https://api.xemelgo.com/graphql
Queries
containers
Lists containers and their contents, with optional filtering and pagination.
query Containers($input: ContainersInput) {
containers(input: $input) {
nextToken
containers {
assetIds
childContainerIds
comments
creationDate
customProperties
description
id
images
inventoryIds
lastDetectionDate
lastUpdatedDate
name
packageIds
parentContainerId
state
transferOrderId
transferStatus
uuid
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
type {
id
name
number
}
}
}
}
Example variables
{
"input": {
"filter": "name:\"Forklift*\"",
"nextToken": "eyJpZCI6IjEwMjQifQ=="
}
}
Example response
{
"data": {
"containers": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"containers": [
{
"assetIds": [
"example"
],
"childContainerIds": [
"example"
],
"comments": "Inspected and approved",
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "container-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"inventoryIds": [
"example"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"name": "Forklift 7",
"packageIds": [
"example"
],
"parentContainerId": "parentcontainer-001",
"state": "ACTIVE",
"transferOrderId": "transferorder-001",
"transferStatus": "example",
"uuid": "uu-001",
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "containertype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
]
}
}
}
Arguments
input · ContainersInput
ContainersInput
Input for listing containers, with optional filtering and pagination.
| Field | Type | Description |
|---|---|---|
filter | String | Filter expression applied to container properties. |
nextToken | String | Pagination token for the next page of results. |
Returns
ContainersOutput
Result of the containers query.
| Field | Type | Description |
|---|---|---|
containers | [Container!] | The matching containers. |
nextToken | String | Token for retrieving the next page of results, if any. |
containerTypes
Lists container types, with optional filtering and pagination.
query ContainerTypes($input: ContainerTypesInput) {
containerTypes(input: $input) {
nextToken
containerTypes {
creationDate
customProperties
description
id
images
lastUpdatedDate
name
number
quantity
unit
uuid
}
}
}
Example variables
{
"input": {
"filter": "name:\"Forklift*\"",
"nextToken": "eyJpZCI6IjEwMjQifQ=="
}
}
Example response
{
"data": {
"containerTypes": {
"nextToken": "eyJpZCI6IjEwMjQifQ==",
"containerTypes": [
{
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "containertype-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"lastUpdatedDate": 1719792000000,
"name": "Forklift 7",
"number": "AST-1024",
"quantity": 10,
"unit": "EA",
"uuid": "uu-001"
}
]
}
}
}
Arguments
input · ContainerTypesInput
ContainerTypesInput
Input for listing container types, with optional filtering and pagination.
| Field | Type | Description |
|---|---|---|
filter | String | Filter expression applied to container type properties. |
nextToken | String | Pagination token for the next page of results. |
Returns
ContainerTypesPayload
Result of the containerTypes query.
| Field | Type | Description |
|---|---|---|
containerTypes | [ContainerType!]! | The matching container types. |
nextToken | String | Token for retrieving the next page of results, if any. |
Mutations
createContainer
Creates a container, optionally with its initial contents, and returns it.
mutation CreateContainer($input: CreateContainerInput!) {
createContainer(input: $input) {
container {
assetIds
childContainerIds
comments
creationDate
customProperties
description
id
images
inventoryIds
lastDetectionDate
lastUpdatedDate
name
packageIds
parentContainerId
state
transferOrderId
transferStatus
uuid
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
type {
id
name
number
}
}
}
}
Example variables
{
"input": {
"assets": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"id": "containerasset-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"locationId": "location-001",
"name": "Forklift 7",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"typeId": "type-001"
}
],
"childContainerIds": [
"example"
],
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "createcontainer-001",
"inventory": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"expirationDate": 1719792000000,
"id": "containerinventory-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"locationId": "location-001",
"lotNumber": "example",
"name": "Forklift 7",
"partId": "part-001",
"quantity": 1,
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"locationId": "location-001",
"name": "Forklift 7",
"packages": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "containerpackage-001",
"locationId": "location-001",
"name": "Forklift 7",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"typeId": "type-001"
}
}
Example response
{
"data": {
"createContainer": {
"container": {
"assetIds": [
"example"
],
"childContainerIds": [
"example"
],
"comments": "Inspected and approved",
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "container-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"inventoryIds": [
"example"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"name": "Forklift 7",
"packageIds": [
"example"
],
"parentContainerId": "parentcontainer-001",
"state": "ACTIVE",
"transferOrderId": "transferorder-001",
"transferStatus": "example",
"uuid": "uu-001",
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "containertype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
}
}
}
Arguments
input · CreateContainerInput!
CreateContainerInput
Input for creating a container, optionally with its initial contents.
| Field | Type | Description |
|---|---|---|
assets | [ContainerAssetInput!] | Assets to place inside the container. |
childContainerIds | [String!] | Identifiers of existing containers to nest inside this container. |
comments | String | Comments or remarks recorded for the container. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the container. |
id | String! | Unique identifier for the new container. |
inventory | [ContainerInventoryInput!] | Inventory items to place inside the container. |
locationId | String | Identifier of the location to associate with the container. |
name | String | Display name of the container. |
packages | [ContainerPackageInput!] | Packages to place inside the container. |
trackers | [TrackerInput!] | Trackers to attach to the container. |
typeId | String | Identifier of the container type to associate with the container. |
Returns
CreateContainerOutput
Result of the createContainer mutation.
| Field | Type | Description |
|---|---|---|
container | Container! | The created container. |
createContainerTypes
Creates one or more container types and returns their identifiers.
mutation CreateContainerTypes($input: CreateContainerTypesInput!) {
createContainerTypes(input: $input) {
containerTypeIds
}
}
Example variables
{
"input": {
"containerTypes": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "createcontainertype-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"name": "Forklift 7",
"number": "AST-1024",
"quantity": 10,
"unit": "EA"
}
]
}
}
Example response
{
"data": {
"createContainerTypes": {
"containerTypeIds": [
"example"
]
}
}
}
Arguments
input · CreateContainerTypesInput!
CreateContainerTypeInput
A single container type to create.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the container type. |
id | String! | Unique identifier for the new container type. |
images | [String!] | Image URLs associated with the container type. |
name | String | Display name of the container type. |
number | String | Container type number or SKU. |
quantity | Int | Expected quantity for this container type. |
unit | String | Unit of measure for the container type. |
CreateContainerTypesInput
Input for creating one or more container types.
| Field | Type | Description |
|---|---|---|
containerTypes | [CreateContainerTypeInput!]! | The container types to create. |
Returns
CreateContainerTypesPayload
Result of the createContainerTypes mutation.
| Field | Type | Description |
|---|---|---|
containerTypeIds | [String] | Identifiers of the created container types. |
deleteContainer
Deletes an empty container and returns it.
mutation DeleteContainer($input: DeleteContainerInput!) {
deleteContainer(input: $input) {
container {
assetIds
childContainerIds
comments
creationDate
customProperties
description
id
images
inventoryIds
lastDetectionDate
lastUpdatedDate
name
packageIds
parentContainerId
state
transferOrderId
transferStatus
uuid
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
type {
id
name
number
}
}
}
}
Example variables
{
"input": {
"containerId": "container-001"
}
}
Example response
{
"data": {
"deleteContainer": {
"container": {
"assetIds": [
"example"
],
"childContainerIds": [
"example"
],
"comments": "Inspected and approved",
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "container-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"inventoryIds": [
"example"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"name": "Forklift 7",
"packageIds": [
"example"
],
"parentContainerId": "parentcontainer-001",
"state": "ACTIVE",
"transferOrderId": "transferorder-001",
"transferStatus": "example",
"uuid": "uu-001",
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "containertype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
}
}
}
Arguments
input · DeleteContainerInput!
DeleteContainerInput
Input for deleting a container.
| Field | Type | Description |
|---|---|---|
containerId | String! | Identifier of the container to delete. |
Returns
DeleteContainerOutput
Result of the deleteContainer mutation.
| Field | Type | Description |
|---|---|---|
container | Container! | The deleted container. |
updateContainer
Updates a container's properties and contents, and returns it.
mutation UpdateContainer($input: UpdateContainerInput!) {
updateContainer(input: $input) {
container {
assetIds
childContainerIds
comments
creationDate
customProperties
description
id
images
inventoryIds
lastDetectionDate
lastUpdatedDate
name
packageIds
parentContainerId
state
transferOrderId
transferStatus
uuid
lastDetectedAtLocation {
id
name
}
location {
id
name
}
trackers {
serial
}
type {
id
name
number
}
}
}
}
Example variables
{
"input": {
"id": "updatecontainer-001",
"updates": {
"addAssets": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"dueDate": 1719792000000,
"id": "containerasset-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"locationId": "location-001",
"name": "Forklift 7",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"typeId": "type-001"
}
],
"addChildContainerIds": [
"example"
],
"addInventory": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"expirationDate": 1719792000000,
"id": "containerinventory-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"locationId": "location-001",
"lotNumber": "example",
"name": "Forklift 7",
"partId": "part-001",
"quantity": 1,
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"addPackages": [
{
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "containerpackage-001",
"locationId": "location-001",
"name": "Forklift 7",
"trackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
]
}
],
"addTrackers": [
{
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"encodingFormat": "example",
"reuseTrackerSerial": false,
"serial": "E28011700000020ABC12345"
}
],
"comments": "Inspected and approved",
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "container-001",
"locationId": "location-001",
"name": "Forklift 7",
"removeAssetIds": [
"example"
],
"removeChildContainerIds": [
"example"
],
"removeInventoryIds": [
"example"
],
"removePackageIds": [
"example"
],
"typeId": "type-001"
}
}
}
Example response
{
"data": {
"updateContainer": {
"container": {
"assetIds": [
"example"
],
"childContainerIds": [
"example"
],
"comments": "Inspected and approved",
"creationDate": 1719792000000,
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "container-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"inventoryIds": [
"example"
],
"lastDetectionDate": 1719792000000,
"lastUpdatedDate": 1719792000000,
"name": "Forklift 7",
"packageIds": [
"example"
],
"parentContainerId": "parentcontainer-001",
"state": "ACTIVE",
"transferOrderId": "transferorder-001",
"transferStatus": "example",
"uuid": "uu-001",
"lastDetectedAtLocation": {
"id": "location-001",
"name": "Forklift 7"
},
"location": {
"id": "location-001",
"name": "Forklift 7"
},
"trackers": [
{
"serial": "E28011700000020ABC12345"
}
],
"type": {
"id": "containertype-001",
"name": "Forklift 7",
"number": "AST-1024"
}
}
}
}
}
Arguments
input · UpdateContainerInput!
ContainerUpdates
Fields to update on a container, including contents to add or remove.
| Field | Type | Description |
|---|---|---|
addAssets | [ContainerAssetInput!] | Assets to add to the container. |
addChildContainerIds | [String!] | Identifiers of containers to nest inside this container. |
addInventory | [ContainerInventoryInput!] | Inventory items to add to the container. |
addPackages | [ContainerPackageInput!] | Packages to add to the container. |
addTrackers | [TrackerInput!] | Trackers to attach to the container. |
comments | String | New comments or remarks for the container. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | New description for the container. |
id | String | New identifier for the container (rename). |
locationId | String | New location to associate with the container. |
name | String | New display name for the container. |
removeAssetIds | [String!] | Identifiers of assets to remove from the container. |
removeChildContainerIds | [String!] | Identifiers of child containers to remove from this container. |
removeInventoryIds | [String!] | Identifiers of inventory items to remove from the container. |
removePackageIds | [String!] | Identifiers of packages to remove from the container. |
typeId | String | New container type identifier. |
UpdateContainerInput
Input for updating a container.
| Field | Type | Description |
|---|---|---|
id | String! | Identifier of the container to update. |
updates | ContainerUpdates! | Fields to apply to the container. |
Returns
UpdateContainerOutput
Result of the updateContainer mutation.
| Field | Type | Description |
|---|---|---|
container | Container! | The updated container. |
updateContainerTypes
Updates one or more container types and returns their identifiers.
mutation UpdateContainerTypes($input: UpdateContainerTypesInput!) {
updateContainerTypes(input: $input) {
containerTypeIds
}
}
Example variables
{
"input": {
"containerTypes": [
{
"id": "updatecontainertype-001",
"updates": {
"customProperties": "{\"weight\":\"15kg\",\"color\":\"blue\"}",
"description": "Electric counterbalance forklift",
"id": "containertype-001",
"images": [
"https://cdn.example.com/asset-1024.png"
],
"name": "Forklift 7",
"number": "AST-1024",
"quantity": 10,
"unit": "EA"
}
}
]
}
}
Example response
{
"data": {
"updateContainerTypes": {
"containerTypeIds": [
"example"
]
}
}
}
Arguments
input · UpdateContainerTypesInput!
ContainerTypeUpdates
Container type updates.
| Field | Type | Description |
|---|---|---|
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the container type. |
id | String! | Identifier of the container type to update. |
images | [String!] | Image URLs associated with the container type. |
name | String | Display name of the container type. |
number | String | Container type number or SKU. |
quantity | Int | Expected quantity for this container type. |
unit | String | Unit of measure for the container type. |
UpdateContainerTypeInput
A single container type to update.
| Field | Type | Description |
|---|---|---|
id | String! | Identifier of the container type to update. |
updates | ContainerTypeUpdates | Updates to apply to the container type. |
UpdateContainerTypesInput
Input for updating one or more container types.
| Field | Type | Description |
|---|---|---|
containerTypes | [UpdateContainerTypeInput!]! | The container types to update. |
Returns
UpdateContainerTypesPayload
Result of the updateContainerTypes mutation.
| Field | Type | Description |
|---|---|---|
containerTypeIds | [String] | Identifiers of the updated container types. |
Shared types
Entity types used across multiple operations on this page. Type names throughout link here.
Container
A container that holds assets, inventory items, packages, or nested child containers.
| Field | Type | Description |
|---|---|---|
assetIds | [String!]! | Identifiers of assets held inside the container. |
childContainerIds | [String!]! | Identifiers of child containers nested inside this container. |
comments | String | Comments or remarks recorded for the container. |
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the container was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the container. |
id | String! | Unique identifier of the container. |
images | [String] | Image URLs associated with the container. |
inventoryIds | [String!]! | Identifiers of inventory items held inside the container. |
lastDetectedAtLocation | LocationV2 | Location where the container was most recently detected. |
lastDetectionDate | AWSTimestamp | Epoch-millisecond timestamp when the container was most recently detected. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the container was last updated. |
location | LocationV2 | Location currently assigned to the container. |
name | String | Display name of the container. |
packageIds | [String!]! | Identifiers of packages held inside the container. |
parentContainerId | String | Identifier of the parent container, if this container is nested. |
state | String | Current lifecycle state of the container. |
trackers | [Tracker] | Trackers attached to the container. |
transferOrderId | String | Identifier of the transfer order this container belongs to, if any. |
transferStatus | String | Status of the container within its transfer order, if any. |
type | ContainerType | The container type this container is classified under. |
uuid | String | Globally unique identifier of the container. |
ContainerAssetInput
An asset to place inside a container, either by referencing an existing asset or creating a new one.
| Field | Type | Description |
|---|---|---|
comments | String | Comments or remarks recorded for the asset. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the asset. |
dueDate | AWSTimestamp | Epoch-millisecond timestamp for the asset's due date. |
id | String! | Identifier of the existing asset to add to the container. |
images | [String] | Image URLs associated with the asset. |
locationId | String | Identifier of the location to associate with the asset. |
name | String | Display name of the asset. |
trackers | [TrackerInput!] | Trackers to attach to the asset. |
typeId | String | Identifier of the asset type to associate with the asset. |
ContainerInventoryInput
An inventory item to place inside a container, either by referencing an existing item or creating a new one.
| Field | Type | Description |
|---|---|---|
comments | String | Comments or remarks recorded for the inventory item. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the inventory item. |
expirationDate | AWSTimestamp | Epoch-millisecond timestamp for the inventory item's expiration date. |
id | String! | Identifier of the existing inventory item to add to the container. |
images | [String] | Image URLs associated with the inventory item. |
locationId | String | Identifier of the location to associate with the inventory item. |
lotNumber | String | Lot number of the inventory item. |
name | String | Display name of the inventory item. |
partId | String | Identifier of the part associated with the inventory item. |
quantity | Float | Quantity of the inventory item. |
trackers | [TrackerInput!] | Trackers to attach to the inventory item. |
ContainerPackageInput
A package to place inside a container, either by referencing an existing package or creating a new one.
| Field | Type | Description |
|---|---|---|
comments | String | 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! | Identifier of the existing package to add to the container. |
locationId | String | Identifier of the location to associate with the package. |
name | String | Display name of the package. |
trackers | [TrackerInput!] | Trackers to attach to the package. |
ContainerType
A container type: the classification template (e.g. Bin, Pallet, Tote) that describes a class of containers.
| Field | Type | Description |
|---|---|---|
creationDate | AWSTimestamp | Epoch-millisecond timestamp when the container type was created. |
customProperties | AWSJSON | Additional custom properties, serialized as a JSON string. |
description | String | Free-text description of the container type. |
id | String! | Unique identifier of the container type. |
images | [String!] | Image URLs associated with the container type. |
lastUpdatedDate | AWSTimestamp | Epoch-millisecond timestamp when the container type was last updated. |
name | String | Display name of the container type. |
number | String | Container type number or SKU. |
quantity | Int | Expected quantity for this container type. |
unit | String | Unit of measure for the container type. |
uuid | String | Globally unique identifier of the container type. |
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. |
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. |