v2

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

Takeinteger

Number of records to return (maximum)

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