Mutations

GraphQL Mutations

This section documents all available mutations in the pyck GraphQL API. Mutations allow you to create, update, and delete data in the system.

Available Mutations

• analyzeImageFile: Analyze an image file using AI/ML services

• checkWorkflowStatus: Check the status of a running workflow instance

• createFile: Upload and associate files with entities

• createCustomer: Create a new customer entity

• createDataType: Create a new data type definition

• createInventoryCollectionMovement: Create a collection of related movements

• createInventoryItem: Create a new inventory item

• createInventoryItemMovement: Create a movement to transfer items between repositories

• createInventoryItemSet: Create a new inventory item set for grouping related items

• createRepository: Create a new storage location

• createPickingOrder: Create a new picking order

• createPickingOrderItem: Create a new picking order item and associate it with an existing picking order

• createReceivingInbound: Create a new inbound receiving order

• createReceivingInboundItem: Create a new receiving inbound item and associate it with an existing receiving order

• createSupplier: Create a new supplier entity

• createWorkflow: Create a new workflow definition

• createWorkflowSignal: Create a new workflow signal event handler

• deleteCustomer: Delete an existing customer from the system

• deleteDataType: Delete an existing data type definition from the system

• deleteFile: Delete an existing file from the system

• deleteInventoryItem: Delete an existing inventory item from the system

• deleteItemMovement: Delete an existing item movement from the system

• deleteInventoryItemSet: Delete an existing inventory item set from the system

• deleteRepository: Delete an existing repository from the system

• deleteRepositoryMovement: Delete an existing repository movement from the system

• deletePickingOrder: Delete an existing picking order from the system

• deletePickingOrderItem: Delete an existing picking order item from the system

• deleteReceivingInbound: Delete an existing receiving inbound from the system

• deleteReceivingInboundItem: Delete an existing receiving inbound item from the system

• deleteSupplier: Delete an existing supplier from the system

• deleteWorkflow: Delete an existing workflow definition from the system

• deleteWorkflowSignal: Delete an existing workflow signal from the system

• executeItemMovement: Execute a pending movement

• generateJsonSchema: Generate a JSON Schema definition from provided JSON data

• registerCompany: Register a new company in the pyck system along with an initial admin user

• registerTenant: Register a new tenant (organization) in the pyck system along with an initial admin user

• sendCustomEvent: Send a custom event to the pyck event system

• setAssignee: Set or update the assignee for a running workflow instance

• updateCustomer: Update an existing customer with new data

• updateDataType: Update an existing data type definition with new data

• updateFile: Update an existing file with new data

• updateCollectionMovement: Update an existing inventory collection movement with new data

• updateInventoryItem: Update an existing inventory item with new data

• updateItemMovement: Update an existing item movement with new data

• updateInventoryItemSet: Update an existing inventory item set with new data

• updateRepository: Update an existing repository with new data

• updateRepositoryMovement: Update an existing repository movement with new data

• updatePickingOrder: Update an existing picking order with new data

• updatePickingOrderItem: Update an existing picking order item with new data

• updateReceivingInbound: Update an existing receiving inbound with new data

• updateReceivingInboundItem: Update an existing receiving inbound item with new data

• updateSupplier: Update an existing supplier with new data

• updateWorkflow: Update an existing workflow definition with new data

• updateWorkflowSignal: Update an existing workflow signal with new data

Mutation Structure

Mutations in GraphQL follow a standard structure:

mutation {
  mutationName(input: {
    # Input fields specific to this mutation
    field1: value1
    field2: value2
  }) {
    # Return fields - what you want back after the mutation
    id
    field1
    field2
    createdAt
  }
}

Working with Mutations

Input Types

Most mutations use dedicated input types to specify the data for the operation. For example, the createInventoryItem mutation uses the CreateInventoryItemInput type.

Return Types

Mutations typically return the affected entity, allowing you to retrieve updated values in the same operation.

Error Handling

Mutations may return errors for various reasons:

• Invalid input data

• Insufficient permissions

• Conflicts with existing data

• Business rule violations

Refer to the Error Handling documentation for more information on handling errors.

Example Mutation

Here's an example of creating a new inventory item:

mutation {
  createInventoryItem(input: {
    name: "iPhone 13"
    sku: "IPHONE-13-BLACK"
    data: {
      weight: 173,
      color: "black",
      storage: "128GB"
    }
  }) {
    id
    name
    sku
    createdAt
    updatedAt
  }
}