# pyck.ai docs

## pyck.ai docs

- [Welcome](https://docs.pyck.cloud/readme.md)
- [Concepts](https://docs.pyck.cloud/basics/concepts.md): Basic Concepts
- [Mapping of pyck Terms](https://docs.pyck.cloud/basics/mapping-of-pyck-terms.md): Common warehouse management terms and their pyck equivalents
- [Workflows](https://docs.pyck.cloud/basics/workflows.md)
- [Movements](https://docs.pyck.cloud/basics/movements.md): Movement Concepts
- [Authentication](https://docs.pyck.cloud/development/authentication.md)
- [Headers](https://docs.pyck.cloud/development/headers.md)
- [Service Roles](https://docs.pyck.cloud/development/service-roles.md): Per-service capability roles that gate access to individual pyck services
- [Networking Requirements](https://docs.pyck.cloud/development/networking.md): Network requirements and firewall rules for pyck.cloud SaaS service
- [Workflows](https://docs.pyck.cloud/development/workflows.md)
- [Locations](https://docs.pyck.cloud/development/locations.md): Locations, Devices, and User Management
- [Architecture](https://docs.pyck.cloud/development/architecture.md): System Architecture
- [Migrations](https://docs.pyck.cloud/development/migrations.md): Migration guides for breaking changes in the pyck API
- [Relay Connections](https://docs.pyck.cloud/development/migrations/relay-connections.md): Migration guide for the breaking change from simple list fields to Relay-style Connection objects
- [InventoryItem Data Field](https://docs.pyck.cloud/development/migrations/inventory-item-data-field.md): Migration guide for the breaking change from inventoryJSONData to the unified data field
- [Overview](https://docs.pyck.cloud/shopify-app/shopify.md): How the Shopify app connects your store to pyck
- [Setup](https://docs.pyck.cloud/shopify-app/setup.md): Installing the Shopify app and connecting your first pyck tenant
- [What a sync overwrites in pyck](https://docs.pyck.cloud/shopify-app/data-mapping.md): Which fields a sync overwrites in pyck, which it leaves alone, and how files are handled
- [Designing pyck schemas for Shopify](https://docs.pyck.cloud/shopify-app/schema-design.md): How to design pyck schemas so the Shopify app can write into them, and how to name the fields you add
- [Sending data to several pyck tenants](https://docs.pyck.cloud/shopify-app/routing.md): Directing products, customers and orders at particular pyck tenants
- [Running a test tenant before go-live](https://docs.pyck.cloud/shopify-app/test-tenant.md): Trying pyck on your real orders without shipping anything, then switching to your live warehouse
- [Warehouse stock](https://docs.pyck.cloud/shopify-app/stock.md): Letting pyck drive the stock counts your Shopify locations show
- [When something looks wrong](https://docs.pyck.cloud/shopify-app/troubleshooting.md): Common symptoms in the Shopify app and what they mean
- [Glossary](https://docs.pyck.cloud/logistics-general/logistics-glossary.md): Essential warehouse and logistics terminology for developers
- [FAQ for Logistics Managers](https://docs.pyck.cloud/faq/faq-logistics.md): Frequently asked questions about Pyck for logistics managers
- [FAQ for Developers](https://docs.pyck.cloud/faq/faq-development.md): Frequently asked questions about Pyck for developers
- [FAQ for System Administrators](https://docs.pyck.cloud/faq/faq-operations.md): Frequently asked questions about Pyck for system administrators
- [Introduction](https://docs.pyck.cloud/graphql-api/graphql.md): GraphQL API Reference
- [Getting Started](https://docs.pyck.cloud/graphql-api/getting-started.md): Getting Started with the GraphQL API
- [Schema Overview](https://docs.pyck.cloud/graphql-api/schema-overview.md): Overview of the GraphQL Schema
- [Authentication](https://docs.pyck.cloud/graphql-api/authentication.md): GraphQL API Authentication
- [Error Handling](https://docs.pyck.cloud/graphql-api/error-handling.md): GraphQL Error Handling
- [Queries](https://docs.pyck.cloud/graphql-api/queries.md): GraphQL Queries
- [Node Queries](https://docs.pyck.cloud/graphql-api/queries/node-queries.md)
- [NodeAttachments](https://docs.pyck.cloud/graphql-api/queries/nodeattachments.md): nodeAttachments Query
- [NodeInventory](https://docs.pyck.cloud/graphql-api/queries/nodeinventory.md): nodeInventory Query
- [NodeDataType](https://docs.pyck.cloud/graphql-api/queries/nodedatatype.md): nodeDataType Query
- [NodePicking](https://docs.pyck.cloud/graphql-api/queries/nodepicking.md): nodePicking Query
- [NodeReceiving](https://docs.pyck.cloud/graphql-api/queries/nodereceiving.md): nodeReceiving Query
- [NodeWorkflowService](https://docs.pyck.cloud/graphql-api/queries/nodeworkflowservice.md): nodeWorkflowService Query
- [Attachments](https://docs.pyck.cloud/graphql-api/queries/attachments.md): attachments Query
- [Companies](https://docs.pyck.cloud/graphql-api/queries/companies.md): Companies Query
- [Customers](https://docs.pyck.cloud/graphql-api/queries/customers.md): Customers Query
- [Data Types](https://docs.pyck.cloud/graphql-api/queries/datatypes.md): dataTypes Query
- [DataTypeEntities](https://docs.pyck.cloud/graphql-api/queries/datatypeentities.md): Data Type Entities Query
- [Events](https://docs.pyck.cloud/graphql-api/queries/events.md): Events Query
- [Files](https://docs.pyck.cloud/graphql-api/queries/files.md): files Query
- [Inventory Collections](https://docs.pyck.cloud/graphql-api/queries/inventorycollections.md): Inventory Collections Query
- [Inventory Items](https://docs.pyck.cloud/graphql-api/queries/inventoryitems.md): Inventory Items Query
- [Inventory Item Sets](https://docs.pyck.cloud/graphql-api/queries/inventoryitemsets.md): Inventory Item Sets Query
- [Item Movements](https://docs.pyck.cloud/graphql-api/queries/itemmovements.md): Item Movements Query
- [Me](https://docs.pyck.cloud/graphql-api/queries/me.md): Current User Query
- [Picking Order Items](https://docs.pyck.cloud/graphql-api/queries/pickingorderitems.md): pickingOrderItems Query
- [Picking Orders](https://docs.pyck.cloud/graphql-api/queries/pickingorders.md): pickingOrders Query
- [Picking Outbound Shipment Notifications](https://docs.pyck.cloud/graphql-api/queries/pickingoutboundshipmentnotifications.md): pickingOutboundShipmentNotifications Query
- [Receiving Inbounds](https://docs.pyck.cloud/graphql-api/queries/receivinginbounds.md): receivingInbounds Query
- [Receiving Inbound Items](https://docs.pyck.cloud/graphql-api/queries/receivinginbounditems.md): receivingInboundItems Query
- [Receiving Inbound Shipment Notifications](https://docs.pyck.cloud/graphql-api/queries/receivinginboundshipmentnotifications.md): receivingInboundShipmentNotifications Query
- [Repositories](https://docs.pyck.cloud/graphql-api/queries/repositories.md): Repositories Query
- [Repository Movements](https://docs.pyck.cloud/graphql-api/queries/repositorymovements.md): repositoryMovements Query
- [Stocks](https://docs.pyck.cloud/graphql-api/queries/stocks.md): Stocks Query
- [Suppliers](https://docs.pyck.cloud/graphql-api/queries/suppliers.md): suppliers Query
- [Transactions](https://docs.pyck.cloud/graphql-api/queries/transactions.md): Transactions Query
- [Users](https://docs.pyck.cloud/graphql-api/queries/users.md): Users Query
- [AssignableWorkflowExecutions](https://docs.pyck.cloud/graphql-api/queries/assignableworkflowexecutions.md): Query workflow executions that have pending user tasks
- [Workflows](https://docs.pyck.cloud/graphql-api/queries/workflows.md): Workflows Query
- [WorkflowAssignee](https://docs.pyck.cloud/graphql-api/queries/workflowassignee.md): Retrieve the assignee of a specific workflow run
- [WorkflowExecutions](https://docs.pyck.cloud/graphql-api/queries/workflowexecutions.md): Query workflow executions with pagination and filtering
- [WorkflowHistory](https://docs.pyck.cloud/graphql-api/queries/workflowhistory.md): Query workflow history events for specific executions
- [WorkflowActions](https://docs.pyck.cloud/graphql-api/queries/workflowactions.md): Retrieve the queries and updates currently available for a workflow execution
- [WorkflowSignals](https://docs.pyck.cloud/graphql-api/queries/workflowsignals.md): Workflow Signals Query
- [WorkflowTargets](https://docs.pyck.cloud/graphql-api/queries/workflowtargets.md): Read the current target surfaces of a workflow execution
- [Service Status](https://docs.pyck.cloud/graphql-api/queries/service-status.md): Service health and status monitoring queries
- [Inventory Status](https://docs.pyck.cloud/graphql-api/queries/service-status/inventory.md): Get inventory service status and version information
- [Main Data Status](https://docs.pyck.cloud/graphql-api/queries/service-status/main_data.md): Get main data service status and version information
- [Management Status](https://docs.pyck.cloud/graphql-api/queries/service-status/management.md): Get management service status and version information
- [Picking Status](https://docs.pyck.cloud/graphql-api/queries/service-status/picking.md): Get picking service status and version information
- [Receiving Status](https://docs.pyck.cloud/graphql-api/queries/service-status/receiving.md): Get receiving service status and version information
- [File Status](https://docs.pyck.cloud/graphql-api/queries/service-status/file.md): Get file service status and version information
- [Workflow Status](https://docs.pyck.cloud/graphql-api/queries/service-status/workflow.md): Get workflow service status and version information
- [Mutations](https://docs.pyck.cloud/graphql-api/mutations.md): GraphQL Mutations
- [Analyze Image Attachment](https://docs.pyck.cloud/graphql-api/mutations/analyze-image-attachment.md)
- [Cancel Workflow](https://docs.pyck.cloud/graphql-api/mutations/cancelworkflow.md): cancelWorkflow Mutation
- [Check Workflow Status](https://docs.pyck.cloud/graphql-api/mutations/checkworkflowstatus.md): checkWorkflowStatus Mutation
- [Create Customer](https://docs.pyck.cloud/graphql-api/mutations/createcustomer.md): Create Customer Mutation
- [Create Data Type](https://docs.pyck.cloud/graphql-api/mutations/createdatatype.md): createDataType Mutation
- [Create File](https://docs.pyck.cloud/graphql-api/mutations/createfile.md): createFile Mutation
- [Create Inventory Collection Movement](https://docs.pyck.cloud/graphql-api/mutations/createinventorycollectionmovement.md): createInventoryCollectionMovement Mutation
- [Create Inventory Item](https://docs.pyck.cloud/graphql-api/mutations/createinventoryitem.md): Create Inventory Item Mutation
- [Create Inventory Item Movement](https://docs.pyck.cloud/graphql-api/mutations/createinventoryitemmovement.md): Create Inventory Item Movement Mutation
- [Create Inventory Item Set](https://docs.pyck.cloud/graphql-api/mutations/createinventoryitemset.md): Create Inventory Item Set Mutation
- [Create Inventory Repository](https://docs.pyck.cloud/graphql-api/mutations/createinventoryrepository.md): createInventoryRepository Mutation
- [Create Inventory Repository Movement](https://docs.pyck.cloud/graphql-api/mutations/createinventoryrepositorymovement.md): Create Inventory Repository Movement Mutation
- [Create Picking Order](https://docs.pyck.cloud/graphql-api/mutations/createpickingorder.md): createPickingOrder Mutation
- [Create Picking Order Item](https://docs.pyck.cloud/graphql-api/mutations/createpickingorderitem.md): createPickingOrderItem Mutation
- [Create Picking Outbound Shipment Notification](https://docs.pyck.cloud/graphql-api/mutations/createpickingoutboundshipmentnotification.md): createPickingOutboundShipmentNotification Mutation
- [Create Receiving Inbound](https://docs.pyck.cloud/graphql-api/mutations/createreceivinginbound.md): createReceivingInbound Mutation
- [Create Receiving Inbound Item](https://docs.pyck.cloud/graphql-api/mutations/createreceivinginbounditem.md): createReceivingInboundItem Mutation
- [Create Receiving Inbound Shipment Notification](https://docs.pyck.cloud/graphql-api/mutations/createreceivinginboundshipmentnotification.md): createReceivingInboundShipmentNotification Mutation
- [Create Supplier](https://docs.pyck.cloud/graphql-api/mutations/createsupplier.md): Create Supplier Mutation
- [Create Workflow](https://docs.pyck.cloud/graphql-api/mutations/createworkflow.md): createWorkflow Mutation
- [Create Workflow Signal](https://docs.pyck.cloud/graphql-api/mutations/createworkflowsignal.md): createWorkflowSignal Mutation
- [Delete Attachment](https://docs.pyck.cloud/graphql-api/mutations/delete-attachment.md)
- [Delete Customer](https://docs.pyck.cloud/graphql-api/mutations/deletecustomer.md): Delete Customer Mutation
- [Delete Data Type](https://docs.pyck.cloud/graphql-api/mutations/deletedatatype.md): Delete DataType Mutation
- [Delete Inventory Collection Movement](https://docs.pyck.cloud/graphql-api/mutations/delete-inventory-collection-movement.md)
- [Delete Inventory Item](https://docs.pyck.cloud/graphql-api/mutations/deleteinventoryitem.md): Delete Inventory Item Mutation
- [Delete Inventory Item Movement](https://docs.pyck.cloud/graphql-api/mutations/deleteinventoryitemmovement.md): Delete Inventory Item Movement Mutation
- [Delete Inventory Item Set](https://docs.pyck.cloud/graphql-api/mutations/deleteinventoryitemset.md): Delete Inventory Item Set Mutation
- [Delete Inventory Repository](https://docs.pyck.cloud/graphql-api/mutations/deleteinventoryrepository.md): Delete Inventory Repository Mutation
- [Delete Inventory Repository Movement](https://docs.pyck.cloud/graphql-api/mutations/deleteinventoryrepositorymovement.md): Delete Inventory Repository Movement Mutation
- [Delete Picking Order](https://docs.pyck.cloud/graphql-api/mutations/deletepickingorder.md): deletePickingOrder Mutation
- [Delete Picking Order Item](https://docs.pyck.cloud/graphql-api/mutations/deletepickingorderitem.md): deletePickingOrderItem Mutation
- [Delete Picking Outbound Shipment Notification](https://docs.pyck.cloud/graphql-api/mutations/deletepickingoutboundshipmentnotification.md): deletePickingOutboundShipmentNotification Mutation
- [Delete Receiving Inbound](https://docs.pyck.cloud/graphql-api/mutations/deletereceivinginbound.md): deleteReceivingInbound Mutation
- [Delete Receiving Inbound Item](https://docs.pyck.cloud/graphql-api/mutations/deletereceivinginbounditem.md): deleteReceivingInboundItem Mutation
- [Delete Receiving Inbound Shipment Notification](https://docs.pyck.cloud/graphql-api/mutations/deletereceivinginboundshipmentnotification.md): deleteReceivingInboundShipmentNotification Mutation
- [Delete Supplier](https://docs.pyck.cloud/graphql-api/mutations/deletesupplier.md): Delete Supplier Mutation
- [Delete Workflow](https://docs.pyck.cloud/graphql-api/mutations/deleteworkflow.md): deleteWorkflow Mutation
- [Delete Workflow Signal](https://docs.pyck.cloud/graphql-api/mutations/deleteworkflowsignal.md): deleteWorkflowSignal Mutation
- [Execute Inventory Item Movement](https://docs.pyck.cloud/graphql-api/mutations/executeinventoryitemmovement.md): Execute Inventory Item Movement Mutation
- [Execute Inventory Repository Movement](https://docs.pyck.cloud/graphql-api/mutations/executeinventoryrepositorymovement.md): Execute Inventory Repository Movement Mutation
- [Finalize File Upload](https://docs.pyck.cloud/graphql-api/mutations/finalize-file-upload.md): finalizeFileUpload Mutation
- [Generate JSON Schema](https://docs.pyck.cloud/graphql-api/mutations/generatejsonschema.md): generateJsonSchema Mutation
- [Rebuild Inventory Stock](https://docs.pyck.cloud/graphql-api/mutations/rebuildinventorystock.md): Rebuild Inventory Stock Mutation
- [Register Company](https://docs.pyck.cloud/graphql-api/mutations/registercompany.md): registerCompany Mutation
- [Register Tenant](https://docs.pyck.cloud/graphql-api/mutations/registertenant.md): registerTenant Mutation
- [Send Custom Event](https://docs.pyck.cloud/graphql-api/mutations/sendcustomevent.md): Send Custom Event Mutation
- [Set Assignee](https://docs.pyck.cloud/graphql-api/mutations/setassignee.md): setAssignee Mutation
- [Set Workflow Targets](https://docs.pyck.cloud/graphql-api/mutations/setworkflowtargets.md): Replace the target surfaces of a running workflow execution
- [Update Attachment](https://docs.pyck.cloud/graphql-api/mutations/update-attachment.md)
- [Update Customer](https://docs.pyck.cloud/graphql-api/mutations/updatecustomer.md): Update Customer Mutation
- [Update Data Type](https://docs.pyck.cloud/graphql-api/mutations/updatedatatype.md): Update DataType Mutation
- [Update Inventory Collection Movement](https://docs.pyck.cloud/graphql-api/mutations/updateinventorycollectionmovement.md): Update Inventory Collection Movement Mutation
- [Update Inventory Item](https://docs.pyck.cloud/graphql-api/mutations/updateinventoryitem.md): Update Inventory Item Mutation
- [Update Inventory Item Movement](https://docs.pyck.cloud/graphql-api/mutations/updateinventoryitemmovement.md): Update Inventory Item Movement Mutation
- [Update Inventory Item Set](https://docs.pyck.cloud/graphql-api/mutations/updateinventoryitemset.md): Update Inventory Item Set Mutation
- [Update Inventory Repository](https://docs.pyck.cloud/graphql-api/mutations/updateinventoryrepository.md): Update Inventory Repository Mutation
- [Update Inventory Repository Movement](https://docs.pyck.cloud/graphql-api/mutations/updateinventoryrepositorymovement.md): Update Inventory Repository Movement Mutation
- [Update Picking Order](https://docs.pyck.cloud/graphql-api/mutations/updatepickingorder.md): updatePickingOrder Mutation
- [Update Picking Order Item](https://docs.pyck.cloud/graphql-api/mutations/updatepickingorderitem.md): updatePickingOrderItem Mutation
- [Update Picking Outbound Shipment Notification](https://docs.pyck.cloud/graphql-api/mutations/updatepickingoutboundshipmentnotification.md): updatePickingOutboundShipmentNotification Mutation
- [Update Receiving Inbound](https://docs.pyck.cloud/graphql-api/mutations/updatereceivinginbound.md): updateReceivingInbound Mutation
- [Update Receiving Inbound Item](https://docs.pyck.cloud/graphql-api/mutations/updatereceivinginbounditem.md): updateReceivingInboundItem Mutation
- [Update Receiving Inbound Shipment Notification](https://docs.pyck.cloud/graphql-api/mutations/updatereceivinginboundshipmentnotification.md): updateReceivingInboundShipmentNotification Mutation
- [Update Supplier](https://docs.pyck.cloud/graphql-api/mutations/updatesupplier.md): Update Supplier Mutation
- [Update Workflow](https://docs.pyck.cloud/graphql-api/mutations/updateworkflow.md): updateWorkflow Mutation
- [Update Workflow Signal](https://docs.pyck.cloud/graphql-api/mutations/updateworkflowsignal.md): updateWorkflowSignal Mutation
- [Types](https://docs.pyck.cloud/graphql-api/types.md): GraphQL Type Definitions
- [AccessPolicy](https://docs.pyck.cloud/graphql-api/types/accesspolicy.md): AccessPolicy Type
- [ActionDefinition](https://docs.pyck.cloud/graphql-api/types/actiondefinition.md): Describes a single workflow query or update and whether it is currently callable
- [CollectionMovement](https://docs.pyck.cloud/graphql-api/types/collectionmovement.md): CollectionMovement Type
- [Company](https://docs.pyck.cloud/graphql-api/types/company.md): Company Type
- [Customer](https://docs.pyck.cloud/graphql-api/types/customer.md): Customer Type
- [DataType](https://docs.pyck.cloud/graphql-api/types/datatype.md): DataType Type
- [Event](https://docs.pyck.cloud/graphql-api/types/event.md): Event Type
- [File](https://docs.pyck.cloud/graphql-api/types/file.md): File Type
- [GetAssigneeResponse](https://docs.pyck.cloud/graphql-api/types/getassigneeresponse.md): Response containing workflow assignee information
- [GetWorkflowActionsResponse](https://docs.pyck.cloud/graphql-api/types/getworkflowactionsresponse.md): Response containing the queries and updates available on a workflow execution
- [GetWorkflowTargetsResponse](https://docs.pyck.cloud/graphql-api/types/getworkflowtargetsresponse.md): Response containing the target surfaces of a workflow execution
- [Group](https://docs.pyck.cloud/graphql-api/types/group.md): Group Type
- [InventoryCollection](https://docs.pyck.cloud/graphql-api/types/inventorycollection.md): Inventory Collection Type
- [InventoryItem](https://docs.pyck.cloud/graphql-api/types/inventoryitem.md): Inventory Item Type
- [InventoryItemSet](https://docs.pyck.cloud/graphql-api/types/inventoryitemset.md): InventoryItemSet Type
- [ItemMovement](https://docs.pyck.cloud/graphql-api/types/itemmovement.md): Item Movement Type
- [KeyValue](https://docs.pyck.cloud/graphql-api/types/keyvalue.md): KeyValue Type
- [PageInfo](https://docs.pyck.cloud/graphql-api/types/pageinfo.md): PageInfo Type
- [PickingOrder](https://docs.pyck.cloud/graphql-api/types/pickingorder.md): PickingOrder Type
- [PickingOrderItem](https://docs.pyck.cloud/graphql-api/types/pickingorderitem.md): PickingOrderItem Type
- [PickingOutboundShipmentNotification](https://docs.pyck.cloud/graphql-api/types/pickingoutboundshipmentnotification.md): PickingOutboundShipmentNotification Type
- [ReceivingInbound](https://docs.pyck.cloud/graphql-api/types/receivinginbound.md): ReceivingInbound Type
- [ReceivingInboundItem](https://docs.pyck.cloud/graphql-api/types/receivinginbounditem.md): ReceivingInboundItem Type
- [ReceivingInboundShipmentNotification](https://docs.pyck.cloud/graphql-api/types/receivinginboundshipmentnotification.md): ReceivingInboundShipmentNotification Type
- [RebuildStockOutput](https://docs.pyck.cloud/graphql-api/types/rebuildstockoutput.md): RebuildStockOutput Type
- [Repository](https://docs.pyck.cloud/graphql-api/types/repository.md): Repository Type
- [RepositoryMovement](https://docs.pyck.cloud/graphql-api/types/repositorymovement.md): RepositoryMovement Type
- [Role](https://docs.pyck.cloud/graphql-api/types/role.md): Role Type
- [ServiceInfo](https://docs.pyck.cloud/graphql-api/types/serviceinfo.md): Service status information type containing version and timestamp
- [SetAssigneeResponse](https://docs.pyck.cloud/graphql-api/types/setassigneeresponse.md): SetAssigneeResponse Type
- [SetWorkflowTargetsResponse](https://docs.pyck.cloud/graphql-api/types/setworkflowtargetsresponse.md): Response containing the updated target surfaces of a workflow execution
- [Stock](https://docs.pyck.cloud/graphql-api/types/stock.md): Stock Type
- [Supplier](https://docs.pyck.cloud/graphql-api/types/supplier.md): Supplier Type
- [Tenant](https://docs.pyck.cloud/graphql-api/types/tenant.md): Tenant Type
- [TemporalMetadata](https://docs.pyck.cloud/graphql-api/types/temporalmetadata.md): TemporalMetadata Type
- [TemporalWorkflow](https://docs.pyck.cloud/graphql-api/types/temporalworkflow.md): TemporalWorkflow Type
- [Transaction](https://docs.pyck.cloud/graphql-api/types/transaction.md): Transaction Type
- [User](https://docs.pyck.cloud/graphql-api/types/user.md): User Type
- [UserProfile](https://docs.pyck.cloud/graphql-api/types/userprofile.md): UserProfile Type
- [UserRoleTuple](https://docs.pyck.cloud/graphql-api/types/userroletuple.md): UserRoleTuple Type
- [UserTenants](https://docs.pyck.cloud/graphql-api/types/usertenants.md): UserTenants Type
- [Workflow](https://docs.pyck.cloud/graphql-api/types/workflow.md): Workflow Type
- [WorkflowEvent](https://docs.pyck.cloud/graphql-api/types/workflowevent.md): WorkflowEvent Type - Individual event in workflow execution history
- [WorkflowExecutionHistory](https://docs.pyck.cloud/graphql-api/types/workflowexecutionhistory.md): WorkflowExecutionHistory Type - Workflow execution with history events
- [WorkflowExecutionHistoryConnection](https://docs.pyck.cloud/graphql-api/types/workflowexecutionhistoryconnection.md): WorkflowExecutionHistoryConnection Type - Paginated workflow history results
- [WorkflowExecutionInfo](https://docs.pyck.cloud/graphql-api/types/workflowexecutioninfo.md): WorkflowExecutionInfo Type - Temporal workflow execution details
- [WorkflowExecutionInfoConnection](https://docs.pyck.cloud/graphql-api/types/workflowexecutioninfoconnection.md): WorkflowExecutionInfoConnection Type - Paginated workflow execution results
- [WorkflowSignal](https://docs.pyck.cloud/graphql-api/types/workflowsignal.md): WorkflowSignal Type
- [Enums](https://docs.pyck.cloud/graphql-api/enums.md): GraphQL Enums Documentation
- [FileReftype](https://docs.pyck.cloud/graphql-api/enums/filereftype.md): FileReftype Type
- [ItemMovementBlockedBy](https://docs.pyck.cloud/graphql-api/enums/itemmovementblockedby.md): ItemMovementBlockedBy Type
- [JSONType](https://docs.pyck.cloud/graphql-api/enums/jsontype.md): JSONType enum for JSONB column ordering
- [OrderDirection](https://docs.pyck.cloud/graphql-api/enums/orderdirection.md): OrderDirection Type
- [RepositoryMovementBlockedBy](https://docs.pyck.cloud/graphql-api/enums/repositorymovementblockedby.md): RepositoryMovementBlockedBy Enum
- [RepositoryType](https://docs.pyck.cloud/graphql-api/enums/repositorytype.md): RepositoryType Type
- [TransactionType](https://docs.pyck.cloud/graphql-api/enums/transactiontype.md): TransactionType Type
- [WorkflowTarget](https://docs.pyck.cloud/graphql-api/enums/workflowtarget.md): Client surfaces a workflow can target
- [Scalars](https://docs.pyck.cloud/graphql-api/scalars.md): Custom and standard scalar types used throughout the pyck GraphQL API
- [ID](https://docs.pyck.cloud/graphql-api/scalars/id.md): Unique identifier scalar type
- [String](https://docs.pyck.cloud/graphql-api/scalars/string.md): UTF-8 character sequence scalar type
- [Int](https://docs.pyck.cloud/graphql-api/scalars/int.md): 32-bit signed integer scalar type
- [Float](https://docs.pyck.cloud/graphql-api/scalars/float.md): Double-precision floating-point scalar type
- [Boolean](https://docs.pyck.cloud/graphql-api/scalars/boolean.md): True or false scalar type
- [Time](https://docs.pyck.cloud/graphql-api/scalars/time.md): ISO 8601 timestamp scalar for representing date and time values
- [Map](https://docs.pyck.cloud/graphql-api/scalars/map.md): JSON object scalar for storing flexible key-value data structures
- [Any](https://docs.pyck.cloud/graphql-api/scalars/any.md): Arbitrary JSON value scalar type
- [Federation Scalars](https://docs.pyck.cloud/graphql-api/scalars/federation-scalars.md): Apollo Federation scalar types used in pyck
- [Inputs](https://docs.pyck.cloud/graphql-api/inputs.md): GraphQL Input Type Definitions
- [Where Inputs](https://docs.pyck.cloud/graphql-api/inputs/where-inputs.md): Input types for filtering objects in GraphQL queries, providing comprehensive filtering capabilities across all pyck entities.
- [OrderBy Inputs](https://docs.pyck.cloud/graphql-api/inputs/orderby-inputs.md): OrderByInput types for sorting GraphQL query results
- [Mutation Inputs](https://docs.pyck.cloud/graphql-api/inputs/mutation-inputs.md): CreateInput and UpdateInput types for GraphQL mutations
- [CancelWorkflowInput](https://docs.pyck.cloud/graphql-api/inputs/cancelworkflowinput.md): CancelWorkflowInput Input Type
- [CustomEventPayloadInput](https://docs.pyck.cloud/graphql-api/inputs/customeventpayloadinput.md): CustomEventPayloadInput Input Type
- [GetAssigneeInput](https://docs.pyck.cloud/graphql-api/inputs/getassigneeinput.md): Input for retrieving workflow assignee information
- [GetWorkflowActionsInput](https://docs.pyck.cloud/graphql-api/inputs/getworkflowactionsinput.md): Input identifying the workflow execution whose available actions should be retrieved
- [GetWorkflowTargetsInput](https://docs.pyck.cloud/graphql-api/inputs/getworkflowtargetsinput.md): Input for retrieving the target surfaces of a workflow execution
- [InventoryItemWhereInput](https://docs.pyck.cloud/graphql-api/inputs/inventoryitemwhereinput.md): Input type for filtering InventoryItem objects with comprehensive query predicates
- [SetAssigneeInput](https://docs.pyck.cloud/graphql-api/inputs/setassigneeinput.md): SetAssigneeInput Input Type
- [SetWorkflowTargetsInput](https://docs.pyck.cloud/graphql-api/inputs/setworkflowtargetsinput.md): Input for replacing the target surfaces of a running workflow execution
- [WorkflowActionsWhereInput](https://docs.pyck.cloud/graphql-api/inputs/workflowactionswhereinput.md): Optional filter to narrow down which workflow actions are returned
- [Interfaces](https://docs.pyck.cloud/graphql-api/interfaces.md): GraphQL interfaces that define shared contracts across multiple types
- [Node](https://docs.pyck.cloud/graphql-api/interfaces/node.md): Base interface for all objects with a unique ID
- [WithCustomData](https://docs.pyck.cloud/graphql-api/interfaces/withcustomdata.md): Interface for entities with custom JSON data fields
- [WithTenant](https://docs.pyck.cloud/graphql-api/interfaces/withtenant.md): Interface for multi-tenant entities
- [WithMovement](https://docs.pyck.cloud/graphql-api/interfaces/withmovement.md): Interface for entities that support inventory movements
- [WithWorkflows](https://docs.pyck.cloud/graphql-api/interfaces/withworkflows.md): Interface for workflow-enabled entities
- [Notifiable](https://docs.pyck.cloud/graphql-api/interfaces/notifiable.md): Interface for entities that can send notifications
- [Searchable](https://docs.pyck.cloud/graphql-api/interfaces/searchable.md): Interface for full-text searchable entities
- [Directives](https://docs.pyck.cloud/graphql-api/directives.md): GraphQL directives available in the pyck API


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.pyck.cloud/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
