public interface CSROrderProcessCmd
extends ToolsControllerCommand

Process an order on behalf of the customer.

Behavior

• If the process is creating order(finish action in the Place Order wizard): First, this command will do the adjustments by calling CSROrderAdustmentUpdateCmd if applicable. Second this command will process the pending order(s) and complete the order(s) by calling OrderProcessCmd, finally add comments.
• If the process is editing old order(ok button in the Change order notebook): First, this command will do the order prepare by calling CSROrderPrepareCmd if it's needed. Second this command will process the order and complete the original Order by calling OrderProcessCmd, finally add comments and delete the backup order.

Parameters

XML

An input xml_string that contains all required data for creating the new order on behalf of the customer.

 Example xml_string:
        <?xml version="1.0" encoding "UTF-8">
        <order>
                <customerId>20000</customerId>
                <originatorId>1000</originatorId>
                <comment>
                        <value>This is a comment.</value>
                        <sendEmail>true</sendEmail>
                        <emailAddress>abc@mail.com</emailAddress>
                </comment>
                <firstOrder>
                        <id>10001</id>
                        <billingAddressId>10001</billingAddressId>
                        <dirtyBit>true</dirtyBit>
                        <totalShipping>
                                <value>0.0</value>
                        </totalShipping>
                        <totalAdjustment>
                                <value>0.0</value>
                        </totalAdjustment>
                        <couponIds>
                                <value>20.0</value>
                        </couponIds>
                        <payment>++
                                <policyId>200</policyId>
                                <paymentTCId>34</paymentTCId>
                                <description>Credit Card(Offline) - VISA</description>
                                <buyPageInfo>StandardCreditCard</buyPageInfo>
                                <cardBrand>VISA</cardBrand>
                                <cardNumber>2222222222</cardNumber>
                                <cardExpiryMonth>2002</cardExpiryMonth>
                                <cardExpiryYear>2002</cardExpiryYear>
                        </payment>
                </firstOrder>
                <secondOrder>
                        <id>10002</id>
                        <billingAddressId>10001</billingAddressId>
                        <dirtyBit>false</dirtyBit>
                        <totalShipping>
                                <value>0.0</value>
                        </totalShipping>
                        <totalAdjustment>
                                <value>0.0</value>
                        </totalAdjustment>
                        <couponIds>
                                <value>20.0</value>
                        </couponIds>
                        <payment>
                                <policyId>200</policyId>
                                <paymentTCId>34</paymentTCId>
                                <description>Credit Card(Offline) - VISA</description>
                                <buyPageInfo>StandardCreditCard</buyPageInfo>
                                <cardBrand>VISA</cardBrand>
                                <cardNumber>2222222222</cardNumber>
                                <cardExpiryMonth>2002</cardExpiryMonth>
                                <cardExpiryYear>2002</cardExpiryYear>
                        </payment>
                </secondOrder>
        </order>
        <editOrderInfo>true</editOrderInfo>
        </xml>
 

NOTE: payment object tags will vary depending on the payment method selected.

URL

The URL to be called when the command completes successfully.

Response Parameter:

None.

Exception Conditions

It throws all the exceptions that the OrderProcessCmd will throw.

Error View:

• NotebookNavigation if it is editing old order.
• WizardNavigation if it is placing an order.