====== UpdateOrderStatusRq (Request) ======

The UpdateOrderStatusRq request allows users to update order statuses and assign tracking numbers to existing orders in the Fortune3 database. It can be used to update a single orders's status or multiple orders at the same time within 1 request. 

===== Updating Order Statuses =====

In order to update an order's status you will need to provide an Order ID (so the system knows which order to update), and a Status tag for each order. The Order ID must already exist in the store's database and exactly match the OrderID being sent in order for the update to succeed. Proceed as Follows:

**Sample Code** (updating inventory for a single item):

<code>
<sendRequestXML>
<authenticate>
<APIUsername>TWmY6WBft</APIUsername>
<APIPassword>SKW8ssAmDu6xTGDl</APIPassword>
</authenticate>
<UpdateOrderStatusRq RequestID="1">
	<Order>
		<OrderID>32863</OrderID>
		<OrderStatus>shipped</OrderStatus>
		<Tracking>
			<TrackingNumber>1Z557142263589</TrackingNumber>
			<Carrier>UPS</Carrier>
		</Tracking>
	</Order>
</UpdateOrderStatusRq>
</sendRequestXML>
</code>

===== Multiple Updates within 1 Request =====

In order to send multiple order status updates within the same request, simply repeat the <Order> node for every order you want to update, as the following sample code shows:

<code>
<sendRequestXML>
<authenticate>
<APIUsername>TWmY6WBft</APIUsername>
<APIPassword>SKW8ssAmDu6xTGDl</APIPassword>
</authenticate>
<UpdateOrderStatusRq RequestID="1">
	<Order>
		<OrderID>32863</OrderID>
		<OrderStatus>shipped</OrderStatus>
		<Tracking>
			<TrackingNumber>1Z557142263589</TrackingNumber>
			<Carrier>UPS</Carrier>
		</Tracking>
	</Order>
	<Order>
		<OrderID>32854</OrderID>
		<OrderStatus>voided</OrderStatus>
	</Order>
	<Order>
		<OrderID>32901</OrderID>
		<OrderStatus>backorder</OrderStatus>
	</Order>
	<Order>
		<OrderID>32913</OrderID>
		<OrderStatus>partialship</OrderStatus>
		<Tracking>
			<TrackingNumber>1Z557145872471</TrackingNumber>
			<Carrier>UPS</Carrier>
			<F3BoxID>18874</F3BoxID>
		</Tracking>
		<Tracking>
			<TrackingNumber>4888751126874</TrackingNumber>
			<Carrier>USPS</Carrier>
			<F3BoxID>18875</F3BoxID>
		</Tracking>
	</Order>
</UpdateOrderStatusRq>
</sendRequestXML>
</code>

===== The "Tracking" Node =====

You may only sending Tracking Nodes when you are changing the Order Status to shipped or partialship. Other status changes will not accept tracking numbers to be assigned to the order.

^ Tag Name ^ Sub-Tag Of ^ Description                      ^ Field Type ^ Is Required ^
| Order | UpdateOrderStatusRq | Each Order's Node | Node | True |
| OrderID | Order | The Order ID for the order you want to update. Must match existing Fortune3 Order ID in store. | Integer | True |
| OrderStatus | Order | The new Status for the order  | String \\ Allowed Values: \\ "shipped" \\ "partialship" \\ "backorder" \\ "receivepay" \\ "delivered" \\ "voided" | True |
| Tracking | Order | Node for each Tracking Number  | Node | False - Can only be sent when OrderStatus is "shipped" or "partialship" |
| TrackingNumber | Tracking | The Tracking Number for the Order  | String | Only when "Tracking" Node is sent. |
| Carrier | Tracking | The shipping carrier the tracking number belongs to  | String \\ Allowed Values: \\ "UPS" \\ "USPS" \\ "FedEx" \\ "DHL" \\ "CANPOST" \\ "AUSPOST" \\ "NZPOST" | False |
| F3BoxID | Tracking | The Fortune3 Box ID to assign the tracking number to. You can retrieve the F3BoxID's for any order by using the [[OrderStatusQueryRq|OrderStatusQueryRq]] or [[OrderQueryRq|OrderQueryRq]] requests.  | Integer | False - If not sent, the system will update the tracking number on any available box for the order. |

Next: [[UpdateOrderStatusRs|Reading the Response (UpdateOrderStatusRs)]]