Sign in
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.Fieldstring

Sort field

Sort.Dir'ascending' | 'descending'

Specify sorting direction.

Sort direction

Skipinteger

Number of records to skip. Defaults to 0. Combine with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Take to page through a result set larger than one page.

Takeinteger

Number of records to return. Validation accepts 0 through 5000, but 0 is not a page size and what an endpoint does with it varies, so send a value from 1 to 5000.

Two cases differ. A request that supplies paging but leaves this field out takes this field's default of <b>50</b>. A request that supplies no paging at all is endpoint-specific — some define their own fallback — so it does not reliably mean any particular number of records. Either way the response says nothing about records it did not return, so send this explicitly whenever the size of the answer matters. Endpoints returning a paged envelope report totalCount and hasNextPage alongside the records; endpoints returning a bare array report neither, so page those with FulcrumProduct.PublicApi.Dto.Common.PagingDto.Skip until a page comes back shorter than the value requested.

Request body

shipByDateFromstring date-time nullable

Inclusive lower bound applied to the shipment's Ship By Date. Null means no lower bound.

shipByDateTostring 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.

shippedDateFromstring date-time nullable

Inclusive lower bound applied to the date the shipment actually shipped — its ship-date override when one is set, else its recorded ship date. Distinct from FulcrumProduct.PublicApi.Dto.Reporting.ShippingReportFilter.ShipByDateFrom, which bounds the date it was due to ship rather than the date it did. Matches only shipments whose status is Shipped: a ship-date override can be set while a shipment is still open, so the date alone does not mean it went out. Null means no lower bound.

shippedDateTostring date-time nullable

Inclusive upper bound applied to that same actual ship date (the whole to day is included, whatever time of day the shipment went out), and likewise matching only shipments whose status is Shipped. Null means no upper bound.

statusstring nullable

Optional exact-match filter on the shipment lifecycle status (e.g. "Shipped", "Open"). Null means no status filter.

Response

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

pageinteger required

The 1-indexed page

pageSizeinteger required

The page size

totalCountinteger required

The total count of records

totalPagesinteger required

The total pages

hasPreviousPageboolean required

True if there is a previous page

hasNextPageboolean required

True if there is a next page

Changes