Deprecated feature: Get Order

The GetOrder outbound service interface is used to retrieve order statuses from an external system.

Note: You are recommended to use the Order management system integration service interfaces.

Request

Request to this outbound service interface is in the form of a GetOrder business object document (BOD). The definition of the GetOrder BOD can be found in the XML schema file workspace_dir/WebServicesRouter/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/GetOrder.xsd. The service data object (SDO) interface of the GetOrder BOD is com.ibm.commerce.order.datatypes.GetOrderType.

Response

Response to a successful request is in the form of a ShowOrder BOD. The XML schema of the ShowOrder BOD can be found in the XML schema file workspace_dir/WebServicesRouter/xsd/OAGIS/9.0/Overlays/IBM/Commerce/BODs/ShowOrder.xsd. The service data object (SDO) interface of the ShowOrder BOD is com.ibm.commerce.order.datatypes.ShowOrderType.

Message type

This outbound service interface is mapped to the message type com.ibm.commerce.order.GetOrder, or com.ibm.commerce.order if the former is not defined.

Client task command

This outbound service interface can be invoked by calling the order client task command com.ibm.commerce.order.client.commands.GetOrderCmd with action GetOrder. Its default implementation, com.ibm.commerce.order.client.commands.GetOrderCmdImpl , behaves as follows:

  1. It first calls the protected method composeGetOrder() to compose a GetOrder SDO from the search criteria specified.
  2. It then passes the action and the GetOrder SDO to the order client facade implementation to make the outbound service request.

Usage scenarios

List order statuses

  1. To list the statuses of orders that are submitted by a shopper, the data bean manager activates the order client data bean com.ibm.commerce.order.client.beans.OrderStatusListDataBean .
  2. The corresponding data bean command com.ibm.commerce.order.client.commands.PopulateOrderStatusListDataBeanCmd is called to populate the data bean.
  3. The default implementation of this data bean command, com.ibm.commerce.order.client.commands.PopulateOrderStatusListDataBeanCmdImpl , calls the order client task command com.ibm.commerce.order.client.commands.GetOrderCmd with action GetOrder and the appropriate search criteria to retrieve statuses of orders that are already transferred to the external system.

Display order details

  1. To display the details of a submitted order, the data bean manager activates the order client data bean com.ibm.commerce.order.client.beans.OrderStatusDataBean .
  2. The corresponding data bean command com.ibm.commerce.order.client.commands.PopulateOrderStatusDataBeanCmd is called to populate the data bean.
  3. If the order is transferred to the external system, the default implementation of this data bean command, com.ibm.commerce.order.client.commands.PopulateOrderStatusListDataBeanCmdImpl , calls the order client task command com.ibm.commerce.order.client.commands.GetOrderCmd with action GetOrder and the appropriate search criteria to retrieve the details of the order from the external system.