Sales Order

Lists sales order status changes in a fixed order, newest first (changes at the same instant by `id`, descending); Sort is ignored. One row per change: the status the sales order moved into, the status it left, who made the change and when, and the sales order's number, customer, salesperson, current status and part line count. Revision and deletion events, and every change of a deleted sales order, are left out.

Changed on
post/api/sales-orders/status-history/list

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/sales-orders/status-history/list
  • Auth
    none declared

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

changedFromUtcstring date-time nullable

Keeps changes made at or after this exact instant (inclusive), compared to the full timestamp, not the day. A value without an offset is read as UTC.

changedBeforeUtcstring date-time nullable

Keeps changes made strictly before this exact instant (exclusive), compared to the full timestamp, not the day. Windows from changedFromUtc to changedBeforeUtc that share an instant put every change in exactly one window. To walk a stable set across pages, fix this at the first request and dedupe on id. A value without an offset is read as UTC.

newStatusesDtoSalesOrderStatusHistoryStatus[] nullable

Keeps changes whose newStatus (the status the sales order moved into) is one of these. Empty or omitted keeps every status.

salesOrderIdstring nullable

Keeps the changes of this one sales order, by its id. Empty or blank is treated as omitted.

changedByUserIdstring nullable

Keeps the changes made by this one user, matched against changedByUserId. Empty or blank is treated as omitted.

Response

A page of status changes 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