Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
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.

Takeinteger

Number of records to return (maximum)

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.