Sign in
Inventory Lot

Find inventory lots based on search parameters.

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

namestring nullable

Filter lots based on their name.

itemIdsstring[] nullable

Item ids to match. Please reference /api/items endpoint.

systemboolean nullable

Filter by whether the lot is considered a system-generated lot.

Response

List of inventory lots matching the filters

idstring required

Unique id associated to this entity.

namestring required

The name of the lot. It is not guaranteed to be unique inventory-wide, but only within an item.

itemIdstring required

The item id that is associated to this lot. Please reference /api/items endpoint.

quantitynumber double

Quantity associated to this lot.

systemboolean required

Designates if this is a system-generated lot.

customboolean required

Designates if this item is customized.

expirationDatestring date-time nullable

The date that this lot is supposed to expire.

Changes

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