XML Order Export

Availability
Sample
Notes

Availability

The XML order export is available at:

http://sitename.ugal.com/x/orders/list.xml?auth=token

Where:

sitename is the UGAL name of the website.
token is an authentication token provided by UGAL.

Notes:

A maximum of 20 orders is returned per request.
The list of orders returned is ordered by ascending ID.
The additional start URL parameter (numeric) can be passed to specify the first order ID to be returned.

Sample

<result>
	<status>ok</status>
	<message>1 orders</message>
	<orders>
		<order>
			<id>130920</id>
			<date>2010-03-18@20-07-45</date>
			<status>new</status>
			<contact>
				<email>joe@email.com</email>
				<phone>01.23.45.67.89</phone>
			</contact>
			<shipto>
				<firstname>Joe</firstname>
				<lastname>Doe</lastname>
				<address>1, avenue des Xhamps Elysées</address>
				<city>Paris</city>
				<state/>
				<zip>75008</zip>
				<country>fr</country>
			</shipto>
			<billto>
				<firstname>Joe</firstname>
				<lastname>Doe</lastname>
				<address>1, avenue des Xhamps Elysées</address>
				<city>Paris</city>
				<state/>
				<zip>75008</zip>
				<country>fr</country>
			</billto>
			<paystatus>notPaid</paystatus>
			<paymenttype>noPayment</paymenttype>
			<taxtype>vat</taxtype>
			<shipcalctype>orderAmount</shipcalctype>
			<currency>eur</currency>
			<promocode/>
			<amount>
				<part>7.00</part>
				<ship>2.00</ship>
				<discount>0.00</discount>
				<salestax>0.00</salestax>
			</amount>
			<vat>
				<part>1.15</part>
				<ship>0.33</ship>
				<discount>0.00</discount>
			</vat>
			<lines>
				<line>
					<quantity>1</quantity>
					<item>
						<id>131009</id>
						<reference>131009</reference>
						<name>Car en sac (En vrac 1 kg)</name>
						<productid>2409</productid>
						<catalogid>4599</catalogid>
					</item>
					<amount>
						<part>7.00</part>
						<ship>2.00</ship>	
					</amount>
					<vat>
						<part>1.15</part>
						<ship>0.33</ship>
					</vat>
					<vatrate>
						<part>0.196</part>
						<ship>0.196</ship>
					</vatrate>
				</line>
			</lines>
		</order>
	</orders>
</result>

Notes

Element	Description
result.status	Status of the request. In {success,error}.
result.orders.order.id	Sequential order ID. Unique per website.
result.orders.order.date	Date and time the order was placed. Expressed in the website timezone.
result.orders.order.paystatus	In {notPaid,paid}
result.orders.order.paymenttype	In {noPayment,paypal,ogone}
result.orders.order.taxtype	Type of tax (Sales Tax or Value Added Tax) applied. In {vat,sat}
result.orders.order.shipcalctype	Shipping charges calculation method. In {byProduct,orderPercent,orderAmount}
result.orders.order.currency	In {eur,usd}
result.orders.order.amount	Amounts expressed in sub elements include all taxes (sat or vat)
result.orders.order.lines.line.code	Not always available - needs fix
result.orders.order.lines.line.amount	Amounts expressed in sub elements are per unit.
result.orders.order.lines.line.vat	Amounts expressed in sub elements are per unit.