Inventory

Find inventory based on search parameters.

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

lotIdsstring[] nullable

Filter inventory based on lot ids.

itemIdsstring[] nullable

Filter inventory based on item ids.

locationIdsstring[] nullable

Filter inventory based on location ids.

Response

List of locations matching the filters

idstring required

Unique id associated to this entity.

lotIdstring nullable

The lot Iid associated to this entity.

locationIdstring nullable

The location id associated to this entity.

quantitynumber double required

The quantity of items in this inventory.

onHandQuantitynumber double required

The on-hand quantity of items in this inventory.

itemIdstring required

The item id associated to this entity.

itemNumberstring required

The number/sku/short name of the item.

itemDescriptionstring nullable

The description of the item

Changes

No recorded changes to this endpoint across all 23 revisions of this API.