Queries

GraphQL Queries

This section documents all available queries in the pyck GraphQL API. Queries allow you to fetch data from the system without making any changes.

Available Queries

• files: List and filter files

• companies: List and filter companies

• customers: List and filter customers

• dataTypeEntities: Get all available entity types for data types

• dataTypes: Retrieve data type definitions

• events: List and filter system events

• files: List and filter files

• inventoryCollections: List and filter inventory collections

• inventoryItems: List and filter inventory items

• inventoryItemSets: List and filter inventory item sets

• itemMovements: List and filter item movements

• me: Get information about the current user

• nodeFile: Retrieve files by ID

• nodeDataType: Retrieve management objects by ID

• nodeInventory: Retrieve inventory objects by ID

• nodePicking: Retrieve picking objects by ID

• nodeReceiving: Retrieve receiving objects by ID

• nodeWorkflow: Retrieve workflow objects by ID

• pickingOrderItems: List and filter picking order items

• pickingOrders: List and filter picking orders

• receivingInbounds: List and filter receiving inbounds

• receivingInboundItems: List and filter receiving inbound items

• repositories: List and filter repositories

• repositoryMovements: List and filter repository movements

• stocks: Get current or historical stock levels

• suppliers: List and filter suppliers

• transactions: List and filter inventory transactions

• users: List and filter users

• workflows: List and filter workflows

• workflowAssignee: Retrieve the assignee of a specific workflow run

• workflowSignals: List and filter workflow signals

Pagination and Filtering

Most list queries support pagination using the Relay connection specification. This allows you to efficiently navigate large result sets.

Example of paginated query:

query {
  inventoryItems(
    first: 10
    after: "cursor-value"
    where: { 
      name: { contains: "product" }
    }
    orderBy: { createdAt: DESC }
  ) {
    edges {
      node {
        id
        name
        sku
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}

Common Query Parameters

Many queries support similar parameters:

• where: Filter criteria specific to the queried entity

• orderBy: Sorting criteria for the results

• Pagination parameters: first, after, last, before