Catalogue of Products

If you wish to receive a complete product catalogue please open the following file:

products.php

Legend:
<element> – optional elements
param – required parameters
param – optional parameters

API Request:

OST /API/products.php?api_id=id&api_key=key HTTP/1.1
Host: www.shopxml.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

id=product_id&...

(all the possible parameters of request can be found below)

API Response:

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8" ?> 
<objects>
  <product id="product_id" active="0|1" priority="integer" categories="category_id[,...]"
      time_available="unix_timestamp" date_available="YYYY-MM-DD" in_stock="0|1" is_new="0|1"
      price="decimal" opt1="integer" price1="decimal" opt2="integer" price2="decimal"
      price_type="0|1|2" spec_time1="unix_timestamp" spec_date1="YYYY-MM-DD"
      spec_time2="unix_timestamp" spec_date2="YYYY-MM-DD"
      spec_price="decimal" spec_price1="decimal" spec_price2="decimal"
      quantity="integer" num_choosed="integer" mnfID="manufacturer_id" url="url" weight="decimal">
    <name>string</name>
    <comment>string</comment>
    <description>string</description>
    <upc_code>string</upc_code>
    <ean_code>string</ean_code>
    <code>string</code>
    <model>string</model>
    <measure>string</measure>
    <dimensions>string</dimensions>
    <meta_title>string</meta_title>
    <meta_keywords>string</meta_keywords>
    <meta_description>string</meta_description>
    <image1 src="url" width="integer" height="integer" size="integer" />
    <image2 src="url" width="integer" height="integer" size="integer" />
    <image3 src="url" width="integer" height="integer" size="integer" />
    <image4 src="url" width="integer" height="integer" size="integer" />
    <image5 src="url" width="integer" height="integer" size="integer" />
    <image6 src="url" width="integer" height="integer" size="integer" />
    <document1 name="string" src="url" size="integer" />
    <document2 name="string" src="url" size="integer" />
    <document3 name="string" src="url" size="integer" />
    <attributes>
      <attribute type="0|1|2|3">
        <code>string</code>
        <name>string</name>
        <description>string</description>
        <attr_min_length>string</attr_min_length>
        <attr_max_length>string</attr_max_length>
        <options>
          <option price="decimal" weight="decimal" quantity="integer">
            <code>string</code>
            <name>string</name>
          </option>
        </options>
      </attribute>
      ...
    </attributes>
    <attr_cobinations>
      <attr_cobination price="decimal" weight="decimal" quantity="integer">
        <definition>attribute_code#option_code[ ...]</definition>
      </attr_cobination>
      ...
    </attr_cobinations>
    <additional_fields>
      <additional_field id="string" type="string|text|checkbox|select|multiple" name="string">
        <value id="value_id" value="string" />
        ...
      </additional_field>
      ...
    </additional_fields>
  </product>
  ...
</objects>

Request parameters (not essential to use unless specified):

id - product ID. To chose multiple items its ID must be separated with commas or transmit this parameter in the array format (id[])
catID - ID of the product category. To chose multiple items its ID must be separated with commas or transmit this parameter in the array format (catID[])
active - 0 (only negative) or 1 (represents only active). Shall be transmitted only if it is desired to be sorted accordingly to this parameter.
in_stock - 0 (only unavailable products) or 1 (available). Shall be transmitted only if it is desired to be sorted accordingly to this parameter.
is_new - indicates if the product is new and identified as 1, if it is not, then identified as 0.Shall be transmitted only if it is desired to be sorted accordingly to this parameter
price_type - indicates the price type 0 for primary, 1 (special) and 2 (featured). Shall be transmitted only if it is desired to be sorted accordingly to this parameter.
min_price - minimal price
max_price - maximal price
have_image - 0 (contains no image) or 1 (contains image). Shall be transmitted only if it is desired to be sorted accordingly to this parameter.
have_attributes - 0 (no attributes) or 1 (only with attributes). Shall be transmitted only if it is desired to be sorted accordingly to this parameter.
name - name. This parameter will pick up everything that contains same symbols in the transmitted string.
keyword - keyword in the description that picks up all items that include the same symbols in its parameter's string.
exc_field[] - fields to be excluded. The following fields can be excluded: name, comment, description, model, measure, dimensions, image1 - image6, document1 - document3, meta_title, meta_keywords, meta_description, attributes, attr_combinations, add_fields

Response parameters:

Information about search items (manufacturers) appears in XML format in the response field as following:

<objects> - external container

<product> - manufacturer (repetitive)

