Sign in
Inventory Event

Find inventory events based on search parameters.

post/api/inventory-events/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

createdBeforeUtcstring date-time nullable

Filters events created before (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.

createdAfterUtcstring date-time nullable

Filters events created after (exclusive) this parameter in UTC time. If no time component is passed, midnight UTC will be used.

typesInventoryEventType[] nullable

Inventory event type(s).

secondaryTypesInventoryEventSecondaryType[] nullable

Inventory event secondary type(s).

sourceTypesInventoryEnumEventSourceType[] nullable

Inventory event source type(s).

itemIdsstring[] nullable

Item id. Please reference /api/items endpoint.

itemToMakeIdsstring[] nullable

Item id. Please reference /api/items endpoint.

reservedForTypesDomainCommonEntityType[] nullable

Inventory reservation types.

reservedForIdsstring[] nullable

Inventory reservation ids.

inventoryEventIdsstring[] nullable

Inventory event ids.

Response

List of inventory events matching the filters

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