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

# Stocks

Stocks Query

Returns a paginated list of Stock 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` | `StockOrder`      | Ordering options for Stocks returned from the connection               |
| `where`   | `StockWhereInput` | Filtering options for Stocks returned from the connection              |

## Return Type

`StockConnection!` - A connection to a list of Stock objects with pagination information.

## Stock Fields

| Field              | Type            | Description                                  |
| ------------------ | --------------- | -------------------------------------------- |
| `id`               | `ID!`           | Unique identifier                            |
| `itemID`           | `UUID!`         | ID of the inventory item                     |
| `repositoryID`     | `UUID!`         | ID of the repository                         |
| `quantity`         | `Int!`          | Total quantity including child repositories  |
| `ownQuantity`      | `Int!`          | Quantity in this repository only             |
| `incomingStock`    | `Int!`          | Pending incoming movements                   |
| `ownIncomingStock` | `Int!`          | Incoming movements to this repository only   |
| `outgoingStock`    | `Int!`          | Pending outgoing movements                   |
| `ownOutgoingStock` | `Int!`          | Outgoing movements from this repository only |
| `item`             | `InventoryItem` | The inventory item details                   |
| `repository`       | `Repository`    | The repository details                       |

## Usage Example

```graphql
query {
  # Get all stock levels for a specific item across repositories
  stocks(
    where: {
      itemID: "item-123"
    }
  ) {
    edges {
      node {
        id
        itemID
        repositoryID
        quantity
        ownQuantity
        incomingStock
        outgoingStock
        item {
          sku
          data
        }
        repository {
          name
          type
        }
      }
      cursor
    }
    totalCount
  }
}
```

```graphql
query {
  # Get all stock in a specific repository with quantities
  stocks(
    where: {
      repositoryID: "warehouse-main",
      quantity_LTE: 10,
      quantity_GT: 0
    },
    orderBy: { direction: ASC, field: QUANTITY }
  ) {
    edges {
      node {
        id
        itemID
        quantity
        ownQuantity
        incomingStock
        outgoingStock
        item {
          sku
          data
        }
      }
    }
    totalCount
  }
}
```

## Notes

* **Available Stock** can be calculated as: `quantity - outgoingStock`
* **Projected Stock** can be calculated as: `quantity + incomingStock - outgoingStock`
* The `quantity` field includes stock in all child repositories
* Use `ownQuantity` when you need stock at a specific location only
* Virtual repositories may have stock records but don't enforce validation


---

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