Update Inventory (v0.0.1)

Command that will update a given inventory item

Command

Overview

The UpdateInventory command is issued to update the existing stock levels of a product in inventory. In most cases this command is not issued by consumers directly but by other services while they are processing events.

Architecture diagram

accepts
Update Inventory
v0.0.1Command
Inventory
v0.0.1Service
Key
  • Event
  • Service
  • Command
React Flow
Open in Visualiser →

Payload example

Payload example
{
  "sku": "PRODABC123",
  "quantityChange": -10,
  "timestamp": "2024-07-04T14:48:00Z"
}

Schema (JSON schema)

sku
string
required

The stock keeping unit ID of the product inventory being updated

quantityChange
integer
required

The change in quantity of the product in the inventory. Positive values indicate an increase, while negative values indicate a decrease.

notes
string

Optional notes regarding this inventory change

timestamp
string<date-time>
required

The date and time when the inventory update occurred.