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

# ReceivingInboundShipmentNotification

ReceivingInboundShipmentNotification Type

Audience: Programmer

Represents an inbound shipment notification in the receiving service. Inbound shipment notifications allow downstream consumers to react when an inbound receipt has completed. The entity is owned by the receiving microservice and is backed by the ent model `github.com/pyck-ai/pyck/backend/receiving/ent/gen.InboundShipmentNotification`.

## Fields

| Field          | Type                | Description                                                       |
| -------------- | ------------------- | ----------------------------------------------------------------- |
| `id`           | `ID!`               | Unique identifier of the notification                             |
| `tenantID`     | `UUID!`             | Tenant identifier                                                 |
| `dataTypeID`   | `UUID`              | Optional data type identifier used for JSON validation            |
| `dataTypeSlug` | `String`            | Optional data type slug used for JSON validation                  |
| `data`         | `Map`               | Custom JSONB data associated with the notification                |
| `createdAt`    | `Time!`             | Creation timestamp                                                |
| `createdBy`    | `UUID!`             | User identifier who created the notification                      |
| `updatedAt`    | `Time`              | Last update timestamp                                             |
| `updatedBy`    | `UUID`              | User identifier who last updated the notification                 |
| `deletedAt`    | `Time`              | Soft-deletion timestamp                                           |
| `deletedBy`    | `UUID`              | User identifier who deleted the notification                      |
| `inboundID`    | `ID!`               | ID of the parent receiving inbound                                |
| `inbound`      | `ReceivingInbound!` | The parent receiving inbound this notification is associated with |

## Interfaces

* `NodeReceiving`

## Ordering Fields

The connection type `ReceivingInboundShipmentNotificationConnection` supports ordering by the following fields (via `ReceivingInboundShipmentNotificationOrderField`):

* `TENANT_ID`
* `CREATED_AT`
* `CREATED_BY`
* `UPDATED_AT`
* `UPDATED_BY`
* `DELETED_AT`
* `DELETED_BY`
* `INBOUND_ID`

## Where Input Extensions

The `ReceivingInboundShipmentNotificationWhereInput` supports both standard ent-generated predicates and JSON-aware extensions:

| Extension      | Type        | Description                                                                |
| -------------- | ----------- | -------------------------------------------------------------------------- |
| `Data`         | `[String!]` | Filter by serialized JSON fragments                                        |
| `DataHasKey`   | `String`    | Filter rows where the `data` JSONB column contains the given top-level key |
| `DataIn`       | `[String!]` | Filter by JSON values in the set                                           |
| `DataContains` | `[String!]` | Filter by JSON fragments that are contained in the `data` column           |

See [Advanced JSON Field Queries](https://github.com/pyck-ai/docs/blob/main/graphql/advanced/json-field-queries.md) for details on using the JSON filters.

## Usage Example

```graphql
query {
  receivingInboundShipmentNotifications(
    first: 10,
    orderBy: { direction: DESC, field: CREATED_AT }
  ) {
    edges {
      node {
        id
        tenantID
        inboundID
        data
        inbound {
          id
          orderID
          supplierID
        }
        createdAt
      }
    }
    totalCount
  }
}
```

### Create Mutation Example

```graphql
mutation {
  createReceivingInboundShipmentNotification(
    input: {
      inboundID: "550e8400-e29b-41d4-a716-446655440000",
      data: {
        "carrier": "Express Logistics",
        "tracking_number": "TRK123456789",
        "arrived_at": "2026-04-10T14:15:00Z",
        "dock_door": "D-07"
      }
    }
  ) {
    receivingInboundShipmentNotification {
      id
      inboundID
      data
    }
    workflows {
      id
      type
      runID
      status
    }
  }
}
```


---

# 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/types/receivinginboundshipmentnotification.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.