Schema Overview

Overview of the GraphQL Schema

Introduction

The pyck GraphQL API provides a comprehensive interface for interacting with your warehouse management system. This document gives you a high-level overview of the schema structure.

Core Components

The schema is organized into several main sections:

Queries

Queries allow you to fetch data from the system. Some key queries include:

• me: Get information about the current user

• inventoryItems: List inventory items with filtering and pagination

• repositories: List repositories (warehouses, zones, etc.)

• stocks: Get current or historical stock levels

• pickingOrders: List picking orders

• receivingInbounds: List inbound receiving orders

Mutations

Mutations allow you to create, update, or delete data. Key mutations include:

• createInventoryItem: Create a new inventory item

• createInventoryItemMovement: Create a movement to transfer items

• createInventoryRepository: Create a new repository

• createPickingOrder: Create a new picking order

• createReceivingInbound: Create a new inbound receiving order

• executeInventoryItemMovement: Execute a pending movement

Types

The schema defines numerous types that represent entities and concepts in the system:

• InventoryItem: Represents products and items in your inventory

• Repository: Represents storage locations (warehouses, zones, bins, etc.)

• Stock: Represents the quantity of an item in a specific repository

• ItemMovement: Represents the transfer of items between repositories

• PickingOrder: Represents an order to pick items from stock

• ReceivingInbound: Represents an inbound shipment to be received

Schema Relationships

The schema includes many relationships between entities:

1. Items and Repositories:

   • Items are stored in repositories

   • Each repository can contain multiple items

   • Repositories can be nested (e.g., a bin within a zone)

2. Movements and Stock:

   • Item movements change stock levels

   • Stock records track item quantities at specific points in time

   • Movements can be grouped into collections

3. Orders and Operations:

   • Picking orders generate item movements to fulfill orders

   • Receiving inbounds create movements to add stock to the warehouse

Exploring the Schema

For detailed information about specific parts of the schema, consult the dedicated documentation sections:

• Queries

• Mutations

• Types

• Scalars

• Inputs

• Interfaces