---
title: "Lists report-ready shipment line rows from the shipping reporting view, including pre-computed
dollar columns ($ shipped, $ unshipped, total $ ordered, unit price) so callers do not need to
hand-join shipments to sales-order line items."
method: POST
path: "/api/reporting/shipping/list"
tags: ["Reporting"]
---

# Lists report-ready shipment line rows from the shipping reporting view, including pre-computed
dollar columns ($ shipped, $ unshipped, total $ ordered, unit price) so callers do not need to
hand-join shipments to sales-order line items.

`POST /api/reporting/shipping/list`

## Query parameters

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

## Request body

- DtoReportingShippingReportFilter — Constrained filter for the shipping reporting list endpoint. Every field maps to a fixed, server-controlled column; values are always bound as Dapper parameters and never concatenated into SQL.
  - `shipByDateFrom` string, date-time, nullable — Inclusive lower bound applied to the shipment's Ship By Date. Null means no lower bound.
  - `shipByDateTo` string, date-time, nullable — Inclusive upper bound applied to the shipment's Ship By Date (the whole `to` day is included). Null means no upper bound.
  - `status` string, nullable — Optional exact-match filter on the shipment lifecycle status (e.g. "Shipped", "Open"). Null means no status filter.

## Response `200`

A page of shipping report rows with the total matching count.

- DtoPagedResultDtoDtoReportingShippingReportRow — Paged result
  - `data` DtoReportingShippingReportRow[], required — The data
    - `shipmentName` string, nullable — Shipment identifier / name.
    - `status` string, nullable — Shipment lifecycle status.
    - `packingStatus` string, nullable — Packing status (e.g. Not Packed, Partially Packed, Packed).
    - `shipmentType` string, nullable — Shipment classification.
    - `shipByDate` string, date-time, nullable — Date the shipment must ship by.
    - `shippedDate` string, date-time, nullable — Actual ship date; null if not yet shipped.
    - `isLate` integer, nullable — 1 when Shipped Date is after Ship By Date, otherwise 0. (Computed 1/0 flag in the view.)
    - `isOnTime` integer, nullable — 1 when Shipped Date is on or before Ship By Date, otherwise 0. (Computed 1/0 flag in the view.)
    - `daysLate` integer, nullable — Days between Ship By Date and Shipped Date (negative when shipped early).
    - `trackingNumber` string, nullable — Carrier tracking number, when supplied.
    - `recipientName` string, nullable — Customer / recipient name.
    - `recipientCustomerCode` string, nullable — Customer code for the recipient.
    - `shipToName` string, nullable — Ship-to contact name.
    - `shipToCity` string, nullable — Ship-to city.
    - `shipToState` string, nullable — Ship-to state / province.
    - `shipToCountry` string, nullable — Ship-to country.
    - `customerPONumber` string, nullable — Customer's PO number from the source sales order.
    - `purchaseOrder` string, nullable — Linked purchase order number, when this shipment is PO-driven.
    - `salesOrder` string, nullable — Linked sales order number, when this shipment is SO-driven.
    - `shippedByName` string, nullable — Name of the user who recorded the shipment.
    - `shippingCost` number, double, nullable — Cost of shipping (internal).
    - `shippingCharge` number, double, nullable — Charge billed to the customer for shipping.
    - `shippingCostNeedsInvoice` boolean, nullable — True when the shipping cost has not yet been invoiced to the customer.
    - `shippingMethod` string, nullable — Carrier / shipping method used.
    - `itemName` string, nullable — Item name on the shipment line.
    - `description` string, nullable — Item description on the shipment line.
    - `itemCategory` string, nullable — Category from the line's item.
    - `accountingCodeName` string, nullable — Accounting code mapped to the line's item.
    - `accountingClass` string, nullable — Accounting classification for the line's account.
    - `itemTags` string, nullable — Comma-separated tags from the line's item.
    - `quantityShipped` number, double, nullable — Quantity shipped on this line.
    - `totalQtyOrdered` number, double, nullable — Total quantity ordered on the source SO line.
    - `totalQtyShipped` number, double, nullable — Total quantity shipped across all shipments for the source SO line.
    - `unitPrice` number, double, nullable — Per-unit price on the source SO line.
    - `quantityToShip` number, double, nullable — Quantity remaining to ship on the source SO line.
    - `totalDollarsOrdered` number, double, nullable — Extended dollar value of the source SO line.
    - `dollarsShipped` number, double, nullable — Extended dollar value already shipped for the source SO line.
    - `dollarsUnshipped` number, double, nullable — Extended dollar value remaining to ship.
    - `quantityInvoiced` number, double, nullable — Total quantity invoiced for the source SO line.
    - `unitOfMeasureName` string, nullable — Unit of measure on the line.
    - `quantityPacked` number, double, nullable — Quantity packed on this shipment line.
    - `linePackingStatus` string, nullable — Per-line packing status.
    - `isReady` boolean, nullable — True when the line is ready to ship.
    - `openJobs` string, nullable — Comma-separated list of open jobs producing this line's item.
    - `qtyShippedLate` number, double, nullable — Quantity shipped after Ship By Date.
    - `dollarsShippedLate` number, double, nullable — Extended dollar value shipped late.
    - `qtyShippedOnTime` number, double, nullable — Quantity shipped on or before Ship By Date.
    - `dollarsShippedOnTime` number, double, nullable — Extended dollar value shipped on time.
    - `createdByName` string, nullable — User who created the shipment record.
    - `modifiedByName` string, nullable — Most recent user to modify the shipment record.
  - `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

## Other responses

- `403` — The viewer lacks the View Shipments permission.

---

[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)