1. Implementing Buying Experience
  2. Integrate with Order Management

Integrate with Order Management

For Buying Experience to receive updates on orders submitted to the Order Management (OM) system for fulfillment, ensure that your order management system publishes the following events to the Buying listeners:

  • ProductOrderAttributeValueChangeEvent: Use this event to send updates specific to order items, such as the order status change or milestone updates. Ensure that this event is published to the following listener: /orchestrationProductOrderingManagement/listener/productOrderAttributeValueChangeEvent. The payload for this event is similar to the TMF 622 ProductOrderAttributeValueChangeEvent API.

  • ProductOrderStateChangeEvent: Use this event to send state changes at the order-header level, such as order completion or order cancellation. Ensure that this event is published to the following listener: /orchestrationProductOrderingManagement/listener/productOrderStateChangeEvent. The payload for this event is similar to the TMF 622 ProductOrderStateChangeEvent API.

  • CancelProductOrderStateChangeEvent: Use this event to send updates specific to Order Cancel, such as is order eligible for canceling. Ensure that this event is published to the following listener: /orchestrationProductOrderingManagement/listener/cancelProductOrderStateChangeEvent.

    • When you raise a request to cancel order and it is in in-progress state and eligible for cancellation then Buying will generate "CancelProductOrderCreateEvent" which will be consumed by OM system and when OM generates CancelProductOrderStateChangeEvent with in-progress, then buying will move Order state to "Assessing Cancellation" by consuming that event. After receiving "CancelProductOrderStateChangeEvent" from Orchestration with "Done" state , Buying will change the Order state to "Pending Cancellation" and if the event state is "TerminatedWithError" then it moves Order state back to "in-progress".

  • CancelProductOrderStateChangeEvent: Use this event to send updates specific to Order Cancel, such as is order eligible for canceling. Ensure that this event is published to the following listener: /orchestrationProductOrderingManagement/listener/cancelProductOrderStateChangeEvent.

    • When you raise a request to cancel order and it is in in-progress state and eligible for cancellation then Buying will generate "CancelProductOrderCreateEvent" which will be consumed by OM system and when OM generates CancelProductOrderStateChangeEvent with in-progress, then Buying will move order state to "Assessing Cancellation" by consuming that event. After receiving "CancelProductOrderStateChangeEvent" from orchestration with "Done" state, Buying will change the order state to "Pending Cancellation" and if the event state is "TerminatedWithError" then it moves order state back to "in-progress".

Related Topics