Suspend Order

The Suspend Order operation suspends an existing order. This operation takes orderRef or orderId and sends a message to Fulfillment Order Management to suspend an order. This operation is asynchronous.

Element name: os:SuspendOrderRequest

The request message format is:

Suspend Order Request Data Model
Element Name Element Type Description
ExternalBusinessTransactionID String

(Optional)

This is an attribute which can be used by external systems to keep track of requests. Note that the value of this attribute is not stored anywhere in TIBCO Fulfillment Order Management, and it is just meant for use by external systems.
orderID String

(Mandatory, Choice)

The ID of the order generated by OMS. This must be an exact match.
orderRef String

(Mandatory, Choice)

The client order reference ID. This must be an exact match.

Element name: os:SuspendOrderResponse

The reply message format is:

Suspend Order Response Data Model
Element Name Element Type Description
ExternalBusinessTransactionID String

(Optional)

This is an attribute which can be used by external systems to keep track of requests. Note that the value of this attribute is not stored anywhere in TIBCO Fulfillment Order Management, and it is just meant for use by external systems.
orderID String

(Mandatory, Choice)

The ID of the order generated by OMS. This must be an exact match.
orderRef String

(Mandatory, Choice)

The client order reference ID. This must be an exact match.
message String Interactive message sent to client confirming request processing.