id – unique identification. Integer number.
active - activity either 0 or 1
priority - priority. Integer numbers that run from 0 to 255, the lower number specifies the higher priority.
categories - the list of categories where particular product location
<name> - product name
<comment>* - brief product description
<description>* - complete product description
time_available - time reflected by UNIX_TIMESTAMP (indicated in seconds starting from 1970) designating product availability.
date_available - date in YYYY-MM-DD format, designating product availability
in_stock - availability. 0 or 1.
is_new - indicates if the product is new. 0 or 1
price - product price (primary).
opt1 - minimal quantity for retail sales (0 indicates none)
price1 - retail product price
opt2 - minimal quantity for whole sales (0 indicates none)
price2 - whole sale product price
price_type* - product type. 0- indicates unavailability of primary product, 1- special product (discounted), 2 – featured (seasonal products)
spec_time1* - indicates beginning time point in UNIX-TIMESTAMP when certain product marked as featured. 0 – indicates no limits
spec_date1* - beginning time point in YYYY-MM-DD format when particular product is featured. Analog of spec_time1.
spec_time2* - highest time point reflected in UNIX-TIMESTAMP when particular product has certain feature. 0 – indicates no limits.
spec_date2* - highest time bound in YYYY-MM-DD format when particular product has certain feature. Analog of spec_time2.
spec_price* - the base price for the current period. 0- indicates equivalent of a primary price.
spec_price1* - the retail price for the current period. 0- indicates unavailability.
spec_price2* - the whole sale price for the current period. 0 – indicates unavailability.
quantity - availability of the products at the warehouse. 1000000 indicates no limits.
num_choosed - the number of the products purchased. Should be used in the top.
mnfID - manufacturer ID. 0 – indicates undefined manufacturer.
<upc_code>* - UPC product code (universal product code)
<ean_code>* - EAN product code (European Article Number)
<code>* - internal product code
<model>* - product model
url* - web address of primary product location
weight - product weight
<measure>* - units (e.g. kilograms, containers)
<dimensions>* - size
<meta_keywords>* - keywords to be inserted into the meta-tags
<meta_description>* - description to be inserted into the meta-tags
<image1>* - image
ATTENTION: There could be up to 6 image files, therefore instead of 1 it would be outlined as from 1 to 6 (e.g. image1, image2, ..., image6), does not have to be in the orderly manner (e.g. might be 1 and 6 and not include the rest)
1 - small sized image file, 2 - medium sized, 3 - large, 4-6 - additional

scr - image URL address
width - image resolution in pixels (width)
height - image resolution in pixels (height)
size - image file size (bytes)

<document1>* - additional product documentation (e.g. manuals, schemes e.t.c.)
ATTENTION: There could be up to 3 documents. In this case instead of 1 it will be reflected from 1 to 3 (e.g. document1, document2, document3) and not essentially in its numerical order (for example, only 3 and 1, where 2 is not included at all).

name - document name
scr - document URL location
size - file size (bytes)

<attributes>* - product attributes that are available to the customer

<attribute> - attribute (numerous)

<code> - certain attribute code - unique string within particular product
type - attribute type which is an integer number runs from 0 to 3. There are 4 types of attributes: 0 – mandatory attribute selected by the customer; 1 – optional attribute; 2 - multiple choice attribute; 3 – text field that is completed by the customer at the purchase.
<name> - attribute name
<description>* - attribute description
<min_length>* - minimal length of the text input set for the attribute type 3 (see above). If such is non existent or equals to 0 – it excludes the necessity of being completed by the customer
<max_length>* - maximal length of the text input for the type 3 attribute.
<options>* - options for the current attribute (type 0-2 attributes)

<option> - option (multiple)

<code> - code for this particular option which is a unique string within this attribute.
<name> - option name
price* - option price (nonexistent equals 0) in case it is positive or negative it will be included into the total product price.
weight* - option weight (nonexistent equals 0) in case it is positive or negative it will included into the total product weight.
quantity* - product availability with this particular option (non-existent indicates unlimited availability).

<attr_combinations>* - product attribute combinations available to the customer.

<attr_combination> - attribute combination (multiple)

<definition> - definition of each attribute combination listed with space after each pair e.g. attribute_code#option_code, that sets the attribute code (only 0 or 1 type) and its option code separated by # symbol. E.g. “color#gold size#xl”.
price* - price of this particular combination (non-existent equals 0), negative or positive is included into the product cost.
weight* - combination weight (non-existent equals 0), negative or positive is included into the total product weight.
quantity* - product availability with this particular combination (non-existent indicates unlimited availability).

<additional_fields>* - additional fields for this particular product from outnumbered product database.

<additional_field> - additional field (multiple)

id - field identification (code) string e.g. add_field_color, add_field_material
type - field type. Possible values: string – indicates the text field capacity up to 255 symbols, text – field – an actual text up to 65K, checkbox – value possibility is 1/0 that is similar to Yes/No, select - field contains single value among many, multiple – is any number of values among all possible ones indicated for this particular field.
name - field name
<value> - field value (repetitive in case of the field being marked as multiple)

id - value identifier is an integer number. Exists only if type = select or multiple.
value - value