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

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

{
  "id": "SW52ZW50b3J5SXRlbToxMjM="
}

JavaScript Example

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:

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

• InventoryItem Type

• Repository Type

• Stock Type

• inventoryItems Query

• repositories Query