Cancel Order

This operation cancels the specified order in the orchestration engine. The order must be previously submitted successfully and exist in the orchestration engine database. This function extracts the original order and resubmits it as an amendment with all order line actions set to CANCEL.

The request message format is:

Cancel Order Request Data Model
Element Name Element Type

Description

ExternalBusinessTransactionID String Transaction ID sent by client.
orderID String

(Mandatory, Choice)

The ID of the Order generated by OMS. This must be an exact match.
orderRef String

(Mandatory, Choice)

The client order reference ID. This must be an exact match.
rollback Boolean

(Optional)

Flag to indicate if the order is to be rolled back.

The reply message format is:

Cancel Order Response Data Model
Element Name Element Type Description
ExternalBusinessTransactionID String Transaction ID sent by client.
BusinessTransactionID String Transaction ID generated by OMS, and used internally by OMS and Orchestrator.
orderID String

(Mandatory, Choice)

The ID of the Order generated by OMS. This must be an exact match.
orderRef String

(Mandatory, Choice)

The client order reference ID. This must be an exact match.
message String Interactive message sent to client confirming request processing.