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:



Perform Bulk Order Action Request Data Model
Element Name Element Type Description
businessTransactionID String Transaction ID sent by client.
action String Name of the bulk actions to perform:
  • CANCEL
  • SUSPEND
  • RESUME
  • WITHDRAW
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 OMS UI, OMS server, and Orchestrator logs.

The response message format is:



Perform Bulk Order Action Response Data Model
Element Name Element Type Description
businessTransactionID String Transaction ID sent by client.
timestamp dateTime Date and time when OMS receives a bulk order request.
message String

(Optional)

request 		Message indicating successful request submission.
noOfOrders Integer

(Optional)

Number of orders in the request.