> 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/queries/pickingorderitems.md).

# Picking Order Items

pickingOrderItems Query

Audience: Programmers

Returns a paginated list of PickingOrderItem objects, with optional filtering and ordering. This query allows you to retrieve individual line items from picking orders across the system.

## Arguments

| Name      | Type                         | Description                                                            |
| --------- | ---------------------------- | ---------------------------------------------------------------------- |
| `after`   | `Cursor`                     | Returns the elements in the list that come after the specified cursor  |
| `first`   | `Int`                        | Returns the first *n* elements from the list                           |
| `before`  | `Cursor`                     | Returns the elements in the list that come before the specified cursor |
| `last`    | `Int`                        | Returns the last *n* elements from the list                            |
| `orderBy` | `PickingOrderItemOrder`      | Ordering options for PickingOrderItems returned from the connection    |
| `where`   | `PickingOrderItemWhereInput` | Filtering options for PickingOrderItems returned from the connection   |

## Return Type

`PickingOrderItemConnection!` - A connection to a list of PickingOrderItem objects with pagination information.

## Fields Available

The `PickingOrderItem` type includes:

| Field          | Type            | Description                                        |
| -------------- | --------------- | -------------------------------------------------- |
| `id`           | `ID!`           | Unique identifier for the order item               |
| `tenantID`     | `UUID!`         | Tenant identifier                                  |
| `orderID`      | `ID!`           | ID of the associated picking order                 |
| `quantity`     | `Int!`          | Quantity of the item to be picked                  |
| `sku`          | `String!`       | Stock keeping unit identifier                      |
| `dataTypeID`   | `UUID`          | Optional data type ID for custom validation        |
| `dataTypeSlug` | `String`        | Optional data type slug for custom validation      |
| `data`         | `Map`           | Custom data associated with the order item as JSON |
| `createdAt`    | `Time!`         | When the order item was created                    |
| `createdBy`    | `UUID!`         | User who created the order item                    |
| `updatedAt`    | `Time`          | When the order item was last updated               |
| `updatedBy`    | `UUID`          | User who last updated the order item               |
| `deletedAt`    | `Time`          | Soft deletion timestamp                            |
| `deletedBy`    | `UUID`          | User who deleted the order item                    |
| `order`        | `PickingOrder!` | The associated picking order                       |

## Notes

* The `data` field contains custom item attributes as JSON
* You can use the `Data`, `DataHasKey`, `DataIn`, and `DataContains` filters to query based on JSON content
* The `sku` field is federated and can be used to resolve inventory item details from other services
* Each order item is linked to exactly one picking order via the `orderID` field

## Usage Example

### Basic Query

```graphql
query GetPickingOrderItems {
  pickingOrderItems(
    first: 10,
    orderBy: { direction: DESC, field: CREATED_AT },
    where: {
      sku: "PROD-12345"
    }
  ) {
    edges {
      node {
        id
        sku
        quantity
        orderID
        data
        order {
          id
          customerID
          createdAt
        }
        createdAt
        updatedAt
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}
```

### Query with JSON Field Filtering

```graphql
query FilterByCustomData {
  pickingOrderItems(
    first: 20,
    where: {
      DataHasKey: "priority",
      DataContains: ["high"]
    }
  ) {
    edges {
      node {
        id
        sku
        quantity
        data
      }
    }
    totalCount
  }
}
```

### JavaScript Example

```javascript
const getPickingOrderItemsQuery = `
  query GetPickingOrderItems($first: Int, $after: Cursor, $where: PickingOrderItemWhereInput) {
    pickingOrderItems(first: $first, after: $after, where: $where) {
      edges {
        node {
          id
          sku
          quantity
          orderID
          data
          order {
            id
            customerID
            createdAt
          }
          createdAt
          updatedAt
        }
        cursor
      }
      pageInfo {
        hasNextPage
        hasPreviousPage
        startCursor
        endCursor
      }
      totalCount
    }
  }
`;

const variables = {
  first: 10,
  where: {
    sku: "PROD-12345"
  }
};

// Using fetch or your preferred GraphQL client
const response = await fetch('/graphql', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_TOKEN'
  },
  body: JSON.stringify({
    query: getPickingOrderItemsQuery,
    variables: variables
  })
});

const result = await response.json();
console.log('Picking order items:', result.data.pickingOrderItems);

// Pagination example - fetching next page
if (result.data.pickingOrderItems.pageInfo.hasNextPage) {
  const nextPageVariables = {
    ...variables,
    after: result.data.pickingOrderItems.pageInfo.endCursor
  };
  // Make another request with nextPageVariables
}
```

## Related Queries

* [pickingOrders](/graphql-api/queries/pickingorders.md) - Query complete picking orders
* [nodePicking](/graphql-api/queries/nodepicking.md) - Retrieve specific picking objects by ID

## Related Mutations

* [createPickingOrderItem](/graphql-api/mutations/createpickingorderitem.md) - Create a new picking order item
* [updatePickingOrderItem](/graphql-api/mutations/updatepickingorderitem.md) - Update an existing picking order item
* [deletePickingOrderItem](/graphql-api/mutations/deletepickingorderitem.md) - Delete a picking order item


---

# 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/queries/pickingorderitems.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.
