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

# Picking Outbound Shipment Notifications

pickingOutboundShipmentNotifications Query

Audience: Programmer

Returns a paginated list of `PickingOutboundShipmentNotification` objects, with optional filtering and ordering. Outbound shipment notifications allow downstream consumers to react when an outbound shipment (picking order) has completed.

## 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` | `PickingOutboundShipmentNotificationOrder`      | Ordering options for PickingOutboundShipmentNotifications returned from the connection  |
| `where`   | `PickingOutboundShipmentNotificationWhereInput` | Filtering options for PickingOutboundShipmentNotifications returned from the connection |

## Return Type

`PickingOutboundShipmentNotificationConnection!` - A Relay connection to a list of `PickingOutboundShipmentNotification` objects with pagination information.

## Ordering Fields

The `PickingOutboundShipmentNotificationOrder` input supports ordering by the following fields:

| Field        | Description                          |
| ------------ | ------------------------------------ |
| `TENANT_ID`  | Order by tenant ID                   |
| `CREATED_AT` | Order by creation timestamp          |
| `CREATED_BY` | Order by creator user ID             |
| `UPDATED_AT` | Order by last update timestamp       |
| `UPDATED_BY` | Order by last updater user ID        |
| `DELETED_AT` | Order by deletion timestamp          |
| `DELETED_BY` | Order by deleter user ID             |
| `ORDER_ID`   | Order by the parent picking order ID |

The `PickingOutboundShipmentNotificationOrder` input also supports:

| Field       | Type                                            | Description                                                                                     |
| ----------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `direction` | `OrderDirection!`                               | Ordering direction (`ASC` or `DESC`, default `ASC`)                                             |
| `field`     | `PickingOutboundShipmentNotificationOrderField` | The field by which to order notifications                                                       |
| `jsonPath`  | `String`                                        | Dot-notation path into a JSONB column (e.g. `"meta.weight"`) used when ordering by a JSON field |
| `jsonType`  | `JSONType`                                      | Cast type for the extracted JSONB value                                                         |

## Notes

The `data` field contains custom notification attributes as JSON. The `PickingOutboundShipmentNotificationWhereInput` is extended with JSON-aware filters: `Data`, `DataHasKey`, `DataIn`, and `DataContains`. For complex JSON field queries, see [Advanced JSON Field Queries](https://github.com/pyck-ai/docs/blob/main/graphql/advanced/json-field-queries.md).

Soft-deleted notifications are excluded by default. Use `deletedAtNotNil: true` to include them when necessary.

## Usage Example

```graphql
query {
  pickingOutboundShipmentNotifications(
    first: 10,
    orderBy: { direction: DESC, field: CREATED_AT },
    where: {
      orderID: "550e8400-e29b-41d4-a716-446655440000"
    }
  ) {
    edges {
      node {
        id
        tenantID
        dataTypeID
        dataTypeSlug
        data
        orderID
        order {
          id
          customerID
        }
        createdAt
        createdBy
        updatedAt
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}
```

## Filtering by JSON Data

```graphql
query {
  pickingOutboundShipmentNotifications(
    first: 25,
    orderBy: { direction: DESC, field: CREATED_AT },
    where: {
      DataHasKey: "carrier",
      DataContains: ["\"carrier\":\"DHL\""]
    }
  ) {
    edges {
      node {
        id
        orderID
        data
        createdAt
      }
    }
    totalCount
  }
}
```

## JavaScript Example

```javascript
const query = `
  query PickingOutboundShipmentNotifications(
    $first: Int,
    $orderBy: PickingOutboundShipmentNotificationOrder,
    $where: PickingOutboundShipmentNotificationWhereInput
  ) {
    pickingOutboundShipmentNotifications(first: $first, orderBy: $orderBy, where: $where) {
      edges {
        node {
          id
          orderID
          data
          createdAt
        }
      }
      totalCount
    }
  }
`;

const variables = {
  first: 10,
  orderBy: { direction: "DESC", field: "CREATED_AT" },
  where: { orderID: "550e8400-e29b-41d4-a716-446655440000" }
};

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

const result = await response.json();
console.log('Notifications:', result.data.pickingOutboundShipmentNotifications);
```


---

# 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/pickingoutboundshipmentnotifications.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.