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

# Stock

Stock Type

Represents inventory stock levels for items in repositories. Stock records track quantities and pending movements, providing both current and projected inventory levels.

## Fields

| Field              | Type            | Description                                           |
| ------------------ | --------------- | ----------------------------------------------------- |
| `id`               | `ID!`           | Unique identifier of the stock record                 |
| `tenantID`         | `UUID!`         | Tenant identifier                                     |
| `createdAt`        | `Time!`         | Creation timestamp                                    |
| `createdBy`        | `UUID!`         | User identifier who created the stock record          |
| `updatedAt`        | `Time`          | Last update timestamp                                 |
| `updatedBy`        | `UUID`          | User identifier who last updated the stock record     |
| `deletedAt`        | `Time`          | Deletion timestamp                                    |
| `deletedBy`        | `UUID`          | User identifier who deleted the stock record          |
| `itemID`           | `UUID!`         | ID of the inventory item                              |
| `repositoryID`     | `UUID!`         | ID of the repository where stock is located           |
| `quantity`         | `Int!`          | Total quantity including child repositories           |
| `ownQuantity`      | `Int!`          | Quantity in this repository only (excluding children) |
| `incomingStock`    | `Int!`          | Pending incoming movements (including children)       |
| `ownIncomingStock` | `Int!`          | Pending incoming movements to this repository only    |
| `outgoingStock`    | `Int!`          | Pending outgoing movements (including children)       |
| `ownOutgoingStock` | `Int!`          | Pending outgoing movements from this repository only  |
| `item`             | `InventoryItem` | The inventory item this stock belongs to              |
| `repository`       | `Repository`    | The repository this stock is in                       |

## Stock Calculation

* **Available Stock** = `quantity` - `outgoingStock`
* **Projected Stock** = `quantity` + `incomingStock` - `outgoingStock`

The distinction between "own" and total quantities is important for hierarchical repositories:

* `quantity` includes stock in all child repositories
* `ownQuantity` is only the stock directly in this repository

## Usage Example

```graphql
query {
  stocks(
    where: {
      itemID: "550e8400-e29b-41d4-a716-446655440000"
      quantity_GT: 0
    }
  ) {
    edges {
      node {
        id
        quantity
        ownQuantity
        incomingStock
        outgoingStock
        repository {
          name
          type
        }
        item {
          sku
          data
        }
      }
    }
  }
}
```

## Notes

* Stock records are automatically maintained by the system through movements
* Virtual repositories may have stock records but don't enforce validation
* Use `ownQuantity` when you need stock at a specific location only
* Use `quantity` when you need total available stock including child locations


---

# 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/types/stock.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.