Skip to main content

inventory

Retrieve detailed inventory information for a specific inventory record.

Returns comprehensive inventory data including stock levels, location details, product associations, and availability status. Used for inventory management and stock level monitoring.

Possible errors:

  • INVENTORY_NOT_FOUND_ERROR: Inventory record with the specified ID does not exist
  • INVENTORY_GET_ERROR: Failed to retrieve inventory information
  • FORBIDDEN: Insufficient permissions to access inventory data

AUTH: Role=[logistics.OWNER,logistics.EDITOR,logistics.VIEWER]

inventory(
  id: Int!
): InventoryResponse!

Arguments​

inventory.id ● Int! non-null scalar​

Unique identifier of the inventory record to retrieve.

Must be a positive integer representing a valid inventory ID in the system.

Type​

InventoryResponse object​

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.