InventoryResponse

Inventory information response with associated warehouse details.

Contains inventory data linked to a specific warehouse location. Used for inventory management, stock tracking, and warehouse-specific inventory operations.

type InventoryResponse {
  id: ID!
  productId: Int!
  quantity: Int!
  allocatedQuantity: Int
  expectedQuantity: Int
  freeQuantity: Int
  economicQuantity: Int
  costPrice: Float!
  supplier: String!
  supplierCode: String
  sku: String!
  dateModified: DateTime @deprecated
  warehouseId: Int!
  companyId: Int
  location: String!
  nextDeliveryDate: DateTime
  notes: String!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  messages: [String!]! @deprecated
  total: Int! @deprecated
  warehouse: Warehouse
}

Fields

InventoryResponse.id ● ID! non-null scalar

Unique identifier for the inventory record.

Primary key used to reference this specific inventory entry throughout the system and for inventory operations.

InventoryResponse.productId ● Int! non-null scalar

Product identifier associated with this inventory.

References the specific product that this inventory record tracks, linking stock levels to product catalog entries.

InventoryResponse.quantity ● Int! non-null scalar

Current stock quantity available.

The number of units currently in stock at this location. Used for availability calculations and stock level monitoring.

InventoryResponse.allocatedQuantity ● Int scalar

Stock already sold but not yet shipped.

A subset of 'quantity': these units are physically present but promised to orders and must not be sold twice. Synced from the source system (e.g. the tenant's ERP), never derived from orders or quotes. Omit the field to leave it unknown; 'null' means the source system has not reported it, '0' means it reported nothing allocated.

InventoryResponse.expectedQuantity ● Int scalar

Stock purchased from a supplier but not yet received.

Disjoint from 'quantity': these units are not on hand yet, so they are not counted in it. Synced from the source system (e.g. the tenant's ERP). Omit the field to leave it unknown; 'null' means the source system has not reported it, '0' means it reported nothing incoming.

InventoryResponse.freeQuantity ● Int scalar

Read-only. Stock that can still be promised today: 'quantity - allocatedQuantity'.

Null when 'allocatedQuantity' is null, because a missing input is never treated as 0. May be negative, which is a genuine oversell signal.

InventoryResponse.economicQuantity ● Int scalar

Read-only. Stock carrying price risk: 'quantity - allocatedQuantity + expectedQuantity'.

Null when either 'allocatedQuantity' or 'expectedQuantity' is null, so a tenant syncing allocations but not purchase orders gets an honest unknown rather than a number that silently equals 'freeQuantity'.

InventoryResponse.costPrice ● Float! non-null scalar

Cost price per unit for this inventory batch.

The cost incurred to acquire each unit in this inventory batch, used for margin calculations and inventory valuation.

InventoryResponse.supplier ● String! non-null scalar

Supplier name for this inventory batch.

The company or organization that supplied the products in this inventory record, used for supplier management and procurement tracking.

InventoryResponse.supplierCode ● String scalar

Supplier's code for cross-referencing.

The supplier's own identifier used for ordering, communication, and inventory reconciliation with supplier systems.

InventoryResponse.sku ● String! non-null scalar

Stock Keeping Unit for inventory tracking.

Unique product code used for inventory management and product identification across all warehouse operations.

InventoryResponse.warehouseId ● Int! non-null scalar

Warehouse identifier where the inventory is located.

References the specific warehouse or storage facility where this inventory is physically stored.

InventoryResponse.companyId ● Int scalar

Company identifier for inventory ownership.

References the company this inventory is reserved for, used for multi-tenant inventory management and reporting.

InventoryResponse.location ● String! non-null scalar

Specific location within the warehouse.

Detailed location information such as aisle, shelf, or bin number for precise inventory placement and picking operations.

InventoryResponse.nextDeliveryDate ● DateTime scalar

Estimated date for next inventory replenishment.

Expected delivery date for the next shipment of this product, used for stock planning and customer communication about availability.

InventoryResponse.notes ● String! non-null scalar

Additional notes and comments about this inventory.

Free-form text for storing special handling instructions, quality notes, or other relevant information about this inventory batch.

InventoryResponse.createdAt ● DateTime! non-null scalar

InventoryResponse.lastModifiedAt ● DateTime! non-null scalar

InventoryResponse.warehouse ● Warehouse object

Complete warehouse information for the inventory location.

Detailed warehouse object including address, operational settings, and facility information where this inventory is stored.

Show deprecated

Returned By

inventory query ● inventoryCreate mutation ● inventoryUpdate mutation