This section provides the list of events and payloads of the Inventory microservice.
Page Contents
List of Events
Below is the list of events of the Inventory microservice:
SL.# | Name | Description | Publish Location | Routing Key | Durability | Payload Type |
---|---|---|---|---|---|---|
1 | Bin Created | This event will be generated when a new bin is created. | Topic: ecomm | inventory.bin.created | false | InventoryBinPayload |
2 | Bin Updated | This event will be generated when a bin is updated. | Topic: ecomm | inventory.bin.updated | false | InventoryBinPayload |
3 | Bin Deleted | This event will be generated when a bin is deleted. | Topic: ecomm | inventory.bin.deleted | false | InventoryBinPayload |
4 | BinItem Created | This event will be generated when a new bin item is created. | Topic: ecomm | inventory.binitem.created | false | InventoryBinItemPayload |
5 | BinItem Updated | This event will be generated when a bin item is updated. | Topic: ecomm | inventory.binitem.updated | false | InventoryBinItemPayload |
6 | Transaction Created | This event will be generated when a new transaction is created. | Topic: ecomm | inventory.transaction.created | false | InventoryTransactionPayload |
7 | Transaction Updated | This event will be generated when a transaction is updated. | Topic: ecomm | inventory.transaction.updated | false | InventoryTransactionPayload |
8 | Bulk Transaction Listener | This queue listener looks for events with inventory transaction requests in bulk, processes them, and posts the response into the replyto queue. | Queue: inventory.bulktransactions | n/a | true | BulkTransactionPayload |
Payload Models
Below is the list of payloads for the Inventory microservice events:
InventoryBinPayload
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
eventName | string | Indicates the generated event name. | BIN_CREATED |
bin.binName | string | Indicates the name of the bin on which the event is generated. | newbin1 |
InventoryBinItemPayload
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
eventName | string | Indicates the generated event name. | BINITEM_CREATED |
binItem.binName | string | Indicates the name of the bin on which the event is generated. | newbin1 |
binItem.binItemId | long | Indicates the unique ID of the bin item. | 123 |
binItem.skuId | string | Indicates the unique ID of a SKU in the bin. | SKU1 |
binItem.displayStatus | string | Defines availability status of the bin item. | IN STOCK |
InventoryTransactionPayload
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
eventName | string | Indicates the generated event name. | TRANSACTION_CREATED |
transaction.transactionId | long | Indicates the unique ID of the transaction. | 123 |
transaction.binItemId | long | Indicates the unique ID of the bin item on which this transaction is done. | 123 |
transaction.transactionType | integer | Indicates the type of the transaction. The possible types are: 0 – NONE, 1 – ADD, 2 – REMOVE, 3 – TRANSFER, or 4 – RECONCILE. | 1 |
BulkTransactionPayload
PROPERTY | TYPE | DESCRIPTION | EXAMPLE |
---|---|---|---|
allOrNone | boolean | Indicates whether the operation to be committed (only if all transactions are successful) or not. | true |
binItems[].binName | string | Indicates the bin name on which the transaction to be executed. | atpbin1 |
binItems[].skuId | string | Indicates the SKU ID of the bin item on which the transaction to be executed. | sku1 |
binItems[].transaction.id | long | Indicates the READONLY field that returns the ID of the executed transaction. | 121 |
binItems[].transaction.binItemId | long | Indicates READONLY field that returns the bin item ID on which the transaction is executed. | 232 |
binItems[].transaction.type | integer | Indicates the type of the transaction. The possible transaction types are: 1 – ADD, 2 – REMOVE, 3 – TRANSFER, 4 – or RECONCILE. | 1 |
binItems[].transaction.status | integer | Indicates the status of the transaction. The transaction statuses are: 1 – Active or 0 – Inactive. | 1 |
binItems[].transaction.fromBinName | string | Indicates 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.toBinName | string | Indicates the name of the target bin, which is used for transferring of ATP or backorder quantities from the source bin. Null for other transaction types | bin2 |
binItems[].transaction.referenceId | string | Indicates the reference transaction ID of the TRANSFER type transaction. | abc123 |
binItems[].transaction.atpQty | integer | Indicates the quantity of the item to be added, removed, or transferred in atpQty. | 12 |
binItems[].transaction.backOrderedQty | integer | Indicates the quantity of the item to be added, removed, or transferred in backOrderedQty. | 12 |
binItems[].transaction.properties | string | Indicates the custom properties of the current transaction. | {“orderid” : “123”} |
binItems[].transaction.notes | string | Specifies 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.