---
title: "Search for shipment line items based on parameters."
method: POST
path: "/api/shipment-line-items/list"
tags: ["Shipment Line Items (V3)"]
---

# Search for shipment line items based on parameters.

`POST /api/shipment-line-items/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- ShipmentLineItemsListParameters — Parameters used for searching V3 shipment line items
  - `packingStatus` 'notPacked' | 'partiallyPacked' | 'fullyPacked' | 'overPacked'
  - `itemId` string, nullable — Filter shipment line items based on item identifier.
  - `shipmentId` string, nullable — Filter shipment line items based on shipment identifier.
  - `salesOrderId` string, nullable — Filter shipment line items based on sales order identifier.
  - `purchaseOrderId` string, nullable — Filter shipment line items based on purchase order identifier.
  - `salesOrderLineItemIds` string[], nullable — Filter shipment line items based on sales order line item(s) identifier.
  - `purchaseOrderLineItemIds` string[], nullable — Filter shipment line items based on purchase order line item identifier.
  - `shipmentIds` string[], nullable — Filter shipment line items based on shipment identifiers.
  - `shipmentType` 'unknown' | 'standard' | 'outsideProcessing'

## Response `200`

OK

- DtoPagedResultDtoShipmentLineItemDto — Paged result
  - `data` ShipmentLineItemDto[], required — The data
    - `id` string, required — Shipment line item identifier
    - `packingStatus` 'notPacked' | 'partiallyPacked' | 'fullyPacked' | 'overPacked', required
    - `shipmentType` 'unknown' | 'standard' | 'outsideProcessing', required
    - `quantityToShip` number, double, required — The quantity to ship
    - `shipmentName` string, required — The shipment name (eg. SHP-S0123-1)
    - `shipmentStatus` 'pending' | 'open' | 'shipped' | 'cancelled'
    - `shipByDate` string, date-time, nullable — The date the shipment this line item belongs to is scheduled to ship by
    - `shippedDate` string, date-time, nullable — The date the shipment this line item belongs to was actually shipped
    - `shippedDateOverride` string, date-time, nullable — The shipped date override of the shipment this line item belongs to
    - `quantityInvoiced` number, double — The quantity invoiced
    - `quantityPacked` number, double — The quantity packed
    - `itemId` string, nullable — The item identifier
    - `shipmentId` string, nullable — The shipment identifier
    - `salesOrderId` string, nullable — The sales order identifier
    - `salesOrderLineItemId` string, nullable — The sales order line item identifier
    - `purchaseOrderId` string, nullable — The purchase order identifier
    - `purchaseOrderLineItemId` string, nullable — The purchase order line item identifier
    - `quantityShipped` number, double — The quantity shipped
    - `shippedFromLocations` string[] — The locations this line was shipped from
    - `shippedFromLots` string[] — The lots this line was shipped from
    - `packingDetails` ShipmentLineItemPackingDetailDto[] — Packing details indicating how quantities were split amongst lots/locations.
      - `lotId` string, nullable — Lot identifier. Please reference /api/inventory-lots endpoint.
      - `lotName` string, nullable — Lot name.
      - `locationId` string, nullable — Location identifier. Please reference /api/locations endpoint.
      - `locationName` string, nullable — Location name.
      - `quantityPacked` number, double, nullable — Quantity packed for this shipment line item that are associated to this lot.
      - `box` string, nullable — Box identifier this packing detail was packed into. Free-form (e.g., "1", "A1").
  - `page` integer, required — The 1-indexed page
  - `pageSize` integer, required — The page size
  - `totalCount` integer, required — The total count of records
  - `totalPages` integer, required — The total pages
  - `hasPreviousPage` boolean, required — True if there is a previous page
  - `hasNextPage` boolean, required — True if there is a next page

---

[API](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fulcrumpro/fulcrum-publicapi/versions/1b5649cff14a/schema)