> 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/getstocktree.md).

# getStockTree

Audience: Programmer

**Served by:** [inventory](https://docs.pyck.cloud/graphql-api/services/inventory.md)

## Arguments

| Name     | Type                                                                             | Default | Description |
| -------- | -------------------------------------------------------------------------------- | ------- | ----------- |
| `after`  | [Cursor](https://docs.pyck.cloud/graphql-api/scalars/cursor.md)                  |         |             |
| `first`  | Int                                                                              |         |             |
| `before` | [Cursor](https://docs.pyck.cloud/graphql-api/scalars/cursor.md)                  |         |             |
| `last`   | Int                                                                              |         |             |
| `where`  | [StockWhereInput](https://docs.pyck.cloud/graphql-api/inputs/stockwhereinput.md) |         |             |

## Returns

[RepositoryTreeConnection](https://docs.pyck.cloud/graphql-api/types/repositorytreeconnection.md)!

## Example

Returns the first 3 stock entries as a hierarchical tree, showing stock levels per repository including child repositories.

```graphql
query GetStockTree($after: Cursor, $first: Int, $before: Cursor, $last: Int, $where: StockWhereInput) {
  getStockTree(after: $after, first: $first, before: $before, last: $last, where: $where) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      cursor
      node {
        children {
          cursor
          node {
            children {
              cursor
            }
            createdAt
            parentID
            repositoryID
            stocks {
              createdAt
              createdBy
              deletedAt
              deletedBy
              id
              incomingStock
              itemID
              movementID
              outgoingStock
              ownIncomingStock
              ownOutgoingStock
              ownQuantity
              quantity
              repositoryID
              tenantID
              updatedAt
              updatedBy
              version
            }
          }
        }
        createdAt
        parentID
        repositoryID
        stocks {
          createdAt
          createdBy
          deletedAt
          deletedBy
          id
          incomingStock
          itemID
          movementID
          outgoingStock
          ownIncomingStock
          ownOutgoingStock
          ownQuantity
          quantity
          repositoryID
          tenantID
          updatedAt
          updatedBy
          version
        }
      }
    }
  }
}
```

**Variables**

```json
{
  "first": 3,
  "where": {
    "createdAtGTE": "2023-10-17T00:00:00Z"
  }
}
```


---

# 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/getstocktree.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.
