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

Management Service

• devices: List and filter devices (scanners, printers, terminals)

• deviceLocations: List and filter device-location assignments

• deviceUsers: List and filter device-user assignments

• locations: List and filter warehouse locations

• companies: List and filter companies

• customers: List and filter customers

• dataTypeEntities: Get all available entity types for data types

• dataTypes: Retrieve data type definitions

• nodeDataType: Retrieve management objects by ID

• suppliers: List and filter suppliers

• users: List and filter users

• me: Get information about the current user

Inventory Service

• 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

• nodeInventory: Retrieve inventory objects by ID

• repositories: List and filter repositories

• repositoryMovements: List and filter repository movements

• stocks: Get current or historical stock levels

• transactions: List and filter inventory transactions

Picking Service

• pickingOrderItems: List and filter picking order items

• pickingOrders: List and filter picking orders

• nodePicking: Retrieve picking objects by ID

Receiving Service

• receivingInbounds: List and filter receiving inbounds

• receivingInboundItems: List and filter receiving inbound items

• nodeReceiving: Retrieve receiving objects by ID

Workflow Service

• workflows: List and filter workflows

• workflowAssignee: Retrieve the assignee of a specific workflow run

• workflowSignals: List and filter workflow signals

• nodeWorkflow: Retrieve workflow objects by ID

File Service

• files: List and filter files

• nodeFile: Retrieve files by ID

System

• events: List and filter system events

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