updateOrder()

void updateOrder(string orderNumber, Order order)

This method updates an unapproved order. Use this method if an operator or external system must provide additional information to process an order.

You cannot update an approved, complete or cancelled order.

Parameters

orderNumber: Format: string; Purpose: Specifies the number or other ID of the order to update.
order: Format: Order XML; Purpose: Defines an Order XML document that specifies the order data to update.

Example: Update an order

This example changes the ordered plan and billing address. Note that the Order XML document contains only the property to update.

<Order xmlns="http://xml.inomial.com/smile/2.xsd">			
  <PackagePlan>8</PackagePlan>			
  <OrderForm>			
    <Object>			
      <String name="billAddress">60 The Esplanade</String>			
      <String name="billSuburb">Melbourne</String>
      <String name="billState">VIC</String>
      <String name="billPostCode">3000</String>
      <String name="workPhone">+61355501256</String>
      <String name="emailAddress">demo@example.com</String>
    </Object>
  </OrderForm>
</Order>

Results

This method does not return any output. There are no messages defined by this method.

Faults

OrderException

This fault is returned when the order does not exist, you cannot update a specified field, the caller does not have permission to update the order or the order is approved, complete or cancelled. This fault is also returned when the <Order> element is not specified or is in the wrong namespace.

Java client syntax

java -cp build/smilewsv2-client.jar [options] com.inomial.smile.client.v2.examples.UpdateOrder orderNumber filename

orderNumber: Purpose: Specifies the number or other ID of the order to update.
filename: Purpose: Defines the filename of the Order XML document.

Note: For more information about the Java client and the options it accepts, see Java client syntax.