Inventory Collections

Inventory Collections Query

Returns a paginated list of InventoryCollection objects, with optional filtering and ordering.

Arguments

Name	Type	Description
after	Cursor	Returns the elements in the list that come after the specified cursor
first	Int	Returns the first n elements from the list
before	Cursor	Returns the elements in the list that come before the specified cursor
last	Int	Returns the last n elements from the list
orderBy	InventoryCollectionOrder	Ordering options for collections returned from the connection
where	InventoryCollectionWhereInput	Filtering options for collections returned from the connection

Return Type

InventoryCollectionConnection! - A connection to a list of InventoryCollection objects with pagination information.

Notes

• The data field contains custom collection attributes as JSON

• Use Data, DataHasKey, DataIn, and DataContains filters for querying JSON data

• See Advanced JSON Field Queries for detailed JSON query examples

Usage Example

query {
  # Get active collection movements
  inventoryCollections(
    where: {
      status_IN: [PENDING, IN_PROGRESS]
    },
    orderBy: { direction: ASC, field: CREATED_AT }
  ) {
    edges {
      node {
        id
        name
        status
        createdAt
        executionOrder
        itemMovements {
          id
          quantity
          executedAt
          item {
            sku
          }
          fromRepository {
            name
          }
          toRepository {
            name
          }
        }
      }
      cursor
    }
    totalCount
  }
}

query {
  # Get completed collections for today
  inventoryCollections(
    where: {
      status: COMPLETED,
      completedAt_GTE: "2024-01-15T00:00:00Z",
      completedAt_LTE: "2024-01-15T23:59:59Z"
    },
    first: 50
  ) {
    edges {
      node {
        id
        name
        completedAt
        completedBy
        data
        itemMovements {
          id
          quantity
        }
        repositoryMovements {
          id
        }
      }
    }
  }
}

Common Filters

• status - Filter by collection status (PENDING, IN_PROGRESS, COMPLETED, CANCELLED)

• createdBy - Filter by creator

• completedAt_NULL: true - Find incomplete collections

• name_CONTAINS - Search by collection name

Notes

• Collections enable complex multi-step operations

• Movements execute in order specified by executionOrder

• Can track progress through partially completed collections

• Useful for wave picking, cross-docking, and complex transfers