Authorization


Registration   Forgot password?

Object fields

Below you can see the description of the fields of various objects the information on which you can receive as XML. There are three such objects:
Manufacturer
Category
Product

- If the field name is put in angle brackets then this field is presented as an embedded tag in XML.
- If the name of the field is given simply without any angle brackets, that is as field_name it means that this field is presented as the attribute of the main tag in XML.
Object text data are presented as embedded tags (such data as names, descriptions and so on). At that all such data are presented as CDATA. The rest fields (such as price, quantity) appear as attributes.
- If the field is marked by a star * then it means that this field is an optional one, that is it can be absent. The fields that are not marked by the star are always present, but nevertheless some of them can be empty.

<manufacturer> - Manufacturer
 ID - unique identifier. Integer.
 <name> - name
 <description>* - description of the manufacturer
 url - manufacturer's web-address

  <image>* - manufacturer's image
   src - image url
   width - image width in pixels
   height - image height in pixels
   size - image file size (in bytes)

<category> - products category
 ID - unique indentifier. Integer.
 parentID - parent category identifier.
 order - prioroty. Integer. The smaller the number is - the higher is the priority.
 <name> - brief name
 <title> - full name. Often corresponds to the brief one.
 <comment>* - brief category description
 <description>* - full category description
 <meta_title>* - text for the TITLE tag in HTML
 <meta_keywords>* - keywords to be inserted into the meta-tags
 <meta_description>* - description to be inserted into the meta-tags

<image>* - image
src - image url
width - image width in pixels
height - image height in pixels
size - image file size (in bytes)

<categories>* - embedded categories (or subcategories)
count - number of subcategories
<categoro> - category

<products>* - products directly in this category
count - number of products
<product> - product (described below)
Attention: One and the same product (recognized by the equal ID) can appear several times in different categories. Take it into account at data exporting. Namely either put this product to several categories as well into your system if your system supports it or ignore the next product entry into the category after the first one if your system doesn't support this option.

<product> - Product
ID - unique identifier. Integer.
categoryID - parent category identifier.
order - priority. Integer. The smaller the number is - the higher is the priority.
<name> - product name
<comment>* - brief product description
<description>* - full product description
time_available - time in unix-timestamp (that is in seconds from the beginning of 1970) when the product will be available
in_stock - availability. 0 or 1.
is_new - indicates that the product is new. 0 or 1.
price - product price (primary).

opt1 - minimal quantity for small wholesales (if it equals 0 then there are no wholesales provided).
price1 - product price for small wholesales.
opt2 - minimal quantity for large wholesales (if it equals 0 then there are no wholesales provided).
price2 - product price for large wholesales.


spec_type* - special product type. Can be Specials (discounts) or Featured (seasonal products and so on).
spec_time1* - low time bound in unix-timestamp when this product has the specified special type. If it equals 0 - then there are no limitations from this side
spec_time2* - high time bound in unix-timestamp when this product has the specified special type. If it equals 0 - then there are no limitations from this side
spec_price* - main price for this period.
spec_price1* - small wholesale price for this period. If it equals zero then there are no wholesales.
spec_price2* - large wholesale price for this period. If it equals zero then there are no wholesales.
Despite the seasonality or discounts these three prices may not be different from the basic ones - then spec_price will equal 0 and it will be necessary to take the basic prices for all these three prices.

If you don't want or it is just difficult to you you can spend no time on wholesale prices. Just check by type and time distance whether the product is now a "special" one and if the answer is yes + if the special price doesn't equal 0 then this price is taken, otherwise - the basic price (but at that the product is all the same shown (if you want it) in blocks Specials and Featured if they are present in your site)

quantity - quantity in stock.
num_choosed - number such of purchased products. To be used in top.
manufacturer - manufacturer's ID.
<model>* - product model
<upc_code>* - UPC
<ean_code>* - EAN
url - product official page webaddress
weight - product weight
<measure>* - units (e. g. sacks, kilogramms, ...)
<dimensions>* - sizes
attributed* - sign saying that the product has attributes. Equals 1 if there are some attributes. If there are no attributes - this parameter is absent.
Attributes - are product features which the customer should choose when ordering the product (for example, colour). Details on how to work with them you can read here
You may not export the attributes themselves to your site, but this parameter will always unambiguously indicate by its presence whether the given product has any attributes.

<meta_title>* - text for the TITLE tag in HTML
<meta_keywords>* - keywords to be inserted into the meta-tags
<meta_description>* - description to be inserted into the meta-tags
<image1>* - image.
Attention: There can only be up to 6 images. Instead of number 1 there will be numbers from 1 to 6 (image1, image2,..., image6). At that they can not necessarily go succesively (that is there can be only numbers 1 and 6 present and the others may not exist at all).
1 - small image, 2 - middle, 3 - large, 4-6 - additional
src - image url
width - image width in pixels
height - image height in pixels
size - image file size (in bytes)

<document1>* - additional documents to the product (for example, instructions, schemes...).
Attention: There can be up to 3 documents. Instead of number 1 there will be numbers from 1 to 3 (document1, document2, document3). At that they can not necessarily go succesively (that is there can be only number 3 present and numbers 1 and 2 may not exist at all).
name - document name
src - document url
size - document file size (in bytes)


<attributes>* - product attributes available to be chosen by the customer
<attribute> - attribute (can be a lot of them)
id - attribute identifier - integer value is always bigger then 0 type - attribute type - integer value from 0 to 2
There are 3 attribute types:
0 - attribute obligatory selected by the customer (in the selection form is usually presented as select-elements or radiobuttons).
1 - optional attribute - that is the one that is not obligatory. (in the selection form is usually presented as select-elements or radiobuttons).
2 - multiple choice attribute (that is either several items can be selected or not a sigle item at all :) (in the selection form is presented only as checkboxes).
<name> - attribute name
<code> - attribute's unique code - string up to 50 chars (used instead of id)
<description>* - attribute description

<options>* - the present attribute options
<option> - option (there can be a lot of them)
id - option identifier - integer number from 0 (inclusive) and higher
<name> - option name
<code> - option's unique code - string up to 50 chars (used instead of id)
price* - option price (can be absent then it equals 0).
Can be both positive and negative - is added to the product price
weight* - option weight (can be absent then equals 0).
Can be both positive and negative - is added to the product weight
<question>* - additional question.
Should be asked when the customer selects this option
Contact Us Legal and Policies Sitemap
© XMLShop.com 2004 – 2018