event

Warehouse Stock Snapshot

Periodic snapshot of stock positions across an entire warehouse

EventNew

Overview

The WarehouseStockSnapshot event is published every 15 minutes by the warehouse management system. It contains the stock position of every SKU in every zone of a warehouse, and is used to reconcile the central inventory ledger.

Schema

Event Details

  • Zones: Each physical zone reports its own stock levels per SKU, including damaged and reserved units
  • Count Confidence: Indicates whether counts are system-calculated or verified by physical counts
  • Sequence Number: Monotonically increasing per warehouse so consumers can detect missed snapshots
Event-driven architecture documentation: Acme Inc

WarehouseStockSnapshot Schema

18 fields
Package:com.ecommerce.inventory.warehouse(proto3)
Message:StockLevel

The stock position of a single SKU within one warehouse zone.

on_handint64= 1

Units physically present in the zone

reservedint64= 2

Units allocated to open orders

damagedint64= 3

Units present but not sellable

in_transit_inboundint64= 4

Units expected from inbound purchase orders

confidenceCountConfidence= 5
Allowed values: COUNT_CONFIDENCE_UNSPECIFIED SYSTEM_CALCULATED CYCLE_COUNTED FULL_AUDIT
last_counted_atstring= 6

RFC 3339 timestamp of the last physical count

Message:Zone

A physical zone within the warehouse, e.g. a pick face or bulk storage area.

zone_idstring= 1

e.g. "PICK-A-03"

descriptionstring= 2
utilisation_percentdouble= 3

How full the zone is, 0-100

stock_by_skumap<string, StockLevel>= 4

Stock levels for each SKU stored in this zone, keyed by SKU code.

Message:WarehouseStockSnapshot

A periodic snapshot of stock positions across an entire warehouse. Published every 15 minutes by the warehouse management system and used to reconcile the central inventory ledger.

snapshot_idstring= 1
warehouse_idstring= 2

e.g. "WH-BER-01"

regionstring= 3
zonesrepeated Zone= 4

All zones included in this snapshot

totals_by_skumap<string, int64>= 5

Aggregate totals per SKU across all zones, keyed by SKU code.

labelsmap<string, string>= 6

Free-form labels attached by the warehouse management system, e.g. "wms_version" -> "4.2.1".

sequence_numberuint32= 7

Monotonically increasing per warehouse

captured_atstring= 8

When the snapshot was taken
Edit this page