Get Order Details
This operation retrieves the order details for a given order ID or order reference and returns to the calling application.
The request message format is as follows:
Element Name | Element Type | Description |
---|---|---|
orderId | String
(Mandatory, Choice) |
The ID of the order generated by Order Management Server. This must be an exact match. |
orderRef | String
(Mandatory, Choice) |
The client order reference ID. This must be an exact match. |
externalBusinessTransactionId | String | Transaction ID sent by the client. |
includeOrderRequest | Boolean | This flag determines whether or not to include the original request in the response. |
includeAmendments | Boolean | This flag determines whether or not to include all the amendments for the order in the response. |
The reply message format is as follows:
Element Name | Element Type | Description | Example |
---|---|---|---|
orderType | orderType
(Optional) |
Order data structure. Data model for the order is defined in XSD (refer section Common Data Format Specifications). If the order is not found this element is omitted. |
Copyright © 2023. Cloud Software Group, Inc. All Rights Reserved.