> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/queries/inventorycollections.md).

# 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](https://github.com/pyck-ai/docs/blob/main/graphql/advanced/json-field-queries.md) for detailed JSON query examples

## Usage Example

```graphql
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
  }
}
```

```graphql
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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/graphql-api/queries/inventorycollections.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.