Skip to main content

InventoryResponse

Response containing inventory data with operation metadata.

Extends the base inventory entity with additional response information including error messages and operation totals. Used for API responses that need to provide both inventory data and operation feedback.

type InventoryResponse {
id: ID!
productId: Int!
quantity: Int!
costPrice: Float!
supplier: String!
supplierCode: String!
sku: String!
dateModified: DateTime
warehouseId: Int!
location: String!
nextDeliveryDate: DateTime!
notes: String!
messages: [String!]!
total: Int!
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.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! non-null 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.dateModified ● DateTime scalar

Last modification timestamp for the inventory record.

Date and time when this inventory record was last updated, used for change tracking and synchronization.

InventoryResponse.warehouseId ● Int! non-null scalar

Warehouse identifier where the inventory is located.

References the specific warehouse or storage facility associated with this inventory response.

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! non-null 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.messages ● [String!]! non-null scalar

Operation messages and error details.

Collection of messages generated during the inventory operation, including validation errors, warnings, or informational messages.

InventoryResponse.total ● Int! non-null scalar

Total count or summary value for the operation.

InventoryResponse.warehouse ● Warehouse object

Returned By

inventory query ● inventoryCreate mutation ● inventoryUpdate mutation