APIs and Events¶
AIERP should document APIs and events together because one rarely makes sense without the other.
API Guidance¶
Document:
- request path
- tenant or store scope
- required identifiers
- response shape
- projection freshness expectations
Event Guidance¶
Document:
- event name
- producer
- consumer
- payload shape
- idempotency key
- replay expectations
Recommended Convention¶
- catalog changes emit catalog events
- inventory mutations emit stock or orderability events
- store lifecycle changes emit operational availability events