v2 Download XML Specification

Order Download XML Specification & Format

Order <order>

Name	Format	Description

Name	Format	Description
customerOrderId	Long Integer	Unique customer order number as shown to the customer in their Fruugo Account.
orderId	Long Integer	Unique order number as shown in Fruugo Retailer Portal.
orderDate	Date Time	Time when customer placed the order.
orderReleaseDate	Date Time	Time when order available for the retailer.
orderStatus	Enumeration of valid statuses	Possible values:- PENDING: New order that hasn't been processed PROCESSED: At least part of the order has been processed EXCEPTION: There's an error or manual correction related to the order and it cannot be processed through the Order API
customerLanguageCode	String	Language of the Customer.
shippingAddress	shippingAddress - element	The address where the order is to be shipped
shippingMethod	String	Human readable shipping method name. Expected values - Standard Shipping and Express Shipping.
shippingCostInclVAT	Decimal	Amount of shipping cost charged from customer including VAT.
shippingCostVAT	Decimal	Amount of VAT that is included in the shipping cost.
orderLineItems	List of orderLine - elements	Collection of orderLineItem elements
fruugoTax	Boolean	Identifies whether Fruugo is responsible for collecting and has collected tax on the order
fruugoTaxID	String	The relevant Fruugo tax ID for the order and customs declaration. If Fruugo has collected the tax on the order.
fruugoEORI	String	The Fruugo EORI (Economic Operators Registration and Identification number) for customs declaration. If Fruugo has collected the tax on the order.

Shipping Address <shippingAddress>

Each order has exactly one shipping address

Name	Format	Description

Name	Format	Description
firstName	String	First name of the customer
lastName	String	Last name of the customer
streetAddress	String	Street address, multiple lines separated by linefeeds
city	String	City
province	String	County or province
postalCode	String	Postal code
countryCode	String	Country
phoneNumber	String	Customer's phone number in the international format
emailAddress	String	Fruugo routed email address for the customer (optional).

Line Item <orderLine>

There's a line item for each unique SKU in the order

Name	Format	Description

Name	Format	Description
productId	String	Product id from retailers product information feed.
skuId	String	SKU id from retailers product information feed (if retailer didn't provide SKU id , this is the same as product id).
skuName	String	SKU name from retailers product information feed.
attributes	List of attribute elements	SKU attributes from retailers product information feed.
fruugoProductId	Long Integer	Fruugo's internal Product id.
fruugoSkuId	Long Integer	Fruugo’s internal Sku id.
currencyCode	String	Currency of the retailer.
itemPriceInclVat	Decimal	Price of a single item in retailer's currency.
itemVat	Decimal	Amount of VAT for a single item in retailer's currency.
totalpriceInclVat	Decimal	Total price charged from the customer in retailer's currency.
totalVat	Decimal	Total VAT amount charged from the customer in retailer's currency.
customer	List of customer elements	The customers local item pricing
vatPercentage	Decimal	Percentage of VAT charged from the customer.
totalNumberOfItems	Integer	Total number of items ordered of this Sku.
pendingItems	Integer	Number of pending items.
confirmedItems	Integer	Number of confirmed items.
shippedItems	Integer	Number of shipped items.
cancelledItems	Integer	Number of cancelled items.
returnAnnouncedItems	Integer	Number of items customer will return.
returnedItems	Integer	Number of items customer has returned.
itemsWithException	Integer	Number of items that are in an error state or have been manually corrected.
returnedDate	Date Time	Time of returning the product.

Attribute <attribute>

Attribute elements (in the Attributes collection) list the attributes of the Sku that the retailer provided with the Sku.

Name	Format	Description

Name	Format	Description
attributeName	String	Name of attribute (for example "Colour", "Size" or "Age group").
attributeValue	String	Value of attribute (for example "Red", "XXL" or "3-7 years").

Customer <customer>

Customer elements (in the Customer collection) list the item pricing information charged to the customer in their domestic locale for the retailers customs declarations.

Name	Format	Description

Name	Format	Description
customerItemPriceExcVat	Float	Price excluding VAT for a single item in the customer currency
customerItemVat	Float	VAT amount for a single item in the customer currency
totalCustomerPriceExcVat	Float	Total price excluding VAT in the customer currency
totalCustomerVat	Float	Total VAT amount charged in the customer currency
customerCurrency	String	The currency of the order for the customer

Shipment <shipment>

Shipment element appears when at least part of the order has been shipped.

Name	Format	Description

Name	Format	Description
shipmentId	Long Integer	The id of the shipment. It may be used to download the packing list.
shippingDate	Date Time	Date and time of the shipment.
shipmentLines	List of shipmentLine - elements	Items that were included in the shipment.

ShipmentLine <shipmentLine>

There’s a line item for each unique SKU in the order. Shipment line is analogous to the orderLine, but only contains basic identifying information about the shipped SKU to avoid repetition.

Name	Format	Description

Name	Format	Description
fruugoProductId	Long Integer	Fruugo's internal Product id
fruugoSkuId	Long Integer	Fruugo’s internal Sku id.
skuName	String	SKU name from retailers product information feed.
quantity	Integer	Number of items shipped in this shipment.