v2 Download XML Specification

Order Download XML Specification & Format

Order <order>

NameFormatDescription
customerOrderIdLong IntegerUnique customer order number as shown to the customer in their Fruugo Account.
orderIdLong Integer

Unique order number as shown in Fruugo Retailer Portal.

orderDateDate TimeTime when customer placed the order.
orderReleaseDateDate TimeTime when order available for the retailer.
orderStatusEnumeration 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

customerLanguageCodeStringLanguage of the Customer.
shippingAddressshippingAddress - elementThe address where the order is to be shipped
shippingMethodStringHuman readable shipping method name. Expected values - Standard Shipping and Express Shipping.
shippingCostInclVATDecimalAmount of shipping cost charged from customer including VAT.
shippingCostVATDecimalAmount of VAT that is included in the shipping cost.
orderLineItemsList of orderLine - elementsCollection of orderLineItem elements
fruugoTaxBooleanIdentifies whether Fruugo is responsible for collecting and has collected tax on the order
fruugoTaxIDStringThe relevant Fruugo tax ID for the order and customs declaration. If Fruugo has collected the tax on the order.
fruugoEORIStringThe 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

NameFormatDescription
firstNameString

First name of the customer

lastNameString

Last name of the customer

streetAddressString

Street address, multiple lines separated by linefeeds

cityStringCity
provinceStringCounty or province
postalCodeStringPostal code
countryCodeStringCountry
phoneNumberStringCustomer's phone number in the international format
emailAddressStringFruugo routed email address for the customer (optional).

Line Item <orderLine>

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

NameFormatDescription
productIdString

Product id from retailers product information feed.

skuIdString

SKU id from retailers product information feed (if retailer didn't provide SKU id , this is the same as product id).

skuNameString

SKU name from retailers product information feed.

attributesList of attribute elements

SKU attributes from retailers product information feed.

fruugoProductIdLong IntegerFruugo's internal Product id.
fruugoSkuIdLong IntegerFruugo’s internal Sku id.
currencyCodeStringCurrency of the retailer.
itemPriceInclVatDecimalPrice of a single item in retailer's currency.
itemVatDecimal

Amount of VAT for a single item in retailer's currency.

totalpriceInclVatDecimal

Total price charged from the customer in retailer's currency.

totalVatDecimal

Total VAT amount charged from the customer in retailer's currency.

customerList of customer elementsThe customers local item pricing
vatPercentageDecimal

Percentage of VAT charged from the customer.

totalNumberOfItemsInteger

Total number of items ordered of this Sku.

pendingItemsInteger

Number of pending items.

confirmedItemsInteger

Number of confirmed items.

shippedItemsInteger

Number of shipped items.

cancelledItemsInteger

Number of cancelled items.

returnAnnouncedItemsInteger

Number of items customer will return.

returnedItemsInteger

Number of items customer has returned.

itemsWithExceptionIntegerNumber of items that are in an error state or have been manually corrected.
returnedDateDate TimeTime 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.

NameFormatDescription
attributeNameStringName of attribute (for example "Colour", "Size" or "Age group").
attributeValueString

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.

NameFormatDescription
customerItemPriceExcVatFloatPrice excluding VAT for a single item in the customer currency
customerItemVatFloatVAT amount for a single item in the customer currency
totalCustomerPriceExcVatFloatTotal price excluding VAT in the customer currency
totalCustomerVatFloat

Total VAT amount charged in the customer currency

customerCurrencyStringThe currency of the order for the customer

Shipment <shipment>

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

NameFormatDescription
shipmentIdLong Integer

The id of the shipment. It may be used to download the packing list.

shippingDateDate Time

Date and time of the shipment.

shipmentLinesList of shipmentLine - elementsItems 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.

NameFormatDescription
fruugoProductIdLong IntegerFruugo's internal Product id
fruugoSkuIdLong IntegerFruugo’s internal Sku id.
skuNameStringSKU name from retailers product information feed.
quantityIntegerNumber of items shipped in this shipment.