Events – Order

This page provides the list of events and associated payloads for the Order microservice.

List of Events

SL.#	Name	Description	Publish Location	Routing Key	Durability	Payload Type
1	Order Created	This event will be triggered when an order is created.	Topic: ecomm	order.created	FALSE	Notification
2	Order Canceled	This event is triggered when the user cancels the order or order items.	Topic: ecomm	order.cancelled	FALSE	Notification
3	Order Deleted	This event will be triggered when an order is deleted.	Topic: ecomm	order.deleted	FALSE	Notification
4	Order to Inventory	Event to publish the inventory to block the item in the inventory. When the order's inventory has to be blocked, this event will be called.	Queue: inventory.bulktransactions	Inventory check event	FALSE	InventoryBulkTransaction
5	Order to Promotion	Event to publish the promotion to the block or apply operations for the applied promotions in the order. When the order's promotions have to be blocked, a block promotion event is sent. When the order's promotion has to be assigned, an assign promotion event is sent.	Queue: promotion.block/assign	Promotion check event	FALSE	PromotionBulkTransaction
6	Order to Payment	Event to publish the payment to charge, refund, or authorize the payment. When the order has to be authorized with the payment given by the user, either charge for the order or refund the amount to the user if the order is canceled, deleted or returned.	Queue: payment.bulkTransactionRequestQueue	Payment check event	FALSE	PaymentBulkTransaction
7	Order Return	This event will be triggered when an order or order item return is accepted.	Topic:ecomm	order.return	FALSE	Notification
8	Order Shipped	This event will be triggered when an order is shipped.	Topic:ecomm	order.shipped	FALSE	Notification
9	Check Fraud	This event will be triggered when a fraud check is performed.	Topic: OmsMsgTopic	order.checkfraud	FALSE	CheckFraud
10	Preprocess Inventory	This event will be triggered to show the process on the inventory block when an order is created or updated.	Topic: OmsMsgTopic	order.preprocessinventory	FALSE	PreProcessInventory
11	Preprocess Payment	This event will be triggered to show the processing on the payment block when an order is created or updated.	Topic: OmsMsgTopic	order.preprocesspayment	FALSE	PreProcessPayment
12	Preprocess Promotion	This event will be triggered to show the process on the promotion block when an order is created or updated.	Topic: OmsMsgTopic	order.preprocesspromotion	FALSE	PreProcessPromotion
13	Order Return Submitted	This event will be triggered, when an order or order item return is submitted.	Topic:ecomm	order.return.submitted	FALSE	Notification
14	Undo Preprocess Inventory	This event will be triggered when undo a preprocessing of inventory in an order.	Topic: OmsMsgTopic	order.undopreprocessinventory	FALSE	PreProcessInventory
15	Undo Preprocess Payment	This event will be triggered when undo a preprocessing of the payment in an order.	Topic: OmsMsgTopic	order.undopreprocesspayment	FALSE	PreProcessPayment
16	Update Shipment	This event will be triggered when shipment status is updated.	Topic: OmsMsgTopic	order.updateshipment	FALSE	OrderDelegate
17	Create Exchange Order	This event is triggered when an exchange order is created.	Topic:ecomm	order.exchange	FALSE	Notification
18	Create Replace Order	This event is triggered when a replace order is created.	Topic:ecomm	order.replace	FALSE	Notification

List of Fat Events 

When order patch is done to change the order status, the fat events override the existing thin events. Below are the properties that are processed for the fat events: 

• For information on the event payload, refer to Order Event Payload With and Without Fat Event.
• For information on the plugin that is used to send the fat event, refer to marketplaces-oms-plugin. 

Payload Models

Below are the payloads for the Order microservice events.