Submit Order

This operation accepts an order for submission to the order management system and returns the order ID and order reference to the calling application.

  • If the order is being submitted for the first time, do not specify the Order ID in the input. A value is generated internally.
  • If the order is an amendment to a previously submitted order, orderRef must be specified.
  • If orderRef is not specified, a value is generated and returned to the calling application. This value is always generated whether the order passed validation or not.
Note:
  • For SOAP over JMS Web services, the length of orderRef should be less than or equal to 100 characters.
  • If the router configuration is selected as filteringRouter, then submitOrder must have a UDF with UDF Name as "Orchestrator" in the order header. This information is required to evaluate the Orchestrator engine type in the filteringRouter. For example: 
      <ns0:header xmlns:ns0="http://www.tibco.com/aff/order">
                   <ns0:customerID>CUSTOMERID</ns0:customerID>
                   <ord1:udf>
                      <ord1:name>Orchestrator</ord1:name>
                      <ord1:value>IPC</ord1:value>
                   </ord1:udf>
          </ns0:header>

Optionally, the orders submitted into the system can be validated before being sent for further processing. This validation can be enabled by setting the flag com.tibco.af.oms.enableOfferValidation to true.

The request message format is:


SubmitOrderRequest

Submit Order Request Data Model
Element Name Element Type Description
orderRequest orderRequestType

(Mandatory)

Order data structure. Data model for Order is defined in XSD (refer section Common Data Format Specifications).
ExternalBusinessTransactionID String Transaction ID sent by client.

The reply message format is:

SubmitOrderReply

Submit 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

(Optional)

Order ID generated by the order manager (OMS). If the order fails validation, this is omitted.
orderRef String

(Optional)

Client order reference.
Note: If the submitOrder request does not contain either orderID or orderRef element, then OMS generates the orderRef and returns the same in the submitOrder response.