Product XML
Sample File for Products
You can download a sample file here.
Fields
If any of the nodes are missing, the file cannot be imported. An exception to that rule are child products. A missing node in a child product will result in the property being derived from the parent product. An empty node in a child product on the other hand will overwrite the property with an empty value.
If the value in a node that doesn’t allow empty values is invalid, the product cannot be imported. However, an invalid value in an “allow empty” field is ignored and the product will still be imported.
Generally, the more information we receive, the better the product can be displayed in our mobile shop, and the higher the conversion rate.
File encoding must be UTF-8!
Node | Attributes | Allow empty | Description | Example |
---|---|---|---|---|
item
|
uid |
✕ |
Unique ID
|
5 |
name
|
✕ |
Product name |
Example Product |
|
tax_percent
|
⚑ |
Tax percent
|
19 |
|
tax_class
|
⚑ |
Tax class
|
19% DE |
|
currency
|
✕ |
Currency
|
EUR |
|
description
|
✔ |
Product description
|
With your high-resolution micro-speakers that deliver full-range audio, the ergonomic ... |
|
deeplink
|
✔ |
Deeplink
|
http://shop.com/ipod-touch-32gb.html |
|
promotion
|
sort_order |
✔ |
Promotion sort order; smallest value displayed first |
3 |
internal_order_info
|
✔ |
Internal order info
|
..... |
|
age_rating
|
✔ |
Enter the items age classification. |
18 |
|
weight
|
unit |
✔ |
set the weight (units g, lb, kg and oz). Default g |
25 |
prices
|
type |
✔ |
set the price type (net / gross) if nothing is set, gross is default |
gross |
price
|
⚑ |
This price is the basic price without any discounts. If price is not set sale_price needs to be set. |
19.99 |
|
sale_price
|
⚑ |
This price is the price a customer has to pay (e.g. with discounts). If sales_price is not set price needs to be set. If sale_price is cheaper than price, price becomes the 'was price' and sale_price will be used as item price. |
15.99 |
|
cost
|
✔ |
This is the price a merchant has to pay (purchase price). |
11.21 |
|
msrp
|
✔ |
Manufacturer’s suggested retail price. Default 0
|
22.00 |
|
minimum_order_amount
|
✔ |
Minimum order amount. Default 0 (For example: Product price is 1 cent but only if you your order is at least $50) |
25.00 |
|
base_price
|
✔ |
The base price is a price per unit. This value needs to be set e.g. for food. |
10.00 € / kg |
|
tier_prices
|
✔ |
set the tier price items |
||
tier_price
|
|
|
|
|
_value
|
✕ |
value for the tier price. Fixed discount or percentage discount. Relative to the item's price (sale_price if cheaper than price) |
12.00 |
|
images
|
✔ |
set the images items |
||
image
|
sort_order |
✔ |
sort order of the image; smallest value displayed first |
2 |
url
|
✕ |
Image Url |
||
categories
|
✕ |
set the categories items |
||
category
|
|
|
|
|
shipping
|
✔ |
Shipping costs for the product if specific ones exist. |
||
costs_per_order
|
✔ |
costs per order
|
5.99 |
|
additional_costs_per_unit
|
✔ |
additional costs per unit
|
2.99 |
|
is_free
|
✔ |
is free shipping
|
0 |
|
manufacturer
|
✕ |
Set manufacturer details |
||
title
|
✔ |
set the manufacturer name |
Apple |
|
item_number
|
✔ |
external item number |
apple_123 |
|
visibility
|
|
|
0: Item will only be shown in the app
|
|
properties
|
✔ |
|||
property
|
uid |
✔ |
Property UID. If no ID provided the property cannot be used for sorting / filter. |
463 |
label
|
✕ |
Label of the property |
Megapixels |
|
value
|
✕ |
Value could also contain HTML |
8 |
|
stock
|
✕ |
|||
is_saleable
|
✔ |
1 if the product is saleable. Default 0 |
1 |
|
use_stock
|
✔ |
Product uses stock? Default 0 (no inventory management) |
1 |
|
stock_quantity
|
✔ |
Stock quantity. Default 0 |
5 |
|
minimum_order_quantity
|
✔ |
The minimum order quantity that must be ordered at least. |
1 |
|
maximum_order_quantity
|
✔ |
The maximum order quantity that can be ordered. |
500 |
|
availability_text
|
✔ |
Availability text |
2-3 business |
|
identifiers
|
✔ |
|||
identifier
|
|
|
|
10
|
_value
|
12345678 |
|||
tags
|
✔ |
Tags are indexed, which allows searching for products by tags. | ||
tag
|
✕ |
Product Tag |
car |
|
relations
|
✔ |
|||
relation
|
type |
✕ |
Indicate additional relations to the product
|
upsell |
uid
|
✕ |
Product ID for the relation |
122 |
|
label
|
⚑ |
Required if type = custom |
users_also_buy |
|
attribute_groups parent
parent product only
|
✔ |
|||
attribute_group
|
uid |
✕ |
attribute group id |
80 |
inputs
|
✔ |
|||
input
|
|
|
|
|
label
|
✕ |
Label for the input |
PC Tower case color |
|
info_text
|
✔ |
Info text shown in a question mark |
The tower color will be specially made for you |
|
options
|
✔ |
|||
option
|
|
|
|
|
label
|
✕ |
Option Label |
Color |
|
display_type parent product only |
✔ |
display type explanation can be seen below. |
list |
|
children
|
Make sure this node is the last node for every item.
|
|||
attributes
|
group_uid |
✕ |
refers to the uid of the corresponding attribute_group at parent product |
80 |
Details for Product Export
Input Types
- text
- select
Input Sort Order
If sort_order attribute is given inputs will be displayed on the page in this order. Lowest value first. If sort order is missing the sequence in the xml file will be used instead.
Note: at the moment it is not possible to mix input fields with select boxes. Select boxes will always be displayed first on the page.
Display Type
- default
- simple
- select
- list: The display type is a special form of displaying products in relations like parent child. For example: You sell a t-shirt in different colors and sizes. Therefore you need a select field with color and one with size. Display type will be “select” If you sell a the black one in S on a special deal for example, it gets default display type to be able to show in the drop down as option and as single product. The System decides which will be the correct way up on request If you sell a couch, for example, with options to order several pieces from the middle, corners and so on, display type would be list. This way the user is able to set different amounts for sub products on a single page and put them all directly in the cart.
Customer Group for Tier prices
To use tier prices, you need to export the customer groups in get_settings. Each customer group needs to have unique ID and a name as well as a default flag ( 0 or 1) and a tax class.