Skip to main content

Add Inventory Snapshot

POST 

/api/inventories/addinventorysnapshot

Tier: Internal — subject to change without notice.

Uploads a batch of scanned tags against an in-progress stocktake (state → InProgress). This is the scan-upload endpoint used repeatedly while counting.

Request

Responses

InventoryDtos.InventoryOperationResultDto — always this shape regardless of ReturnResultDto. On the synchronous path, InventoryDto is the refreshed InventoryDtos.InventoryDetailDto and Notifications lists items excluded from the snapshot because their current Enums.ItemStateType disallows it (e.g. items mid-order). On the async path (NotifyOnceComplete + matching NotificationRecipientId), BackgroundTaskId is populated and InventoryDto is a fake placeholder (InventoryState:"Processing"). A new SnapshotBase is captured at the inventory's place; unknown tags auto-create items; a SnapshotAdded transaction row and InventorySnapshotAdded system event are raised.