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

# NodeInventory

nodeInventory Query

Audience: Programmer

Fetches an inventory-related object given its ID. This query follows the Relay Global Object Identification Specification and can retrieve any object that implements the NodeInventory interface.

## Arguments

| Name | Type  | Description                                               |
| ---- | ----- | --------------------------------------------------------- |
| `id` | `ID!` | The unique identifier of the inventory object to retrieve |

## Return Type

`NodeInventory` - An interface that returns an object implementing the NodeInventory interface. This includes:

* `InventoryItem` - Product or item in inventory
* `Repository` - Storage location (warehouse, bin, pallet, etc.)
* `Stock` - Inventory levels
* `ItemMovement` - Movement of items between repositories
* `RepositoryMovement` - Movement of entire repositories
* `Transaction` - Inventory transaction records
* `InventoryCollection` - Collection of inventory items
* `InventoryItemSet` - Set of related inventory items

## Usage Example

### GraphQL Query

```graphql
query GetInventoryObject($id: ID!) {
  nodeInventory(id: $id) {
    id
    ... on InventoryItem {
      sku
      data
      inventoryJSONData
      itemmovementitem {
        edges {
          node {
            id
            quantity
            status
          }
        }
      }
    }
    ... on Repository {
      name
      type
      repositorySystemData
      repositorystocks {
        edges {
          node {
            item {
              sku
            }
            quantity
          }
        }
      }
    }
    ... on Stock {
      quantity
      timestamp
      item {
        sku
      }
      repository {
        name
      }
    }
    ... on ItemMovement {
      quantity
      status
      sourceRepository {
        name
      }
      destinationRepository {
        name
      }
      item {
        sku
      }
    }
  }
}
```

### Query Variables

```json
{
  "id": "SW52ZW50b3J5SXRlbToxMjM="
}
```

### JavaScript Example

```javascript
const getInventoryObject = async (objectId) => {
  const query = `
    query GetInventoryObject($id: ID!) {
      nodeInventory(id: $id) {
        id
        __typename
        ... on InventoryItem {
          sku
          data
          createdAt
          updatedAt
        }
        ... on Repository {
          name
          type
          repositorySystemData
        }
        ... on Stock {
          quantity
          timestamp
        }
      }
    }
  `;

  const response = await fetch('/graphql', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${accessToken}`
    },
    body: JSON.stringify({
      query,
      variables: { id: objectId }
    })
  });

  const { data } = await response.json();
  return data.nodeInventory;
};
```

## Type Detection

Use the `__typename` field to determine which specific type was returned:

```javascript
const object = await getInventoryObject(id);
switch (object.__typename) {
  case 'InventoryItem':
    console.log(`Item SKU: ${object.sku}`);
    break;
  case 'Repository':
    console.log(`Repository: ${object.name}`);
    break;
  case 'Stock':
    console.log(`Stock quantity: ${object.quantity}`);
    break;
  // ... handle other types
}
```

## Related

* [NodeInventory Interface](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodeInventory.md)
* [InventoryItem Type](/graphql-api/types/inventoryitem.md)
* [Repository Type](/graphql-api/types/repository.md)
* [Stock Type](/graphql-api/types/stock.md)
* [inventoryItems Query](/graphql-api/queries/inventoryitems.md)
* [repositories Query](/graphql-api/queries/repositories.md)


---

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