Sign in
inventory

Ingest inventory snapshot or delta batch

Validates a batch of inventory items and publishes them to Kafka for asynchronous processing. The discriminator field "updateType" (SNAPSHOT|DELTA) at the root selects the validation schema and the resulting event type. SNAPSHOT overwrites the position (onHand, blocked, safetyStock); DELTA increments or decrements onHand. Returns 202 with a correlation id shared by every published event of the batch.

post/api/v1/inventory

Request body

OR

Example request

{
  "items": [
    {
      "blocked": 5,
      "onHand": 150,
      "safetyStock": 10,
      "sku": "SKU-001",
      "strategyCode": "loja-barra"
    }
  ],
  "updateType": "SNAPSHOT"
}

Response

Batch accepted and published to Kafka.

acceptednumber required

Number of items accepted and published to Kafka (always equals items.length on 202).

correlation_idstring required

Batch correlation id (UUID) shared by every published event.

update_type'SNAPSHOT' | 'DELTA' required

Update mode of the accepted batch.

Example response

{
  "accepted": 150,
  "correlation_id": "8f2a3b1c-7d6e-4f5a-9b8c-1d2e3f4a5b6c",
  "update_type": "SNAPSHOT"
}

Changes