Enums

GraphQL Enums Documentation

Audience: Programmer

This section documents all GraphQL enums available in the pyck API. Enums define a restricted set of possible values for specific fields.

File System Enums

FileReftype

Defines the type of entity that a file is associated with.

Values: item, customer, supplier, picking_order, picking_order_item, inbound, inbound_item, item_movement, repository_movement, file, item_set, repository, collection_movement

Inventory Enums

ItemMovementBlockedBy

Specifies reasons why an item movement might be blocked.

Values: RecalledProducts, ExpiredProducts, MislabelledGoods, RegulatoryHold, AwaitingDocumentation, InventoryDiscrepancies, HazardousMaterials, CounterfeitGoods, SeasonalGoods

RepositoryMovementBlockedBy

Specifies reasons why a repository movement might be blocked.

Values: RecalledProducts, ExpiredProducts, MislabelledGoods, RegulatoryHold, AwaitingDocumentation, InventoryDiscrepancies, HazardousMaterials, CounterfeitGoods, SeasonalGoods

RepositoryType

Defines the type of repository for inventory storage.

Values: dynamic, static

TransactionType

Defines the direction of inventory transactions.

Values: into, out

Common Enums

JSONType

Specifies the type casting for extracted JSONB values during ordering.

Values: NUMBER, STRING, BOOLEAN

Usage: Used with JSONB column ordering to specify how to cast extracted JSON values for proper sorting.

See JSONType documentation for detailed usage examples.

OrderDirection

Specifies the sort order for query results.

Values: ASC, DESC

Workflow Enums

WorkflowTarget

Defines the client surfaces a workflow execution can target. Used as values of the pyck_workflow_targets KeywordList search attribute.

Values: WEB, MOBILE, SETUP

See WorkflowTarget documentation for detailed usage examples.

Usage Patterns

Filtering with Enums

query {
  files(where: { reftype: item }) {
    edges {
      node {
        id
        filename
        reftype
      }
    }
  }
}

Using Enums in Mutations

mutation {
  createInventoryRepository(input: {
    name: "Main Storage"
    type: static
  }) {
    id
    name
    type
  }
}

JavaScript Example

// Using enums in variables
const variables = {
  repositoryType: 'static',
  transactionType: 'into',
  sortOrder: 'DESC'
};

const result = await client.query({
  query: gql`
    query GetRepositories($type: RepositoryType!, $order: OrderDirection!) {
      repositories(where: { type: $type }, orderBy: { field: NAME, direction: $order }) {
        edges {
          node {
            id
            name
            type
          }
        }
      }
    }
  `,
  variables: {
    type: variables.repositoryType,
    order: variables.sortOrder
  }
});

Notes

• Enum values are case-sensitive

• Enums provide type safety and validation

• Unknown enum values will result in GraphQL validation errors

• Enums are commonly used for filtering, sorting, and categorization