This is an old revision of the document!


UpdateOrderStatusRs (Response)

Posting a proper UpdateOrderStatusRs request will result in the output of the updated information in a simple print format (read with stdin). The UpdateOrderStatusRs is the response to the UpdateOrderStatusRq request and contains the status and details for the updated / modified orders. Please note that the “Status” tag is placed inside each order's node. If there is an error in any of the order's status updates, the remaining orders will still get processed. The Status of your request will be shown for each order separately. In addition, if you are sending tracking information for an order, you will also receive a separate status tag for the tracking number insertion, as show in the sample code below:

Sample Response:

<?xml version="1.0" ?>
<F3XML>
<F3XMLRs>
<UpdateOrderStatusRs RequestID="1">
	<Order>
		<OrderID>32863</OrderID>
		<Status>OK</Status>
		<OrderStatus>shipped</OrderStatus>
		<Tracking>
			<TrackingNumber>1Z557142263589</TrackingNumber>
			<Carrier>UPS</Carrier>
			<F3BoxID>18874</F3BoxID>
			<Status>OK</Status>
		</Tracking>
		<Tracking>
			<TrackingNumber>1Z557142263590</TrackingNumber>
			<Carrier>UPS</Carrier>
			<F3BoxID>18875</F3BoxID>
			<Status>OK</Status>
		</Tracking>
	</Order>
	<Order>
		<OrderID>32854</OrderID>
		<Status>OK</Status>
		<OrderStatus>voided</OrderStatus>
	</Order>
	<Order>
		<OrderID>32901</OrderID>
		<Status>OK</Status>
		<OrderStatus>backorder</OrderStatus>
	</Order>
	<Order>
		<OrderID>32913</OrderID>
		<Status>OK</Status>
		<OrderStatus>partialship</OrderStatus>
		<Tracking>
			<TrackingNumber>1Z557145872471</TrackingNumber>
			<Status>Error</Status>
			<ErrorDescription>The F3 Box ID "18874" has not been found in the database.</ErrorDescription>
		</Tracking>
	</Order>
	<Order>
		<OrderID>55558774441</OrderID>
		<Status>Error</Status>
		<ErrorDescription>The Order "55558774441" was not found in the database.</ErrorDescription>
	</Order>
</UpdateOrderStatusRs>
</F3XMLRs>
</F3XML>

Response Fields

Tag Name Sub-Tag Of Description Returned Field Type Can Repeat
Order UpdateOrderStatusRs Each Order's response Node Always Node True
OrderID Order The Fortune3 Order ID of the Current Order Always Integer False
Status Order The status for order's change request Always String
*OK
*Error
False
ErrorDescription Order Describes an error with the update Only if Error String False
OrderStatus Order Returns the order's status after the update Only if no Error String False
Tracking Order Node for each Tracking Number Send Only if Tracking Node sent Node True
Status Tracking The status of the tracking number insert Only if Tracking Node sent String
*OK
*Error
False
ErrorDescription Tracking Shows any errors when inserting a tracking number Only if Error in Tracking Number insert String False
TrackingNumber Tracking The Tracking Number sent Only when “Tracking” Node is sent. String False
Carrier Tracking The shipping carrier the tracking number belongs to Only when “Tracking” Node is sent and no error exists. String False
F3BoxID Tracking The Fortune3 Box ID the tracking number has been assigned to Only when “Tracking” Node is sent and no error exists. Integer False
Print/export