> For the complete documentation index, see [llms.txt](https://docs.pyck.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pyck.cloud/graphql-api/interfaces.md).

# Interfaces

GraphQL interfaces that define shared contracts across multiple types

Audience: Programmer

GraphQL interfaces are abstract types that define a set of fields that multiple object types can implement. They enable polymorphic queries and ensure consistent field definitions across related types.

## Available Interfaces

### Core Interfaces

* [**Node**](/graphql-api/interfaces/node.md) - Base interface for all entities with unique identifiers
* [**NodeAttachments**](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodeAttachments.md) - Interface for entities that support file attachments
* [**NodeDataType**](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodeDataType.md) - Interface for entities with data type classification
* [**NodeInventory**](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodeInventory.md) - Interface for inventory-related entities
* [**NodePicking**](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodePicking.md) - Interface for picking-related entities
* [**NodeReceiving**](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodeReceiving.md) - Interface for receiving-related entities
* [**NodeWorkflowService**](https://github.com/pyck-ai/docs/blob/main/graphql/interfaces/NodeWorkflowService.md) - Interface for workflow-enabled entities

### Common Patterns

* **WithCustomData** - Entities with JSON data fields
* **WithTenant** - Multi-tenant capable entities
* **WithMovement** - Entities that support movements
* **WithWorkflows** - Workflow-enabled entities
* **Notifiable** - Entities that can send notifications
* **Searchable** - Full-text searchable entities

## Usage

Interfaces enable you to write queries that work across multiple types:

```graphql
query {
  node(id: "123") {
    id
    ... on InventoryItem {
      sku
      data
    }
    ... on Customer {
      name
      code
    }
  }
}
```

## Benefits

1. **Type Safety** - Ensures consistent field definitions
2. **Polymorphism** - Query multiple types with a single interface
3. **Code Reuse** - Share common field definitions
4. **Extensibility** - Easy to add new types that implement existing interfaces

## See Also

* [Types](/graphql-api/types.md) - Concrete implementations of interfaces
* [Schema Overview](/graphql-api/schema-overview.md) - Overall GraphQL schema structure


---

# 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
If you need additional information that is not directly available in this page, you can query the documentation 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/graphql-api/interfaces.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.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.