> ## Documentation Index
> Fetch the complete documentation index at: https://redo-44af351d-docs-v3-graphql-api-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# InboundShipment

> A shipment of inventory arriving at a location, fulfilling one or more purchase orders.

**Required scopes:**
[`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

<ResponseField name="actualArrivalDate" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
  The date the shipment actually arrived.
</ResponseField>

<ResponseField name="carrier" type="String">
  The carrier transporting the shipment.
</ResponseField>

<ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
  When the record was created.
</ResponseField>

<ResponseField name="dutyCost" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
  The duty cost incurred for the shipment.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="estimatedArrivalDate" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
  The estimated date the shipment will arrive.
</ResponseField>

<ResponseField name="freightCost" type={<a href="/docs/api-reference/v3/reference/common/money">Money</a>}>
  The cost of freight for the shipment.

  <Expandable title="fields" lazyRender>
    <ResponseField name="amount" type={<a href="/docs/api-reference/v3/reference/common/decimal">Decimal!</a>} required>
      The exact amount as a decimal string (e.g. "19.99").
    </ResponseField>

    <ResponseField name="currency" type="String!" required>
      ISO 4217 currency code (e.g. USD).
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="freightType" type="String">
  The type of freight used for the shipment.
</ResponseField>

<ResponseField name="id" type="ID!" required>
  The id of this inbound shipment.
</ResponseField>

<ResponseField name="items" type={<a href="/docs/api-reference/v3/pagination">InboundShipmentItemConnection!</a>} required>
  A paginated list of the shipment's line items.

  **Requires:**
  [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

  <Expandable title="fields" lazyRender>
    **Arguments**

    <ResponseField name="after" type="String">
      Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
    </ResponseField>

    <ResponseField name="before" type="String">
      Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
    </ResponseField>

    <ResponseField name="first" type="Int">
      Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
    </ResponseField>

    <ResponseField name="last" type="Int">
      Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
    </ResponseField>

    **Fields**

    <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[InboundShipmentItemEdge!]!</a>} required>
      The list of edges (each a node plus its pagination `cursor`).

      <Expandable title="fields" lazyRender>
        <ResponseField name="cursor" type="String!" required>
          Opaque cursor for this item; pass to `after`/`before` to page from here.
        </ResponseField>

        <ResponseField name="node" type={<a href="/docs/api-reference/v3/reference/procurement/inbound-shipment-item">InboundShipmentItem!</a>} required>
          The item at this edge.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/procurement/inbound-shipment-item">[InboundShipmentItem!]!</a>} required>
      The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

      <Expandable title="fields" lazyRender>
        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="damagedQuantity" type="Int!" required>
          The quantity received damaged for this line item.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this shipment line item.
        </ResponseField>

        <ResponseField name="packingMode" type={<a href="/docs/api-reference/v3/reference/procurement/packing-mode">PackingMode!</a>} required>
          How this line item is packed.
        </ResponseField>

        <ResponseField name="product" type={<a href="/docs/api-reference/v3/reference/catalog/product">Product</a>}>
          The product received on this line item.

          **Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
        </ResponseField>

        <ResponseField name="purchaseOrder" type={<a href="/docs/api-reference/v3/reference/procurement/purchase-order">PurchaseOrder</a>}>
          The purchase order this received item was ordered on, if any.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
        </ResponseField>

        <ResponseField name="quantity" type="Int!" required>
          The quantity expected on this line item.
        </ResponseField>

        <ResponseField name="receivedQuantity" type="Int!" required>
          The quantity received for this line item.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
      Pagination metadata for the current page.

      <Expandable title="fields" lazyRender>
        <ResponseField name="endCursor" type="String">
          Cursor of the last edge in this page; pass to `after` to page forward.
        </ResponseField>

        <ResponseField name="hasNextPage" type="Boolean!" required>
          Whether more items exist after this page (drives forward pagination with `first`/`after`).
        </ResponseField>

        <ResponseField name="hasPreviousPage" type="Boolean!" required>
          Whether more items exist before this page (drives backward pagination with `last`/`before`).
        </ResponseField>

        <ResponseField name="startCursor" type="String">
          Cursor of the first edge in this page; pass to `before` to page backward.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location</a>}>
  The location the shipment is arriving at.

  **Requires:**
  [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)

  <Expandable title="fields" lazyRender>
    <ResponseField name="city" type="String">
      The city of the location's address.
    </ResponseField>

    <ResponseField name="company" type="String">
      The company name associated with the location.
    </ResponseField>

    <ResponseField name="countryCode" type="String">
      The country code, e.g. "US".
    </ResponseField>

    <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was created.
    </ResponseField>

    <ResponseField name="id" type="ID!" required>
      The id of this location.
    </ResponseField>

    <ResponseField name="inventoryLevels" type={<a href="/docs/api-reference/v3/pagination">LocationInventoryLevelConnection!</a>} required>
      Per-product inventory levels held at this location.

      **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

      <Expandable title="fields" lazyRender>
        **Arguments**

        <ResponseField name="after" type="String">
          Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
        </ResponseField>

        <ResponseField name="before" type="String">
          Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
        </ResponseField>

        <ResponseField name="first" type="Int">
          Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
        </ResponseField>

        <ResponseField name="last" type="Int">
          Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
        </ResponseField>

        **Fields**

        <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[LocationInventoryLevelEdge!]!</a>} required>
          The list of edges (each a node plus its pagination `cursor`).
        </ResponseField>

        <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/inventory/location-inventory-level">[LocationInventoryLevel!]!</a>} required>
          The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
        </ResponseField>

        <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
          Pagination metadata for the current page.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="name" type="String!" required>
      The location's display name.
    </ResponseField>

    <ResponseField name="phone" type="String">
      The contact phone number for the location.
    </ResponseField>

    <ResponseField name="postalCode" type="String">
      The postal or ZIP code, e.g. "84101".
    </ResponseField>

    <ResponseField name="stateCode" type="String">
      The state or province code, e.g. "UT".
    </ResponseField>

    <ResponseField name="street1" type="String">
      The first line of the street address.
    </ResponseField>

    <ResponseField name="street2" type="String">
      The second line of the street address.
    </ResponseField>

    <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
      When the record was last updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="paymentTerms" type="String">
  The payment terms agreed for the shipment.
</ResponseField>

<ResponseField name="purchaseOrders" type={<a href="/docs/api-reference/v3/pagination">PurchaseOrderConnection!</a>} required>
  Purchase orders this shipment fulfills.

  **Requires:**
  [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

  <Expandable title="fields" lazyRender>
    **Arguments**

    <ResponseField name="after" type="String">
      Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
    </ResponseField>

    <ResponseField name="before" type="String">
      Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
    </ResponseField>

    <ResponseField name="first" type="Int">
      Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
    </ResponseField>

    <ResponseField name="last" type="Int">
      Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
    </ResponseField>

    **Fields**

    <ResponseField name="edges" type={<a href="/docs/api-reference/v3/pagination">[PurchaseOrderEdge!]!</a>} required>
      The list of edges (each a node plus its pagination `cursor`).

      <Expandable title="fields" lazyRender>
        <ResponseField name="cursor" type="String!" required>
          Opaque cursor for this item; pass to `after`/`before` to page from here.
        </ResponseField>

        <ResponseField name="node" type={<a href="/docs/api-reference/v3/reference/procurement/purchase-order">PurchaseOrder!</a>} required>
          The item at this edge.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="nodes" type={<a href="/docs/api-reference/v3/reference/procurement/purchase-order">[PurchaseOrder!]!</a>} required>
      The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

      <Expandable title="fields" lazyRender>
        <ResponseField name="closedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime</a>}>
          When the purchase order was closed.
        </ResponseField>

        <ResponseField name="createdAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was created.
        </ResponseField>

        <ResponseField name="id" type="ID!" required>
          The id of this purchase order.
        </ResponseField>

        <ResponseField name="items" type={<a href="/docs/api-reference/v3/pagination">PurchaseOrderItemConnection!</a>} required>
          A paginated list of the order's line items.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="location" type={<a href="/docs/api-reference/v3/reference/inventory/location">Location</a>}>
          The location the order's inventory is destined for.

          **Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
        </ResponseField>

        <ResponseField name="note" type="String">
          An internal note on the purchase order.
        </ResponseField>

        <ResponseField name="orderedAt" type={<a href="/docs/api-reference/v3/reference/common/date">Date</a>}>
          The date the order was placed with the supplier.
        </ResponseField>

        <ResponseField name="poNumber" type="String!" required>
          The merchant-facing purchase order number.
        </ResponseField>

        <ResponseField name="referenceNumber" type="String">
          An external reference for the purchase order.
        </ResponseField>

        <ResponseField name="shipments" type={<a href="/docs/api-reference/v3/pagination">InboundShipmentConnection!</a>} required>
          Inbound shipments fulfilling this purchase order.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)

          <Expandable title="fields" lazyRender>
            **Arguments**

            <ResponseField name="after" type="String">
              Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
            </ResponseField>

            <ResponseField name="before" type="String">
              Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
            </ResponseField>

            <ResponseField name="first" type="Int">
              Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
            </ResponseField>

            <ResponseField name="last" type="Int">
              Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="status" type={<a href="/docs/api-reference/v3/reference/procurement/purchase-order-status">PurchaseOrderStatus!</a>} required>
          The current lifecycle status of the purchase order.
        </ResponseField>

        <ResponseField name="supplier" type={<a href="/docs/api-reference/v3/reference/procurement/supplier">Supplier</a>}>
          The supplier the order was placed with.

          **Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
        </ResponseField>

        <ResponseField name="supplierNote" type="String">
          A note shared with the supplier.
        </ResponseField>

        <ResponseField name="tags" type="[String!]!" required>
          Free-form tags applied to the purchase order.
        </ResponseField>

        <ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
          When the record was last updated.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="pageInfo" type={<a href="/docs/api-reference/v3/pagination">PageInfo!</a>} required>
      Pagination metadata for the current page.

      <Expandable title="fields" lazyRender>
        <ResponseField name="endCursor" type="String">
          Cursor of the last edge in this page; pass to `after` to page forward.
        </ResponseField>

        <ResponseField name="hasNextPage" type="Boolean!" required>
          Whether more items exist after this page (drives forward pagination with `first`/`after`).
        </ResponseField>

        <ResponseField name="hasPreviousPage" type="Boolean!" required>
          Whether more items exist before this page (drives backward pagination with `last`/`before`).
        </ResponseField>

        <ResponseField name="startCursor" type="String">
          Cursor of the first edge in this page; pass to `before` to page backward.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="shipmentId" type="String">
  The carrier's identifier for the shipment.
</ResponseField>

<ResponseField name="status" type={<a href="/docs/api-reference/v3/reference/procurement/inbound-shipment-status">InboundShipmentStatus!</a>} required>
  The current status of the shipment.
</ResponseField>

<ResponseField name="trackingNumber" type="String">
  The shipment's tracking number.
</ResponseField>

<ResponseField name="trackingUrl" type="String">
  A URL to track the shipment.
</ResponseField>

<ResponseField name="updatedAt" type={<a href="/docs/api-reference/v3/reference/common/date-time">DateTime!</a>} required>
  When the record was last updated.
</ResponseField>
