Amend Order

An existing order can be modified by using the amend order web service. If the order reference already exists in Order Management Server, then it accepts the amend order request.

The request message format is:


Amend Order Request

The following table explains elements defined in request schema.

Amend 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 response message format is:


Amend Order Response

The following table explains the elements defined in the response schema.

Amend Order Response Data Model
Element Name Element Type Description
ExternalBusinessTransactionID String Transaction ID sent by client.
BusinessTransactionID String Transaction ID generated by Order Management Server and used internally by Order Management Server and Orchestrator.
orderID String

(Optional)

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

(Optional)

Client order reference.