Inventory

Navixy Repository API is a work in progress. This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.

Inventory management for device stock, including warehouses, assignments, and device-inventory relationships.

Queries

inventory

Retrieves an inventory by its ID.

inventory(id: ID!): Inventory

Arguments

Name	Type	Description
id	ID!	The ID of the inventory to retrieve.

Output types:

Inventory

An inventory or warehouse record for device stock management.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this inventory.
devices	DeviceConnection!	The devices assigned to this inventory.

Organization (entity)

An organization in the hierarchy that owns entities and users.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
externalId	String	An external system identifier for integration purposes.
isActive	Boolean!	Whether this organization is active.
features	[OrganizationFeature!]!	The feature flags enabled for this organization.
parent	Organization	The parent organization in the hierarchy. Null for root organizations.
children	OrganizationConnection!	The child organizations.
members	MemberConnection!	The members of this organization.
devices	DeviceConnection!	The devices owned by this organization.
assets	AssetConnection!	The assets owned by this organization.
geoObjects	GeoObjectConnection!	The geographic objects owned by this organization.
schedules	ScheduleConnection!	The schedules owned by this organization.

---

inventories

Lists inventories for an organization.

inventories(
    organizationId: ID!
    filter: InventoryFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: InventoryOrder = { field: TITLE, direction: ASC }
  ): InventoryConnection!

Arguments

Name	Type	Description
organizationId	ID!	The organization to retrieve inventories for.
filter	InventoryFilter	Filtering options for the returned inventories.
first	Int	The first n elements from the paginated list.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	InventoryOrder	The ordering options for the returned inventories.

Input types:

InventoryFilter

Filtering options for inventories.

Field	Type	Description
titleContains	String	Partial match on title (case-insensitive contains).

InventoryOrder

Ordering options for inventories.

Field	Type	Description
field	InventoryOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

InventoryConnection

A paginated list of Inventory items.

Implements: Connection

