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

# ReceivingInbound

ReceivingInbound Type

Represents an inbound shipment in the receiving system, used to track incoming inventory from suppliers.

## Fields

| Field          | Type     | Description                                    |
| -------------- | -------- | ---------------------------------------------- |
| `id`           | `ID!`    | Unique identifier of the inbound shipment      |
| `tenantID`     | `UUID!`  | Tenant identifier                              |
| `createdAt`    | `Time!`  | Creation timestamp                             |
| `createdBy`    | `UUID`   | User identifier who created the inbound        |
| `updatedAt`    | `Time`   | Last update timestamp                          |
| `updatedBy`    | `UUID`   | User identifier who last updated the inbound   |
| `deletedAt`    | `Time`   | Deletion timestamp                             |
| `deletedBy`    | `UUID`   | User identifier who deleted the inbound        |
| `dataTypeID`   | `UUID`   | Data type identifier                           |
| `dataTypeSlug` | `String` | Data type slug                                 |
| `data`         | `Map`    | Custom data associated with the inbound        |
| `orderID`      | `String` | Order or reference ID for the inbound shipment |
| `supplierID`   | `UUID!`  | ID of the supplier this inbound is from        |

## Connection Fields

The `inboundItems` field returns a Connection object that supports pagination, filtering, and ordering.

### inboundItems Connection

```graphql
inboundItems(
  after: Cursor
  first: Int
  before: Cursor
  last: Int
  orderBy: ReceivingInboundItemOrder
  where: ReceivingInboundItemWhereInput
): ReceivingInboundItemConnection!
```

| Argument  | Type                             | Description                         |
| --------- | -------------------------------- | ----------------------------------- |
| `after`   | `Cursor`                         | Returns elements after this cursor  |
| `first`   | `Int`                            | Returns the first n elements        |
| `before`  | `Cursor`                         | Returns elements before this cursor |
| `last`    | `Int`                            | Returns the last n elements         |
| `orderBy` | `ReceivingInboundItemOrder`      | Ordering options for inbound items  |
| `where`   | `ReceivingInboundItemWhereInput` | Filtering options for inbound items |

## Interfaces

* `NodeReceiving`

## Usage Example

```graphql
query {
  receivingInbounds(
    first: 10,
    orderBy: { direction: DESC, field: CREATED_AT }
  ) {
    edges {
      node {
        id
        orderID
        supplierID
        data
        inboundItems(first: 100) {
          edges {
            node {
              sku
              quantity
            }
          }
          pageInfo {
            hasNextPage
            endCursor
          }
          totalCount
        }
        createdAt
      }
    }
  }
}
```

### Query with Filtering and Ordering on Inbound Items

```graphql
query {
  receivingInbounds(first: 10) {
    edges {
      node {
        id
        orderID
        inboundItems(
          first: 50
          orderBy: { direction: ASC, field: SKU }
          where: { quantityGTE: 10 }
        ) {
          edges {
            node {
              id
              sku
              quantity
            }
          }
          totalCount
        }
      }
    }
  }
}
```

### Create Mutation Example

```graphql
mutation {
  createReceivingInbound(
    input: {
      supplierID: "550e8400-e29b-41d4-a716-446655440000",
      orderID: "PO-98765",
      data: {
        "expected_arrival_date": "2023-06-15",
        "carrier": "Express Logistics",
        "tracking_number": "TRK123456789",
        "notes": "Requires inspection upon arrival"
      },
      inbounditemIDs: []
    }
  ) {
    receivingInbound {
      id
      orderID
      data
      inboundItems {
        edges {
          node {
            id
            sku
            quantity
          }
        }
        totalCount
      }
    }
  }
}
```


---

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