Perform Bulk Order Action
This service can be used to perform the following operations on multiple orders (Order IDs, orderRef):
- CANCEL
- SUSPEND
- RESUME
- WITHDRAW
Only one type of bulk action can be performed on multiple orders in a single request.
The request message format is:
Element Name | Element Type | Description |
---|---|---|
businessTransactionID | String | Transaction ID sent by client. |
action | String | Name of the bulk actions to perform:
|
orderID | String
(Optional) |
List of order IDs on which bulk operations are to be performed. |
orderRef | String
(Optional) |
List of order references on which bulk operations are to be performed. |
A response in the form of an acknowledgment is returned asynchronously indicating the successful submission of request. The status of the bulk process can be tracked through Order Management Server UI, Order Management Server, and Orchestrator logs.
The response message format is:
Element Name | Element Type | Description |
---|---|---|
businessTransactionID | String | Transaction ID sent by client. |
timestamp | dateTime | Date and time when Order Management Server receives a bulk order request. |
message | String
(Optional) request |
Message indicating successful request submission. |
noOfOrders | Integer
(Optional) |
Number of orders in the request. |