This section provides the list of events and payloads of the Inventory microservice.

List of Events

Below is the list of events of the Inventory microservice:

SL.#NameDescriptionPublish LocationRouting KeyDurabilityPayload Type
1Bin CreatedThis event will be generated when a new bin is created.Topic: ecomminventory.bin.createdfalseInventoryBinPayload
2Bin UpdatedThis event will be generated when a bin is updated.Topic: ecomminventory.bin.updatedfalseInventoryBinPayload
3Bin DeletedThis event will be generated when a bin is deleted.Topic: ecomminventory.bin.deletedfalseInventoryBinPayload
4BinItem CreatedThis event will be generated when a new bin item is created.Topic: ecomminventory.binitem.createdfalseInventoryBinItemPayload
5BinItem UpdatedThis event will be generated when a bin item is updated.Topic: ecomminventory.binitem.updatedfalseInventoryBinItemPayload
6Transaction CreatedThis event will be generated when a new transaction is created.Topic: ecomminventory.transaction.createdfalseInventoryTransactionPayload
7Transaction UpdatedThis event will be generated when a transaction is updated.Topic: ecomminventory.transaction.updatedfalseInventoryTransactionPayload
8Bulk Transaction ListenerThis queue listener looks for events with inventory transaction requests in bulk, processes them, and posts the response into the replyto queue.Queue: inventory.bulktransactionsn/atrueBulkTransactionPayload

Payload Models

Below is the list of payloads for the Inventory microservice events:

InventoryBinPayload

 
PROPERTYTYPEDESCRIPTIONEXAMPLE
eventNamestringIndicates the generated event name.BIN_CREATED
bin.binNamestringIndicates the name of the bin on which the event is generated.newbin1

InventoryBinItemPayload

 
PROPERTYTYPEDESCRIPTIONEXAMPLE
eventNamestringIndicates the generated event name.BINITEM_CREATED
binItem.binNamestringIndicates the name of the bin on which the event is generated.newbin1
binItem.binItemIdlongIndicates the unique ID of the bin item.123
binItem.skuIdstringIndicates the unique ID of a SKU in the bin.SKU1
binItem.displayStatusstringDefines availability status of the bin item.IN STOCK

InventoryTransactionPayload

 
PROPERTYTYPEDESCRIPTIONEXAMPLE
eventNamestringIndicates the generated event name.TRANSACTION_CREATED
transaction.transactionIdlongIndicates the unique ID of the transaction.123
transaction.binItemIdlongIndicates the unique ID of the bin item on which this transaction is done.123
transaction.transactionTypeintegerIndicates the type of the transaction. The possible types are: 0 – NONE, 1 – ADD, 2 – REMOVE, 3 – TRANSFER, or 4 – RECONCILE.1

BulkTransactionPayload

 
PROPERTYTYPEDESCRIPTIONEXAMPLE
allOrNonebooleanIndicates whether the operation to be committed (only if all transactions are successful) or not.true
binItems[].binNamestringIndicates the bin name on which the transaction to be executed.atpbin1
binItems[].skuIdstringIndicates the SKU ID of the bin item on which the transaction to be executed.sku1
binItems[].transaction.idlongIndicates the READONLY field that returns the ID of the executed transaction.121
binItems[].transaction.binItemIdlongIndicates READONLY field that returns the bin item ID on which the transaction is executed.232
binItems[].transaction.typeintegerIndicates the type of the transaction. The possible transaction types are: 1 – ADD, 2 – REMOVE, 3 – TRANSFER, 4 – or RECONCILE.1
binItems[].transaction.statusintegerIndicates the status of the transaction. The transaction statuses are: 1 – Active or 0 – Inactive.1
binItems[].transaction.fromBinNamestringIndicates the name of the source bin, which is used for transferring of ATP or backorder quantities from one bin item to another bin item. Null for other transaction types.bin1
binItems[].transaction.toBinNamestringIndicates the name of the target bin, which is used for transferring of ATP or backorder quantities from the source bin. Null for other transaction typesbin2
binItems[].transaction.referenceIdstringIndicates the reference transaction ID of the TRANSFER type transaction.abc123
binItems[].transaction.atpQtyintegerIndicates the quantity of the item to be added, removed, or transferred in atpQty.12
binItems[].transaction.backOrderedQtyintegerIndicates the quantity of the item to be added, removed, or transferred in backOrderedQty.12
binItems[].transaction.propertiesstringIndicates the custom properties of the current transaction.{“orderid” : “123”}
binItems[].transaction.notesstringSpecifies the information about the transaction.inventory blocked for order creation




Revision History
2019-05-13 | AN – List of events table updated.
2019-05-06 | PLK – Minor copyedit.
2019-04-11 | MA – Content updated for April 2019 release.
2019-01-23 | PLK – Content uploaded.