Field	Type	Description
edges	[InventoryEdge!]!	A list of edges.
nodes	[Inventory!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

PageInfo (entity)

Information about the current page in a paginated connection.

Field	Type	Description
hasNextPage	Boolean!	Whether more items exist after the current page.
hasPreviousPage	Boolean!	Whether more items exist before the current page.
startCursor	String	The cursor pointing to the first item in the current page.
endCursor	String	The cursor pointing to the last item in the current page.

---

Mutations

inventoryCreate

Creates a new inventory.

inventoryCreate(
    input: InventoryCreateInput!
  ): InventoryPayload

Arguments

Name	Type	Description
input	InventoryCreateInput!	The input fields for creating the inventory.

Input types:

InventoryCreateInput

Input for creating a new inventory.

Field	Type	Description
organizationId	ID!	The organization that will own the inventory.
title	String!	The display name.

Output types:

InventoryPayload

The result of an inventory mutation.

Field	Type	Description
inventory	Inventory!	The created or updated inventory.

Inventory (entity)

An inventory or warehouse record for device stock management.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this inventory.
devices	DeviceConnection!	The devices assigned to this inventory.

---

inventoryUpdate

Updates an existing inventory.

inventoryUpdate(
    input: InventoryUpdateInput!
  ): InventoryPayload

Arguments

Name	Type	Description
input	InventoryUpdateInput!	The input fields for updating the inventory.

Input types:

InventoryUpdateInput

Input for updating an existing inventory.

Field	Type	Description
id	ID!	The inventory ID to update.
version	Int!	The current version for optimistic locking.
title	String	The new display name.

Output types:

InventoryPayload

The result of an inventory mutation.

Field	Type	Description
inventory	Inventory!	The created or updated inventory.

Inventory (entity)

An inventory or warehouse record for device stock management.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this inventory.
devices	DeviceConnection!	The devices assigned to this inventory.

---

inventoryDelete

Deletes an inventory.

inventoryDelete(
    input: InventoryDeleteInput!
  ): DeletePayload

Arguments

Name	Type	Description
input	InventoryDeleteInput!	The input fields for deleting the inventory.

Input types:

InventoryDeleteInput

Input for deleting an inventory.

Field	Type	Description
id	ID!	The inventory ID to delete.
version	Int!	The current version for optimistic locking.

Output types:

DeletePayload

The result of a delete mutation.

Field	Type	Description
deletedId	ID!	The ID of the deleted entity.

---

deviceInventoryLink

Links a device to an inventory.

deviceInventoryLink(
    input: DeviceInventoryLinkInput!
  ): DeviceInventoryRelationPayload

Arguments

Name	Type	Description
input	DeviceInventoryLinkInput!	The input fields for linking the device.

Input types:

DeviceInventoryLinkInput

Input for linking a device to an inventory. Both device and inventory must belong to the same organization.

Field	Type	Description
deviceId	ID!	The device ID.
inventoryId	ID!	The inventory ID. Must be in the same organization as the device.

Output types:

DeviceInventoryRelationPayload

The result of a device inventory link mutation.

Field	Type	Description
deviceInventoryRelation	DeviceInventoryRelation!	The created inventory assignment.

DeviceInventoryRelation (entity)

A record of a device's assignment to an inventory.

Implements: Node

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
device	Device!	The device that was assigned.
inventory	Inventory!	The inventory the device was assigned to.
assignedAt	DateTime!	The date and time when the device was assigned.
assignedBy	Actor	The actor who assigned the device.

---

deviceInventoryUnlink

Unlinks a device from an inventory.

deviceInventoryUnlink(
    input: DeviceInventoryUnlinkInput!
  ): DeletePayload

Arguments

Name	Type	Description
input	DeviceInventoryUnlinkInput!	The input fields for unlinking the device.

Input types:

DeviceInventoryUnlinkInput

Input for unlinking a device from an inventory.

Field	Type	Description
deviceId	ID!	The device ID to unlink.

Output types:

DeletePayload

The result of a delete mutation.

Field	Type	Description
deletedId	ID!	The ID of the deleted entity.

---

Objects

DeviceInventoryRelation

A record of a device's assignment to an inventory.

Implements: Node

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
device	Device!	The device that was assigned.
inventory	Inventory!	The inventory the device was assigned to.
assignedAt	DateTime!	The date and time when the device was assigned.
assignedBy	Actor	The actor who assigned the device.

---

Inventory

An inventory or warehouse record for device stock management.

Implements: Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier. This ID is opaque and should not be parsed by clients.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The human-readable display name.
organization	Organization!	The organization that owns this inventory.
devices	DeviceConnection!	The devices assigned to this inventory.

---

InventoryPayload

The result of an inventory mutation.

Field	Type	Description
inventory	Inventory!	The created or updated inventory.

---

DeviceInventoryRelationPayload

The result of a device inventory link mutation.

Field	Type	Description
deviceInventoryRelation	DeviceInventoryRelation!	The created inventory assignment.

---

Inputs

DeviceInventoryRelationOrder

Ordering options for device inventory relations.

Field	Type	Description
field	DeviceInventoryRelationOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

---

InventoryFilter

Filtering options for inventories.

Field	Type	Description
titleContains	String	Partial match on title (case-insensitive contains).

---

InventoryOrder

Ordering options for inventories.

Field	Type	Description
field	InventoryOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

---

InventoryCreateInput

Input for creating a new inventory.

Field	Type	Description
organizationId	ID!	The organization that will own the inventory.
title	String!	The display name.

---

InventoryUpdateInput

Input for updating an existing inventory.

Field	Type	Description
id	ID!	The inventory ID to update.
version	Int!	The current version for optimistic locking.
title	String	The new display name.

---

InventoryDeleteInput

Input for deleting an inventory.

Field	Type	Description
id	ID!	The inventory ID to delete.
version	Int!	The current version for optimistic locking.

---

DeviceInventoryLinkInput

Input for linking a device to an inventory. Both device and inventory must belong to the same organization.

Field	Type	Description
deviceId	ID!	The device ID.
inventoryId	ID!	The inventory ID. Must be in the same organization as the device.

---

DeviceInventoryUnlinkInput

Input for unlinking a device from an inventory.

Field	Type	Description
deviceId	ID!	The device ID to unlink.

---

Enums

DeviceInventoryRelationOrderField

Fields available for ordering device inventory relations.

Value	Description
ASSIGNED_AT	Order by assignment date.

---

InventoryOrderField

Fields available for ordering inventories.

Value	Description
TITLE	Order by title.

---

Interfaces

InventoryItem

An object that can be assigned to an inventory.

Implements: Node

Field	Type	Description
id	ID!	A globally unique identifier.
inventory	Inventory	The inventory this item is currently assigned to.

---

Pagination types

InventoryConnection

A paginated list of Inventory items.

Implements: Connection

Field	Type	Description
edges	[InventoryEdge!]!	A list of edges.
nodes	[Inventory!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

InventoryEdge

An edge in the Inventory connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	Inventory!	The inventory at the end of the edge.

---

DeviceInventoryRelationConnection

A paginated list of DeviceInventoryRelation items.

Implements: Connection

Field	Type	Description
edges	[DeviceInventoryRelationEdge!]!	A list of edges.
nodes	[DeviceInventoryRelation!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

DeviceInventoryRelationEdge

An edge in the DeviceInventoryRelation connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	DeviceInventoryRelation!	The device inventory relation at the end of the edge.

---