Warehouse API

This section documents the GraphQL API for the Warehouse module. Endpoint: /query/warehouse.

Types

WarehousePosition

Warehouse position (product type/slot).

Fields:

Name	Type	Description
id	`ID!`	Unique identifier
title	`String!`	Position title
barcode	`String!`	Barcode
createdAt	`Time!`	Creation timestamp
updatedAt	`Time!`	Last update timestamp

Product

Individual product with RFID tracking.

Fields:

Name	Type	Description
id	`ID!`	Unique identifier
position	`WarehousePosition!`	Position reference
positionID	`ID!`	Position ID
rfid	`String!`	RFID tag
status	`String!`	Current status
createdAt	`Time!`	Creation timestamp
updatedAt	`Time!`	Last update timestamp

Order

Warehouse order. type and status are strings (e.g. inbound/outbound, draft/completed).

Fields:

Name	Type	Description
id	`ID!`	Unique identifier
type	`String!`	Order type
status	`String!`	Order status
items	`[OrderItem!]!`	Line items
createdAt	`Time!`	Creation timestamp

OrderItem

Line item in an order.

Fields:

Name	Type	Description
position	`WarehousePosition!`	Position
products	`[Product!]!`	Products
quantity	`Int!`	Quantity

InventoryPosition

Inventory summary for a position.

Fields:

Name	Type	Description
id	`ID!`	Unique identifier
title	`String!`	Title
tags	`[String!]!`	Tags

Queries

warehousePosition

Fetch a single position by ID.


warehousePosition(id: ID!): WarehousePosition

warehousePositions

Fetch a paginated list of positions.


warehousePositions(offset: Int!, limit: Int!, sortBy: [String!]): PaginatedWarehousePositions!

product

Fetch a single product by ID.


product(id: ID!): Product

products

Fetch a paginated list of products.


products(offset: Int!, limit: Int!, sortBy: [String!]): PaginatedProducts!

createProductsFromTags

Create products from RFID tags at a position.


createProductsFromTags(input: CreateProductsFromTags!): [Product!]!

validateProducts

Validate product tags.


validateProducts(tags: [String!]!): ValidateProductsResult!

order

Fetch a single order by ID.


order(id: ID!): Order

orders

Fetch orders with query filter.


orders(query: OrderQuery!): PaginatedOrders!

completeOrder

Complete an order (exposed as a query in the schema).


completeOrder(id: ID!): Order

inventory

Fetch inventory positions (no arguments).


inventory: [InventoryPosition!]!

Mutations

completeInventoryCheck

Complete an inventory check with found counts per position.


completeInventoryCheck(items: [InventoryItem!]!): Boolean!

Input: InventoryItem has positionId: ID! and found: Int!.

Scalars

Time

ISO 8601 timestamp.

Int64

64-bit integer for counts.

This documentation reflects the Warehouse GraphQL schema. Last updated: 2026-01-31