Principles

How sleekshop works.

Sleekshop is a cloudbased e-commerce platform which allows you to deploy e-commerce functionality via API into your projects no matter what kind of programming - language you want to use, or which devices you want to address. 

Sleekshop comes without a frontend, even tough there are SDKs which allow you simple testings. In our examples we use curl requests to simulate the requests and show the reponses of these. You can send requests with the shown attributes in your favorite language. 

There are two different formats the responses can be generated, JSON and XML. Depending on what kind of response you prefer you can change the format in the backend. 

Sleekshop has one endpoint which you can find in your backend in the administration -> API - section. So each request contains the request the authentification credentials (you find them also in you backend Administration -> API - section) and finally the attributes which you have to send to receive the desired response. 

On the right side you find an example - request which delivers the contents in the category specified by its id.


Arguments

  • id_category (int)

    The ID of the category you want to pull the data from.

  • needed_attributes (json-array)

    An array containing the attributes you want to pull. This can limit the size of the response.

  • language (string)

    A valid language code.


As mentioned there are always three mandatory arguments: 

  • licence_username
  • licence_password
  • request

To avoid repetitions we wont explain these three arguments in the following examples.

The above arguments explanation is in the format we will explain all coming requests. The name of the argument and its type in brackets. Under this you find an explanation.

Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_shopobjects_in_category' \ -d id_category=1 \ -d needed_attributes='[["name","price"],["variations"]]' \ -d language="de_DE"


Response

                    {"object":"shopobjects_in_category",
"category":{
"id":1,
"name":"Start",
"prio":1,
"id_parent":0,
"label":"Start",


"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
"attributes":{
   
   
   
}
},
"products":{
 
  "Schuh blau":
 
{
  "object":"product",
  "id":15,
  "name":"Schuh blau",
  "creation_date":"2016-03-25 14:17:46",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "blaue-laufschuhe-robust",
  "title": "Blaue Laufschuhe mit wasserdichter Oberfläche",
  "description": "Blaue Laufschuhe für Männer",
  "keywords": "blau,Schuhe,Laufschuhe"
}

,
  
"availability":
{
  "quantity": 5,
  "quantity_warning": 3,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":154,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":157,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
 }
}


  ,
   "Jacke rot M":
 
{
  "object":"product",
  "id":20,
  "name":"Jacke rot M",
  "creation_date":"2016-03-25 14:29:14",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "warme-herren-winterjacke",
  "title": "Superwarme und flauschige Winterjacke für Männer",
  "description": "Winterjacke für jedes Wetter!",
  "keywords": "warm,winter,maenner,jacke"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":229,
  "name":"name",
  "label":"Name",
  "value":"Winterjacke rot M"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":232,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
    
 }
}


  ,
   "Polar Jacket blau":
 
{
  "object":"product",
  "id":30,
  "name":"Polar Jacket blau",
  "creation_date":"2016-03-25 14:36:37",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "blaue-funktionsjacke-baumwolle",
  "title": "Damen Funktionsjacke aus BIO-Baumwolle",
  "description": "Blaue Funktionsjacke für Damen",
  "keywords": "damen,blau,bio,baumwolle,funktionsjacke"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":366,
  "name":"name",
  "label":"Name",
  "value":"Polar Jacket blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":369,
  "name":"price",
  "label":"Preis",
  "value":75
}


                
                                                                                                
    
  },
  "variations":{
  
    
 }
}


  ,
   "Mütze orange":
 
{
  "object":"product",
  "id":34,
  "name":"Mütze orange",
  "creation_date":"2016-03-25 16:19:24",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "muetze-orange-onesize",
  "title": "Trendige Mütze mit Aztekenmuster",
  "description": "Superwarme und flauschige Mütze",
  "keywords": "warm, flauschig, orange, muetze, aztekenmuster"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 2,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":422,
  "name":"name",
  "label":"Name",
  "value":"Mu00fctze orange"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":425,
  "name":"price",
  "label":"Preis",
  "value":17.5
}


                
                                                                                                
    
  },
  "variations":{
  
    
 }
}


  ,
   "Mütze schwarz":
 
{
  "object":"product",
  "id":36,
  "name":"Mütze schwarz",
  "creation_date":"2016-03-25 16:24:52",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "flauschiger-schneehut-schwarz",
  "title": "Superweicher schwarzer Schneehut",
  "description": "Warmer Schneehut der Trendmarke SchneeHut",
  "keywords": "schwarz, schneehut, weich, warm"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":23,
  "width":15,
  "height":26,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":452,
  "name":"name",
  "label":"Name",
  "value":" Schneehut schwarz"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":455,
  "name":"price",
  "label":"Preis",
  "value":18.9
}


                
                                                                                                
    
  },
  "variations":{
  
    
 }
}


  ,
   "Pullover S":
 
{
  "object":"product",
  "id":37,
  "name":"Pullover S",
  "creation_date":"2016-03-25 16:32:43",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "hunting-pullover-herren",
  "title": "Trendiger Hunting Herrenpullover",
  "description": "Pullover für Herren der Marke Hunting",
  "keywords": "hunting, robust, warm, dunkelgrau, herren"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":89,
  "width":34,
  "height":98,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":467,
  "name":"name",
  "label":"Name",
  "value":"Hunting Pullover S"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":470,
  "name":"price",
  "label":"Preis",
  "value":45
}


                
                                                                                
    
  },
  "variations":{
  
    
 }
}


  
 
},
"contents":{
  
    "Teaser 1":
  
{
  "object":"content",
  "id":5,
  "name":"Teaser 1",
  "creation_date":"2016-03-25 12:38:23",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":51,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":52,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
            
    ,                    "text":

{
  "type":"TXT",
  "id":53,
  "name":"text",
  "label":"Text",
  "value":""
}


                            
        
    
  },
  "variations":{
  
    
 }
}


    ,
      "Teaser 2":
  
{
  "object":"content",
  "id":6,
  "name":"Teaser 2",
  "creation_date":"2016-03-25 12:42:29",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":54,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/31aee733fa02a09e23c30e8af6dabd9e.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":55,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
            
    ,                    "text":

{
  "type":"TXT",
  "id":56,
  "name":"text",
  "label":"Text",
  "value":""
}


                            
        
    
  },
  "variations":{
  
    
 }
}


    ,
      "teaser 3":
  
{
  "object":"content",
  "id":7,
  "name":"teaser 3",
  "creation_date":"2016-03-25 12:44:19",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":57,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/396497fb5999ce6a8468f86bd0d98b45.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":58,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
            
    ,                    "text":

{
  "type":"TXT",
  "id":59,
  "name":"text",
  "label":"Text",
  "value":""
}


                            
        
    
  },
  "variations":{
  
    
 }
}


    

}
}

                    

Here we receive a json - object containing all shopobjects in the determined category.
                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<shopobjects_in_category>
<category>
<id>1</id>
<name>Start</name>
<prio>1</prio>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</category>
<products>
<product>
<id>15</id>
<name>Schuh blau</name>
<creation_date>2016-03-25 14:17:46</creation_date>
<class>colorprod</class>
<seo>
<permalink>blaue-laufschuhe-robust</permalink>
<title>Blaue Laufschuhe mit wasserdichter Oberfläche</title>
<description>Blaue Laufschuhe für Männer</description>
<keywords>blau,Schuhe,Laufschuhe</keywords>
</seo>

<availability>
<quantity>5</quantity>
<quantity_warning>3</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="154">
<name>name</name>
<label>Name</label>
<value>Laufschuh blau</value>
</attribute>

<attribute type="FLOAT" id="157">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>
</variations>
</product>

<product>
<id>20</id>
<name>Jacke rot M</name>
<creation_date>2016-03-25 14:29:14</creation_date>
<class>sizeprod</class>
<seo>
<permalink>warme-herren-winterjacke</permalink>
<title>Superwarme und flauschige Winterjacke für Männer</title>
<description>Winterjacke für jedes Wetter!</description>
<keywords>warm,winter,maenner,jacke</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="229">
<name>name</name>
<label>Name</label>
<value>Winterjacke rot M</value>
</attribute>

<attribute type="FLOAT" id="232">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>
</variations>
</product>

<product>
<id>30</id>
<name>Polar Jacket blau</name>
<creation_date>2016-03-25 14:36:37</creation_date>
<class>colorprod</class>
<seo>
<permalink>blaue-funktionsjacke-baumwolle</permalink>
<title>Damen Funktionsjacke aus BIO-Baumwolle</title>
<description>Blaue Funktionsjacke für Damen</description>
<keywords>damen,blau,bio,baumwolle,funktionsjacke</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="366">
<name>name</name>
<label>Name</label>
<value>Polar Jacket blau</value>
</attribute>

<attribute type="FLOAT" id="369">
<name>price</name>
<label>Preis</label>
<value>75</value>
</attribute>


</attributes>
<variations>
</variations>
</product>

<product>
<id>34</id>
<name>Mütze orange</name>
<creation_date>2016-03-25 16:19:24</creation_date>
<class>colorprod</class>
<seo>
<permalink>muetze-orange-onesize</permalink>
<title>Trendige Mütze mit Aztekenmuster</title>
<description>Superwarme und flauschige Mütze</description>
<keywords>warm, flauschig, orange, muetze, aztekenmuster</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>2</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="422">
<name>name</name>
<label>Name</label>
<value>Mütze orange</value>
</attribute>

<attribute type="FLOAT" id="425">
<name>price</name>
<label>Preis</label>
<value>17.5</value>
</attribute>


</attributes>
<variations>
</variations>
</product>

<product>
<id>36</id>
<name>Mütze schwarz</name>
<creation_date>2016-03-25 16:24:52</creation_date>
<class>colorprod</class>
<seo>
<permalink>flauschiger-schneehut-schwarz</permalink>
<title>Superweicher schwarzer Schneehut</title>
<description>Warmer Schneehut der Trendmarke SchneeHut</description>
<keywords>schwarz, schneehut, weich, warm</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>23</length>
<width>15</width>
<height>26</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="452">
<name>name</name>
<label>Name</label>
<value> Schneehut schwarz</value>
</attribute>

<attribute type="FLOAT" id="455">
<name>price</name>
<label>Preis</label>
<value>18.9</value>
</attribute>


</attributes>
<variations>
</variations>
</product>

<product>
<id>37</id>
<name>Pullover S</name>
<creation_date>2016-03-25 16:32:43</creation_date>
<class>sizeprod</class>
<seo>
<permalink>hunting-pullover-herren</permalink>
<title>Trendiger Hunting Herrenpullover</title>
<description>Pullover für Herren der Marke Hunting</description>
<keywords>hunting, robust, warm, dunkelgrau, herren</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>89</length>
<width>34</width>
<height>98</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="467">
<name>name</name>
<label>Name</label>
<value>Hunting Pullover S</value>
</attribute>

<attribute type="FLOAT" id="470">
<name>price</name>
<label>Preis</label>
<value>45</value>
</attribute>


</attributes>
<variations>
</variations>
</product>


</products>
<contents>
<content>
<id>5</id>
<name>Teaser 1</name>
<creation_date>2016-03-25 12:38:23</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>
<attribute type="IMG" id="51">
<name>img</name>
<label>Bild</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg</value>
<width>NAN</width>
<height>NAN</height>
</attribute>

<attribute type="CHAR" id="52">
<name>headline</name>
<label>Überschrift</label>
<value></value>
</attribute>

<attribute type="TXT" id="53">
<name>text</name>
<label>Text</label>
<value></value>
</attribute>


</attributes>
<variations>

</variations>
</content>

<content>
<id>6</id>
<name>Teaser 2</name>
<creation_date>2016-03-25 12:42:29</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>
<attribute type="IMG" id="54">
<name>img</name>
<label>Bild</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/31aee733fa02a09e23c30e8af6dabd9e.jpg</value>
<width>NAN</width>
<height>NAN</height>
</attribute>

<attribute type="CHAR" id="55">
<name>headline</name>
<label>Überschrift</label>
<value></value>
</attribute>

<attribute type="TXT" id="56">
<name>text</name>
<label>Text</label>
<value></value>
</attribute>


</attributes>
<variations>

</variations>
</content>

<content>
<id>7</id>
<name>teaser 3</name>
<creation_date>2016-03-25 12:44:19</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>
<attribute type="IMG" id="57">
<name>img</name>
<label>Bild</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/396497fb5999ce6a8468f86bd0d98b45.jpg</value>
<width>NAN</width>
<height>NAN</height>
</attribute>

<attribute type="CHAR" id="58">
<name>headline</name>
<label>Überschrift</label>
<value></value>
</attribute>

<attribute type="TXT" id="59">
<name>text</name>
<label>Text</label>
<value></value>
</attribute>


</attributes>
<variations>

</variations>
</content>


</contents>
</shopobjects_in_category>
                    

The corresponding xml response.

Explanation

This request returns the shopobjects in the category. 

This request has the following structure:

category This contains informations about the corresponding category.
products A section which contains the products in the category.
contents A section which contains all contents in this category.

Shopobjects

Objected oriented approach.

One of the most important structures provided by sleekshop is the flexible data - model an the classes covering them. Customers, products, warehouse - entities and content - elements are all shopobjects. Each shopobject is defined by classes in the backend. These classes contain attributes with different names, labels and datatypes.  So you can form every needed data - structure in the backend. After creation of these data structures the merchant can create objects out of the given classes with the desired attributes. 

These created objects can be referenced by the API like the example request.


Arguments

  • product (int)

    The ID of the product you want to pull the data from.

  • needed_attributes (json-array)

    An array containing the attributes you want to pull. This can limit the size of the response. Here we just pull the fields name and price and also want to hide the variations if there are some.

  • language (string)

    A valid language code.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_product_details' \ -d id_product=37 \ -d needed_attributes='[["name","price"],["variations"]]' \ -d language="de_DE"


Here the product with the 37 is requested.

Response

                    {
  "object":"product",
  "id":37,
  "name":"Pullover S",
  "creation_date":"2016-03-25 16:32:43",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "hunting-pullover-herren",
  "title": "Trendiger Hunting Herrenpullover",
  "description": "Pullover für Herren der Marke Hunting",
  "keywords": "hunting, robust, warm, dunkelgrau, herren"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":89,
  "width":34,
  "height":98,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":467,
  "name":"name",
  "label":"Name",
  "value":"Hunting Pullover S"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":470,
  "name":"price",
  "label":"Preis",
  "value":45
}


                
                                                                                
    
  },
  "variations":{
  
    
 }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<product>
<id>37</id>
<name>Pullover S</name>
<creation_date>2016-03-25 16:32:43</creation_date>
<class>sizeprod</class>
<seo>
<permalink>hunting-pullover-herren</permalink>
<title>Trendiger Hunting Herrenpullover</title>
<description>Pullover für Herren der Marke Hunting</description>
<keywords>hunting, robust, warm, dunkelgrau, herren</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>89</length>
<width>34</width>
<height>98</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="467">
<name>name</name>
<label>Name</label>
<value>Hunting Pullover S</value>
</attribute>

<attribute type="FLOAT" id="470">
<name>price</name>
<label>Preis</label>
<value>45</value>
</attribute>


</attributes>
<variations>
</variations>
</product>
                    

Explanation

This request returns the shopobject with the determined id: 37

This request has the following structure:

seo-block A SEO - Block containing all SEO - relevant data.
availability-block A block containing informations concerning the availability of the product.
metadata-block A block containing some metadata - stuff.
attributes-block A block containing all attributes selected by the query. Each attribute has a type, a name, a label and a value.

Process

Sleekshops e-commerce processing.

There are several steps a customer passes during a normal checkout in e-commerce. The following figure shows the steps.





Quickstart

Lets start with your first request.

First create your first class by clicking: Administration->Objects->Create a new class.

After this enter a name describing your class and, check the Checkbox "instanceable" and click on the button "Create class". The checkbox determines that the class can be used for creating new objects.

Now create some attributes by clicking on the "Create new attribute" button. 

A new row appears where you can add name, datatype and label for your attribute. 

Lets assume that you have created a instanceable object named test with the following attributes: 

  • name - int
  • short_description - txt
  • price - float

Close the window and click on the item "Products" in the menu. Then click on the green "plus - sign". Here you chose a name for your instance and the class you have created before.

The determined attributes appear. Make the product "shop active" edit the attributes in your favorite language and save the product.

On the right - hand side you see the id of the product. Lets pull the informations given for this product.

Therefore you can execute the given curl - request on the right - hand side. Remember to enter your ID.


Arguments

  • id_product (int)

    The ID of the product you want to pull the data from.

  • needed_attributes (json-array)

    An array containing the attributes you want to pull. This can limit the size of the response. Here we just pull the fields name and price and also want to hide the variations if there are some.

  • language (string)

    A valid language code.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Remember to use your api - credentials and your id_product.

Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_product_details' \ -d id_product=87 \ -d needed_attributes='[]' \ -d language="de_DE"


Here we pull the informations for the product with the id 87.

Response

                    {
  "object":"product",
  "id":87,
  "name":"testproduct",
  "creation_date":"2018-04-17 21:56:46",
  "class":"test",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":865,
  "name":"name",
  "label":"Name",
  "value":"test_name"
}


                                
            
    ,                    "short_description":

{
  "type":"TXT",
  "id":866,
  "name":"short_description",
  "label":"Kurzbeschreibung",
  "value":"here the short_description"
}


                            
            
    ,                                "price":

{
  "type":"FLOAT",
  "id":867,
  "name":"price",
  "label":"Preis",
  "value":12.9
}


                
        
    
  },
  "variations":{
  
    
    
 }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<product>
<id>87</id>
<name>testproduct</name>
<creation_date>2018-04-17 21:56:46</creation_date>
<class>test</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="865">
<name>name</name>
<label>Name</label>
<value>test_name</value>
</attribute>

<attribute type="TXT" id="866">
<name>short_description</name>
<label>Kurzbeschreibung</label>
<value>here the short_description</value>
</attribute>

<attribute type="FLOAT" id="867">
<name>price</name>
<label>Preis</label>
<value>12.9</value>
</attribute>


</attributes>
<variations>

</variations>
</product>
                    

Explanation

This request returns the shopobject with the determined id: 37

This request has the following structure:

seo-block A SEO - Block containing all SEO - relevant data.
availability-block A block containing informations concerning the availability of the product.
metadata-block A block containing some metadata - stuff.
attributes-block A block containing all attributes selected by the query. Each attribute has a type, a name, a label and a value.

Introduction

How sessions work and how they are used.

The sleekshop sessions are used to identify the user interacting with the frontend, which sends and receives data from the backend via API. Some functions doesn't need to identify the special user like get_products_in_category or similar functions. But a lot functions need session. If you add an item into your cart, the users cart is stored in the sleekshop - backend and you as an developer need to know to which visitor the cart belongs. Therefore we need sessions.

This sessions has to be stored on the frontend - side of the corresponding user, for instance in a cookie. 




get_new_session

Delivers a new session.


Arguments

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_new_session'


Response

                    {
  "object":"session",
  "creation_date":"2018-05-01 14:56:27",
  "expiration_date":"2018-05-02 14:56:27",
  "code":"15251865878APL58l9IgZJ79jZb5IS7kMCue0KdAIX"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<session>
<creation_date>2018-05-01 14:54:59</creation_date>
<expiration_date>2018-05-02 14:54:59</expiration_date>
<code>1525186499wNWsboMyoGHXHnjH7pcc3diRuMW3NYlt</code>
</session>
                    

Explanation

creation_dateDate of creation for the session.
expiration_dateDate of expiration for the session.
codeThe session code which has to be used for identifying this session.

get_categories

Delivers the categories with the parent defined by id.


Arguments

  • id_parent (int)

    The id of the parent category.

  • language (string)

    A valid language-code.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Each Category in the sleekshop backend has an unique id. This category can contain other categories beneath it.

For the language you have to use a valid language-code. Valid codes can be found here: language codes

Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_categories' \ -d id_parent=2 \ -d language='en_EN'


Response

                    {"object":"shopcategories",


"parent_category":
{
  "name": "Categories",
  "prio": 2,
  "id": 2,
  "id_parent": 0,
  "label": "Categories",
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
     
     
     
  }
},

"categories":[

 {
   "name":"Jacken",
   "prio":1,
   "id":3,
   "id_parent":2,
   "label":"Jacken",
   
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
   "attributes":{
      
      
      
   }
 }

,

 {
   "name":"Schuhe",
   "prio":2,
   "id":4,
   "id_parent":2,
   "label":"Schuhe",
   
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
   "attributes":{
      
      
      
   }
 }

,

 {
   "name":"Mützen",
   "prio":3,
   "id":5,
   "id_parent":2,
   "label":"Hats",
   
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
   "attributes":{
      
      
      
   }
 }


]

}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<shopcategories>
<parent_category>
<name>Categories</name>
<prio>2</prio>
<id>2</id>
<id_parent>0</id_parent>
<label>Categories</label>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</parent_category>
<shopcategory>
<name>Jacken</name>
<prio>1</prio>
<id>3</id>
<id_parent>2</id_parent>
<label>Jacken</label>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</shopcategory>
<shopcategory>
<name>Schuhe</name>
<prio>2</prio>
<id>4</id>
<id_parent>2</id_parent>
<label>Schuhe</label>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</shopcategory>
<shopcategory>
<name>Mützen</name>
<prio>3</prio>
<id>5</id>
<id_parent>2</id_parent>
<label>Hats</label>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</shopcategory>

</shopcategories>
                    

Explanation

parent_categorySection containing informations about the parent category.
categoriesSection containing all categories with the category as parent defined by the ID.

get_products_in_category

Delivers products contained in a category defined by its id.


Arguments

  • id_category (int)

    The id of the category.

  • language (string)

    A valid language-code.

  • country (string)

    A valid country-code.

  • order_column (string)

    The order column.

  • order (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_products_in_category' \ -d id_category=1 \ -d language="de_DE" \ -d country="DE" \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=1 \ -d needed_attributes='["name","price"]'


Here we are requesting the products in the category with the id:1. We want the products to be listed in german defined by the language - code "de_DE" for the country germany defined by the country - code "DE". Further we want the products to be listed ordered by the price descending. Left - limit is 0 an right - limit is 1 so only 1 product will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {"object":"products_in_category",
"category":{
"id":1,
"name":"Start",
"prio":1,
"id_parent":0,
"label":"Start",


"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
"attributes":{
   
   
   
}
},
"products":{
 
  "Schuh blau":
 
{
  "object":"product",
  "id":15,
  "name":"Schuh blau",
  "creation_date":"2016-03-25 14:17:46",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "blaue-laufschuhe-robust",
  "title": "Blaue Laufschuhe mit wasserdichter Oberfläche",
  "description": "Blaue Laufschuhe für Männer",
  "keywords": "blau,Schuhe,Laufschuhe"
}

,
  
"availability":
{
  "quantity": 5,
  "quantity_warning": 3,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":154,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":157,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
      "Schuh grün":
  
{
  "object":"product",
  "id":17,
  "name":"Schuh grün",
  "creation_date":"2016-03-25 14:24:01",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "gruen-laufschuh-herren",
  "title": "Stylischer Herrenlaufschuh in grün",
  "description": "Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh",
  "keywords": "laufen,schuhe,herren,neu,widerstandsfaehig"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":184,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh gru00fcn"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":187,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Schuh rot":
  
{
  "object":"product",
  "id":18,
  "name":"Schuh rot",
  "creation_date":"2016-03-25 14:25:33",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "laufschuh-sportlich-herren",
  "title": "Modischer Herrenlaufschuh in rot",
  "description": "Robuster und langlebiger Laufschuh für Herren",
  "keywords": "robust,laufen,modisch,maenner,herren"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":199,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh rot"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":202,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}


  
 
}
}


                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<products_in_category>
<category>
<id>1</id>
<name>Start</name>
<prio>1</prio>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</category>
<products>
<product>
<id>15</id>
<name>Schuh blau</name>
<creation_date>2016-03-25 14:17:46</creation_date>
<class>colorprod</class>
<seo>
<permalink>blaue-laufschuhe-robust</permalink>
<title>Blaue Laufschuhe mit wasserdichter Oberfläche</title>
<description>Blaue Laufschuhe für Männer</description>
<keywords>blau,Schuhe,Laufschuhe</keywords>
</seo>

<availability>
<quantity>5</quantity>
<quantity_warning>3</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="154">
<name>name</name>
<label>Name</label>
<value>Laufschuh blau</value>
</attribute>

<attribute type="FLOAT" id="157">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>
<product>
<id>17</id>
<name>Schuh grün</name>
<creation_date>2016-03-25 14:24:01</creation_date>
<class>colorprod</class>
<seo>
<permalink>gruen-laufschuh-herren</permalink>
<title>Stylischer Herrenlaufschuh in grün</title>
<description>Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh</description>
<keywords>laufen,schuhe,herren,neu,widerstandsfaehig</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="184">
<name>name</name>
<label>Name</label>
<value>Laufschuh grün</value>
</attribute>

<attribute type="FLOAT" id="187">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>18</id>
<name>Schuh rot</name>
<creation_date>2016-03-25 14:25:33</creation_date>
<class>colorprod</class>
<seo>
<permalink>laufschuh-sportlich-herren</permalink>
<title>Modischer Herrenlaufschuh in rot</title>
<description>Robuster und langlebiger Laufschuh für Herren</description>
<keywords>robust,laufen,modisch,maenner,herren</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="199">
<name>name</name>
<label>Name</label>
<value>Laufschuh rot</value>
</attribute>

<attribute type="FLOAT" id="202">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</variations>
</product>


</products>
</products_in_category>
                    

Explanation

categorySection containing informations about the category.
productsSection containing all products in the category.

get_contents_in_category

Delivers contents contained in a category defined by its id.


Arguments

  • id_category (int)

    The id of the category.

  • language (string)

    A valid language-code.

  • order_column (string)

    The order column.

  • order (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_contents_in_category' \ -d id_category=1 \ -d language="de_DE" \ -d order_column="name" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=2 \ -d needed_attributes='["headline","img"]'


Here we are requesting the contents in the category with the id:1. We want the contents to be listed in german defined by the language - code "de_DE". Further we want the contents to be listed ordered by the name descending. Left - limit is 0 an right - limit is 2 so only 2 contents will be listed. The attributes we want to be listed are "headline" and "img".

Response

                    {"object":"contents_in_category",
"category":{
"id":1,
"name":"Start",
"prio":1,
"id_parent":0,
"label":"Start",


"seo":
{
  "permalink": "start",
  "title": "demo",
  "description": "",
  "keywords": ""
}

,
"attributes":{
   
   
   
}
},
"contents":{
 
  "Teaser 1":
 
{
  "object":"content",
  "id":5,
  "name":"Teaser 1",
  "creation_date":"2016-03-25 12:38:23",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":51,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":52,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
                
    
  },
  "variations":{
  
    
    
 }
}


  ,
   "Teaser 2":
 
{
  "object":"content",
  "id":6,
  "name":"Teaser 2",
  "creation_date":"2016-03-25 12:42:29",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":54,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/31aee733fa02a09e23c30e8af6dabd9e.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":55,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
                
    
  },
  "variations":{
  
    
    
 }
}


  
 
}
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<contents_in_category>
<category>
<id>1</id>
<name>Start</name>
<prio>1</prio>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink>start</permalink>
<title>demo</title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</category>
<contents>
<content>
<id>5</id>
<name>Teaser 1</name>
<creation_date>2016-03-25 12:38:23</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>

</attributes>
<variations>

</variations>
</content>

<content>
<id>6</id>
<name>Teaser 2</name>
<creation_date>2016-03-25 12:42:29</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>

</attributes>
<variations>

</variations>
</content>


</contents>
</contents_in_category>
                    

Explanation

categorySection containing informations about the category.
contentsSection containing all contents in the category.

get_shopobjects_in_category

Delivers products and contents contained in a category defined by its id.


Arguments

  • id_category (int)

    The id of the category.

  • language (string)

    A valid language-code.

  • country (string)

    A valid country-code.

  • order_column (string)

    The order column.

  • order (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_shopobjects_in_category' \ -d id_category=1 \ -d language="de_DE" \ -d country="DE" \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=1 \ -d needed_attributes='["name","price"]'


Here we are requesting the products and contents in the category with the id:1. We want the objects to be listed in german defined by the language - code "de_DE" for the country germany defined by the country - code "DE". Further we want the objects to be listed ordered by the price descending. Left - limit is 0 an right - limit is 1 so only 1 product will be listed. The attributes we want to be listed are "name" and "price". Here there is no option to define separated "needed_attributes" for contents and products.

Response

                    {"object":"shopobjects_in_category",
"category":{
"id":1,
"name":"Start",
"prio":1,
"id_parent":0,
"label":"Start",


"seo":
{
  "permalink": "start",
  "title": "demo",
  "description": "",
  "keywords": ""
}

,
"attributes":{
   
   
   
}
},
"products":{
 
  "Schuh blau":
 
{
  "object":"product",
  "id":15,
  "name":"Schuh blau",
  "creation_date":"2016-03-25 14:17:46",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "blaue-laufschuhe-robust",
  "title": "Blaue Laufschuhe mit wasserdichter Oberfläche",
  "description": "Blaue Laufschuhe für Männer",
  "keywords": "blau,Schuhe,Laufschuhe"
}

,
  
"availability":
{
  "quantity": 5,
  "quantity_warning": 3,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":154,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":157,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
      "Schuh grün":
  
{
  "object":"product",
  "id":17,
  "name":"Schuh grün",
  "creation_date":"2016-03-25 14:24:01",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "gruen-laufschuh-herren",
  "title": "Stylischer Herrenlaufschuh in grün",
  "description": "Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh",
  "keywords": "laufen,schuhe,herren,neu,widerstandsfaehig"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":184,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh gru00fcn"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":187,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Schuh rot":
  
{
  "object":"product",
  "id":18,
  "name":"Schuh rot",
  "creation_date":"2016-03-25 14:25:33",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "laufschuh-sportlich-herren",
  "title": "Modischer Herrenlaufschuh in rot",
  "description": "Robuster und langlebiger Laufschuh für Herren",
  "keywords": "robust,laufen,modisch,maenner,herren"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":199,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh rot"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":202,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}


  
 
},
"contents":{
  
    "Teaser 1":
  
{
  "object":"content",
  "id":5,
  "name":"Teaser 1",
  "creation_date":"2016-03-25 12:38:23",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":51,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":52,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
            
    ,                    "text":

{
  "type":"TXT",
  "id":53,
  "name":"text",
  "label":"Text",
  "value":""
}


                            
        
    
  },
  "variations":{
  
    
    
 }
}


    

}
}


                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<shopobjects_in_category>
<category>
<id>1</id>
<name>Start</name>
<prio>1</prio>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink>start</permalink>
<title>demo</title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</category>
<products>
<product>
<id>15</id>
<name>Schuh blau</name>
<creation_date>2016-03-25 14:17:46</creation_date>
<class>colorprod</class>
<seo>
<permalink>blaue-laufschuhe-robust</permalink>
<title>Blaue Laufschuhe mit wasserdichter Oberfläche</title>
<description>Blaue Laufschuhe für Männer</description>
<keywords>blau,Schuhe,Laufschuhe</keywords>
</seo>

<availability>
<quantity>5</quantity>
<quantity_warning>3</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="154">
<name>name</name>
<label>Name</label>
<value>Laufschuh blau</value>
</attribute>

<attribute type="FLOAT" id="157">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>
<product>
<id>17</id>
<name>Schuh grün</name>
<creation_date>2016-03-25 14:24:01</creation_date>
<class>colorprod</class>
<seo>
<permalink>gruen-laufschuh-herren</permalink>
<title>Stylischer Herrenlaufschuh in grün</title>
<description>Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh</description>
<keywords>laufen,schuhe,herren,neu,widerstandsfaehig</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="184">
<name>name</name>
<label>Name</label>
<value>Laufschuh grün</value>
</attribute>

<attribute type="FLOAT" id="187">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>18</id>
<name>Schuh rot</name>
<creation_date>2016-03-25 14:25:33</creation_date>
<class>colorprod</class>
<seo>
<permalink>laufschuh-sportlich-herren</permalink>
<title>Modischer Herrenlaufschuh in rot</title>
<description>Robuster und langlebiger Laufschuh für Herren</description>
<keywords>robust,laufen,modisch,maenner,herren</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="199">
<name>name</name>
<label>Name</label>
<value>Laufschuh rot</value>
</attribute>

<attribute type="FLOAT" id="202">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</variations>
</product>


</products>
<contents>
<content>
<id>5</id>
<name>Teaser 1</name>
<creation_date>2016-03-25 12:38:23</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>
<attribute type="IMG" id="51">
<name>img</name>
<label>Bild</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg</value>
<width>NAN</width>
<height>NAN</height>
</attribute>

<attribute type="CHAR" id="52">
<name>headline</name>
<label>Überschrift</label>
<value></value>
</attribute>

<attribute type="TXT" id="53">
<name>text</name>
<label>Text</label>
<value></value>
</attribute>


</attributes>
<variations>

</variations>
</content>


</contents>
</shopobjects_in_category>
                    

Explanation

categorySection containing informations about the category.
productsSection containing all products in the category.
contentsSection containing all contents in the category.

dump_category

Delivers products and contents recursively where the id_category determines the root where the iteration begins.


Arguments

  • id_category (int)

    The id of the category.

  • language (string)

    A valid language-code.

  • country (string)

    A valid country-code.

  • order_column (string)

    The order column.

  • order (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='dump_category' \ -d id_category=2 \ -d language="de_DE" \ -d country="DE" \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=1 \ -d needed_attributes='["name","price"]'


Here we are requesting the products and contents in the category with the id:1. Further we want all data in the child - nodes. These data will be derived recursively. We want the data to be listed in german defined by the language - code "de_DE" for the country germany defined by the country - code "DE". Further we want the data to be listed ordered by the price descending. Left - limit is 0 an right - limit is 1 so only 1 product will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {
  "object":"category_dump",
  
    
  "parent_category":
  {
    "name":"Categories",
    "prio":2,
    "id":2,
    "id_parent":0,
    "label":"Categories",
    
    
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}


    
    "attributes":{
      
     
    }
    
  },
  
    
  "shop_categories":{
    
        
     "{$category.name}":
     {
       
       
{
  "object":"category_dump",
  
    
  "parent_category":
  {
    "name":"Jacken",
    "prio":1,
    "id":3,
    "id_parent":2,
    "label":"Jacken",
    
    
"seo":
{
  "permalink": "jacken",
  "title": "Jacken",
  "description": "Jacken",
  "keywords": "jacken"
}


    
    "attributes":{
      
     
    }
    
  },
  
    
  "shop_categories":{
    
    
  },
  
  "products_in_category":
  {
    "category":
    {
      "id_category":3,
      "name":"Jacken"
    }
    "products":
    {
      
            "Jacke rot M":

        
{
  "object":"product",
  "id":20,
  "name":"Jacke rot M",
  "creation_date":"2016-03-25 14:29:14",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "warme-herren-winterjacke",
  "title": "Superwarme und flauschige Winterjacke für Männer",
  "description": "Winterjacke für jedes Wetter!",
  "keywords": "warm,winter,maenner,jacke"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":229,
  "name":"name",
  "label":"Name",
  "value":"Winterjacke rot M"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":232,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
      "Jacke rot S":
  
{
  "object":"product",
  "id":22,
  "name":"Jacke rot S",
  "creation_date":"2016-03-25 14:31:45",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "winterjacke-warm-maenner",
  "title": "Warme Winterjacke für Herren",
  "description": "Winterjacke in superweicher Qualität",
  "keywords": "weich,warm,maenner,herren,winter,jacke"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":254,
  "name":"name",
  "label":"Name",
  "value":"Winterjacke rot S"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":257,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Jacke rot L":
  
{
  "object":"product",
  "id":24,
  "name":"Jacke rot L",
  "creation_date":"2016-03-25 14:32:09",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "wasserdicht-herren-jacke",
  "title": "Wasserdichte Herrenjacke in rot",
  "description": "Coole Outdoorjacke in rot für Herren",
  "keywords": "warm,wasserdicht,atmungsaktiv,chic"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":282,
  "name":"name",
  "label":"Name",
  "value":"winterjacke rot L"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":285,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Jacke rot XL":
  
{
  "object":"product",
  "id":26,
  "name":"Jacke rot XL",
  "creation_date":"2016-03-25 14:32:37",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "allwetter-herren-rot",
  "title": "Herrenoutdoorjacke",
  "description": "Allwetterjacke für Herren",
  "keywords": "allwetter,outdoor,herren,rot,wasserdicht"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":310,
  "name":"name",
  "label":"Name",
  "value":"winterjacke rot XL"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":313,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}



            
      
    }
  },
  "contents_in_category":
  {
   "category":
   {
     "id_category":3,
     "name":"Jacken"
   },
   "contents":
   {
     
     
     
   }
  }
}


       
     }
    
        
     "{$category.name}":
     {
       
       
{
  "object":"category_dump",
  
    
  "parent_category":
  {
    "name":"Schuhe",
    "prio":2,
    "id":4,
    "id_parent":2,
    "label":"Schuhe",
    
    
"seo":
{
  "permalink": "schuhe",
  "title": "Schuhe",
  "description": "Schuhe",
  "keywords": "schuhe"
}


    
    "attributes":{
      
     
    }
    
  },
  
    
  "shop_categories":{
    
    
  },
  
  "products_in_category":
  {
    "category":
    {
      "id_category":4,
      "name":"Schuhe"
    }
    "products":
    {
      
            "Schuh blau":

        
{
  "object":"product",
  "id":15,
  "name":"Schuh blau",
  "creation_date":"2016-03-25 14:17:46",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "blaue-laufschuhe-robust",
  "title": "Blaue Laufschuhe mit wasserdichter Oberfläche",
  "description": "Blaue Laufschuhe für Männer",
  "keywords": "blau,Schuhe,Laufschuhe"
}

,
  
"availability":
{
  "quantity": 5,
  "quantity_warning": 3,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":154,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":157,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
      "Schuh grün":
  
{
  "object":"product",
  "id":17,
  "name":"Schuh grün",
  "creation_date":"2016-03-25 14:24:01",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "gruen-laufschuh-herren",
  "title": "Stylischer Herrenlaufschuh in grün",
  "description": "Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh",
  "keywords": "laufen,schuhe,herren,neu,widerstandsfaehig"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":184,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh gru00fcn"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":187,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Schuh rot":
  
{
  "object":"product",
  "id":18,
  "name":"Schuh rot",
  "creation_date":"2016-03-25 14:25:33",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "laufschuh-sportlich-herren",
  "title": "Modischer Herrenlaufschuh in rot",
  "description": "Robuster und langlebiger Laufschuh für Herren",
  "keywords": "robust,laufen,modisch,maenner,herren"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":199,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh rot"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":202,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}



            
      
    }
  },
  "contents_in_category":
  {
   "category":
   {
     "id_category":4,
     "name":"Schuhe"
   },
   "contents":
   {
     
     
     
   }
  }
}


       
     }
    
        
     "{$category.name}":
     {
       
       
{
  "object":"category_dump",
  
    
  "parent_category":
  {
    "name":"Mützen",
    "prio":3,
    "id":5,
    "id_parent":2,
    "label":"Mützen",
    
    
"seo":
{
  "permalink": "muetzen",
  "title": "Mützen",
  "description": "Mützen",
  "keywords": "mützen"
}


    
    "attributes":{
      
     
    }
    
  },
  
    
  "shop_categories":{
    
    
  },
  
  "products_in_category":
  {
    "category":
    {
      "id_category":5,
      "name":"Mützen"
    }
    "products":
    {
      
            "Schneehut dunkelblau":

        
{
  "object":"product",
  "id":42,
  "name":"Schneehut dunkelblau",
  "creation_date":"2016-03-25 17:22:22",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "dunkelblau-schneehut-warm",
  "title": "Dunkelblauer Schneehut",
  "description": "Cooler Schneehut in dunkelblau",
  "keywords": "dunkelblau, Schneehut, Muetze"
}

,
  
"availability":
{
  "quantity": 14,
  "quantity_warning": 6,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "123321",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":20,
  "width":18,
  "height":25,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":532,
  "name":"name",
  "label":"Name",
  "value":"Schneehut dunkelblau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":535,
  "name":"price",
  "label":"Preis",
  "value":27.9
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}



            
      
    }
  },
  "contents_in_category":
  {
   "category":
   {
     "id_category":5,
     "name":"Mützen"
   },
   "contents":
   {
     
     
     
   }
  }
}


       
     }
    
    
  },
  
  "products_in_category":
  {
    "category":
    {
      "id_category":2,
      "name":"Categories"
    }
    "products":
    {
      
      
      
    }
  },
  "contents_in_category":
  {
   "category":
   {
     "id_category":2,
     "name":"Categories"
   },
   "contents":
   {
     
     
     
   }
  }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<category_dump>
<parent_category>
<name>Categories</name>
<prio>2</prio>
<id>2</id>
<id_parent>0</id_parent>
<label>Categories</label>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</parent_category>
<shop_categories>
 <category_dump>
<parent_category>
<name>Jacken</name>
<prio>1</prio>
<id>3</id>
<id_parent>2</id_parent>
<label>Jacken</label>
<seo>
<permalink>jacken</permalink>
<title>Jacken</title>
<description>Jacken</description>
<keywords>jacken</keywords>
</seo>

<attributes></attributes>
</parent_category>
<shop_categories>

</shop_categories>
<products_in_category>
<category>
<id_category>3</id_category>
<name>Jacken</name>
</category>
<products>
<product>
<id>20</id>
<name>Jacke rot M</name>
<creation_date>2016-03-25 14:29:14</creation_date>
<class>sizeprod</class>
<seo>
<permalink>warme-herren-winterjacke</permalink>
<title>Superwarme und flauschige Winterjacke für Männer</title>
<description>Winterjacke für jedes Wetter!</description>
<keywords>warm,winter,maenner,jacke</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="229">
<name>name</name>
<label>Name</label>
<value>Winterjacke rot M</value>
</attribute>

<attribute type="FLOAT" id="232">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>
<product>
<id>22</id>
<name>Jacke rot S</name>
<creation_date>2016-03-25 14:31:45</creation_date>
<class>sizeprod</class>
<seo>
<permalink>winterjacke-warm-maenner</permalink>
<title>Warme Winterjacke für Herren</title>
<description>Winterjacke in superweicher Qualität</description>
<keywords>weich,warm,maenner,herren,winter,jacke</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="254">
<name>name</name>
<label>Name</label>
<value>Winterjacke rot S</value>
</attribute>

<attribute type="FLOAT" id="257">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>24</id>
<name>Jacke rot L</name>
<creation_date>2016-03-25 14:32:09</creation_date>
<class>sizeprod</class>
<seo>
<permalink>wasserdicht-herren-jacke</permalink>
<title>Wasserdichte Herrenjacke in rot</title>
<description>Coole Outdoorjacke in rot für Herren</description>
<keywords>warm,wasserdicht,atmungsaktiv,chic</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="282">
<name>name</name>
<label>Name</label>
<value>winterjacke rot L</value>
</attribute>

<attribute type="FLOAT" id="285">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>26</id>
<name>Jacke rot XL</name>
<creation_date>2016-03-25 14:32:37</creation_date>
<class>sizeprod</class>
<seo>
<permalink>allwetter-herren-rot</permalink>
<title>Herrenoutdoorjacke</title>
<description>Allwetterjacke für Herren</description>
<keywords>allwetter,outdoor,herren,rot,wasserdicht</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="310">
<name>name</name>
<label>Name</label>
<value>winterjacke rot XL</value>
</attribute>

<attribute type="FLOAT" id="313">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</variations>
</product>


</products>
</products_in_category>
<contents_in_category>
<category>
<id_category>3</id_category>
<name>Jacken</name>
</category>
<contents>

</contents>
</contents_in_category>
</category_dump>

 <category_dump>
<parent_category>
<name>Schuhe</name>
<prio>2</prio>
<id>4</id>
<id_parent>2</id_parent>
<label>Schuhe</label>
<seo>
<permalink>schuhe</permalink>
<title>Schuhe</title>
<description>Schuhe</description>
<keywords>schuhe</keywords>
</seo>

<attributes></attributes>
</parent_category>
<shop_categories>

</shop_categories>
<products_in_category>
<category>
<id_category>4</id_category>
<name>Schuhe</name>
</category>
<products>
<product>
<id>15</id>
<name>Schuh blau</name>
<creation_date>2016-03-25 14:17:46</creation_date>
<class>colorprod</class>
<seo>
<permalink>blaue-laufschuhe-robust</permalink>
<title>Blaue Laufschuhe mit wasserdichter Oberfläche</title>
<description>Blaue Laufschuhe für Männer</description>
<keywords>blau,Schuhe,Laufschuhe</keywords>
</seo>

<availability>
<quantity>5</quantity>
<quantity_warning>3</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="154">
<name>name</name>
<label>Name</label>
<value>Laufschuh blau</value>
</attribute>

<attribute type="FLOAT" id="157">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>
<product>
<id>17</id>
<name>Schuh grün</name>
<creation_date>2016-03-25 14:24:01</creation_date>
<class>colorprod</class>
<seo>
<permalink>gruen-laufschuh-herren</permalink>
<title>Stylischer Herrenlaufschuh in grün</title>
<description>Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh</description>
<keywords>laufen,schuhe,herren,neu,widerstandsfaehig</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="184">
<name>name</name>
<label>Name</label>
<value>Laufschuh grün</value>
</attribute>

<attribute type="FLOAT" id="187">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>18</id>
<name>Schuh rot</name>
<creation_date>2016-03-25 14:25:33</creation_date>
<class>colorprod</class>
<seo>
<permalink>laufschuh-sportlich-herren</permalink>
<title>Modischer Herrenlaufschuh in rot</title>
<description>Robuster und langlebiger Laufschuh für Herren</description>
<keywords>robust,laufen,modisch,maenner,herren</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="199">
<name>name</name>
<label>Name</label>
<value>Laufschuh rot</value>
</attribute>

<attribute type="FLOAT" id="202">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</variations>
</product>


</products>
</products_in_category>
<contents_in_category>
<category>
<id_category>4</id_category>
<name>Schuhe</name>
</category>
<contents>

</contents>
</contents_in_category>
</category_dump>

 <category_dump>
<parent_category>
<name>Mützen</name>
<prio>3</prio>
<id>5</id>
<id_parent>2</id_parent>
<label>Mützen</label>
<seo>
<permalink>muetzen</permalink>
<title>Mützen</title>
<description>Mützen</description>
<keywords>mützen</keywords>
</seo>

<attributes></attributes>
</parent_category>
<shop_categories>

</shop_categories>
<products_in_category>
<category>
<id_category>5</id_category>
<name>Mützen</name>
</category>
<products>
<product>
<id>42</id>
<name>Schneehut dunkelblau</name>
<creation_date>2016-03-25 17:22:22</creation_date>
<class>colorprod</class>
<seo>
<permalink>dunkelblau-schneehut-warm</permalink>
<title>Dunkelblauer Schneehut</title>
<description>Cooler Schneehut in dunkelblau</description>
<keywords>dunkelblau, Schneehut, Muetze</keywords>
</seo>

<availability>
<quantity>14</quantity>
<quantity_warning>6</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number>123321</element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>20</length>
<width>18</width>
<height>25</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="532">
<name>name</name>
<label>Name</label>
<value>Schneehut dunkelblau</value>
</attribute>

<attribute type="FLOAT" id="535">
<name>price</name>
<label>Preis</label>
<value>27.9</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</products>
</products_in_category>
<contents_in_category>
<category>
<id_category>5</id_category>
<name>Mützen</name>
</category>
<contents>

</contents>
</contents_in_category>
</category_dump>


</shop_categories>
<products_in_category>
<category>
<id_category>2</id_category>
<name>Categories</name>
</category>
<products>

</products>
</products_in_category>
<contents_in_category>
<category>
<id_category>2</id_category>
<name>Categories</name>
</category>
<contents>

</contents>
</contents_in_category>
</category_dump>
                    

Explanation

parent_categorySection containing informations about the corresponding parent category.
products_in_categorySection containing all products in the category.
contents_in_categorySection containing all contents in the category.
shop_categoriesSection containing children of the category.

seo_get_products_in_category

Delivers products contained in a category defined by its permalink.


Arguments

  • permalink (string)

    A valid permalink of the category.

  • country (string)

    A valid country-code.

  • order_column (string)

    The order column.

  • order (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='seo_get_products_in_category' \ -d permalink='jacken' \ -d country="DE" \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=1 \ -d needed_attributes='["name","price"]'


Here we are requesting the products in the category determined by the attribute permalink. We want the products to be listed  for the country germany defined by the country - code "DE". Further we want the products to be listed ordered by the price descending. Left - limit is 0 an right - limit is 1 so only 1 product will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {"object":"products_in_category",
"category":{
"id":3,
"name":"Jacken",
"prio":1,
"id_parent":2,
"label":"Jacken",


"seo":
{
  "permalink": "jacken",
  "title": "Jacken",
  "description": "Jacken",
  "keywords": "jacken"
}

,
"attributes":{
   
   
   
}
},
"products":{
 
  "Jacke rot M":
 
{
  "object":"product",
  "id":20,
  "name":"Jacke rot M",
  "creation_date":"2016-03-25 14:29:14",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "warme-herren-winterjacke",
  "title": "Superwarme und flauschige Winterjacke für Männer",
  "description": "Winterjacke für jedes Wetter!",
  "keywords": "warm,winter,maenner,jacke"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":229,
  "name":"name",
  "label":"Name",
  "value":"Winterjacke rot M"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":232,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
      "Jacke rot S":
  
{
  "object":"product",
  "id":22,
  "name":"Jacke rot S",
  "creation_date":"2016-03-25 14:31:45",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "winterjacke-warm-maenner",
  "title": "Warme Winterjacke für Herren",
  "description": "Winterjacke in superweicher Qualität",
  "keywords": "weich,warm,maenner,herren,winter,jacke"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":254,
  "name":"name",
  "label":"Name",
  "value":"Winterjacke rot S"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":257,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Jacke rot L":
  
{
  "object":"product",
  "id":24,
  "name":"Jacke rot L",
  "creation_date":"2016-03-25 14:32:09",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "wasserdicht-herren-jacke",
  "title": "Wasserdichte Herrenjacke in rot",
  "description": "Coole Outdoorjacke in rot für Herren",
  "keywords": "warm,wasserdicht,atmungsaktiv,chic"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":282,
  "name":"name",
  "label":"Name",
  "value":"winterjacke rot L"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":285,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Jacke rot XL":
  
{
  "object":"product",
  "id":26,
  "name":"Jacke rot XL",
  "creation_date":"2016-03-25 14:32:37",
  "class":"sizeprod",
  
  
"seo":
{
  "permalink": "allwetter-herren-rot",
  "title": "Herrenoutdoorjacke",
  "description": "Allwetterjacke für Herren",
  "keywords": "allwetter,outdoor,herren,rot,wasserdicht"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":310,
  "name":"name",
  "label":"Name",
  "value":"winterjacke rot XL"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":313,
  "name":"price",
  "label":"Preis",
  "value":89
}


                
                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}


  
 
}
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<products_in_category>
<category>
<id>3</id>
<name>Jacken</name>
<prio>1</prio>
<id_parent>2</id_parent>
<label>Jacken</label>
<seo>
<permalink>jacken</permalink>
<title>Jacken</title>
<description>Jacken</description>
<keywords>jacken</keywords>
</seo>

<attributes></attributes>
</category>
<products>
<product>
<id>20</id>
<name>Jacke rot M</name>
<creation_date>2016-03-25 14:29:14</creation_date>
<class>sizeprod</class>
<seo>
<permalink>warme-herren-winterjacke</permalink>
<title>Superwarme und flauschige Winterjacke für Männer</title>
<description>Winterjacke für jedes Wetter!</description>
<keywords>warm,winter,maenner,jacke</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="229">
<name>name</name>
<label>Name</label>
<value>Winterjacke rot M</value>
</attribute>

<attribute type="FLOAT" id="232">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>
<product>
<id>22</id>
<name>Jacke rot S</name>
<creation_date>2016-03-25 14:31:45</creation_date>
<class>sizeprod</class>
<seo>
<permalink>winterjacke-warm-maenner</permalink>
<title>Warme Winterjacke für Herren</title>
<description>Winterjacke in superweicher Qualität</description>
<keywords>weich,warm,maenner,herren,winter,jacke</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="254">
<name>name</name>
<label>Name</label>
<value>Winterjacke rot S</value>
</attribute>

<attribute type="FLOAT" id="257">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>24</id>
<name>Jacke rot L</name>
<creation_date>2016-03-25 14:32:09</creation_date>
<class>sizeprod</class>
<seo>
<permalink>wasserdicht-herren-jacke</permalink>
<title>Wasserdichte Herrenjacke in rot</title>
<description>Coole Outdoorjacke in rot für Herren</description>
<keywords>warm,wasserdicht,atmungsaktiv,chic</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="282">
<name>name</name>
<label>Name</label>
<value>winterjacke rot L</value>
</attribute>

<attribute type="FLOAT" id="285">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>26</id>
<name>Jacke rot XL</name>
<creation_date>2016-03-25 14:32:37</creation_date>
<class>sizeprod</class>
<seo>
<permalink>allwetter-herren-rot</permalink>
<title>Herrenoutdoorjacke</title>
<description>Allwetterjacke für Herren</description>
<keywords>allwetter,outdoor,herren,rot,wasserdicht</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="310">
<name>name</name>
<label>Name</label>
<value>winterjacke rot XL</value>
</attribute>

<attribute type="FLOAT" id="313">
<name>price</name>
<label>Preis</label>
<value>89</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</variations>
</product>


</products>
</products_in_category>
                    

Explanation

categorySection containing informations about the category.
productsSection containing all products in the category.

seo_get_contents_in_category

Delivers contents contained in a category defined by its permalink.


Arguments

  • permalink (string)

    A valid permalink of the category.

  • order_column (string)

    The order column.

  • order (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='seo_get_contents_in_category' \ -d permalink='start' \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=1 \ -d needed_attributes='["name","price"]'


Here we are requesting the contents in the category determined by the attribute permalink. Further we want the contents to be listed ordered by the price descending. Left - limit is 0 an right - limit is 1 so only 1 product will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {"object":"contents_in_category",
"category":{
"id":1,
"name":"Start",
"prio":1,
"id_parent":0,
"label":"Start",


"seo":
{
  "permalink": "start",
  "title": "demo",
  "description": "",
  "keywords": ""
}

,
"attributes":{
   
   
   
}
},
"contents":{
 
  "Teaser 1":
 
{
  "object":"content",
  "id":5,
  "name":"Teaser 1",
  "creation_date":"2016-03-25 12:38:23",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
                                
    
  },
  "variations":{
  
    
    
 }
}


  
 
}
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<contents_in_category>
<category>
<id>1</id>
<name>Start</name>
<prio>1</prio>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink>start</permalink>
<title>demo</title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</category>
<contents>
<content>
<id>5</id>
<name>Teaser 1</name>
<creation_date>2016-03-25 12:38:23</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>

</attributes>
<variations>

</variations>
</content>


</contents>
</contents_in_category>
                    

Explanation

categorySection containing informations about the category.
contentsSection containing all contents in the category.

seo_get_shopobjects_in_category

Delivers products and contents contained in a category defined by its permalink.


Arguments

  • permalink (string)

    A valid permalink.

  • country (string)

    A valid country-code.

  • order_column (string)

    The order column.

  • order (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='seo_get_shopobjects_in_category' \ -d permalink='start' \ -d country="DE" \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=1 \ -d needed_attributes='["name","price"]'


Here we are requesting the products and contents in the category determined by permalink. We want the objects to be listed in  for the country germany defined by the country - code "DE". Further we want the objects to be listed ordered by the price descending. Left - limit is 0 an right - limit is 1 so only 1 object will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {"object":"shopobjects_in_category",
"category":{
"id":1,
"name":"Start",
"prio":1,
"id_parent":0,
"label":"Start",


"seo":
{
  "permalink": "start",
  "title": "demo",
  "description": "",
  "keywords": ""
}

,
"attributes":{
   
   
   
}
},
"products":{
 
  "Schuh blau":
 
{
  "object":"product",
  "id":15,
  "name":"Schuh blau",
  "creation_date":"2016-03-25 14:17:46",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "blaue-laufschuhe-robust",
  "title": "Blaue Laufschuhe mit wasserdichter Oberfläche",
  "description": "Blaue Laufschuhe für Männer",
  "keywords": "blau,Schuhe,Laufschuhe"
}

,
  
"availability":
{
  "quantity": 5,
  "quantity_warning": 3,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":154,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":157,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
      "Schuh grün":
  
{
  "object":"product",
  "id":17,
  "name":"Schuh grün",
  "creation_date":"2016-03-25 14:24:01",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "gruen-laufschuh-herren",
  "title": "Stylischer Herrenlaufschuh in grün",
  "description": "Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh",
  "keywords": "laufen,schuhe,herren,neu,widerstandsfaehig"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":184,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh gru00fcn"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":187,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


    "Schuh rot":
  
{
  "object":"product",
  "id":18,
  "name":"Schuh rot",
  "creation_date":"2016-03-25 14:25:33",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "laufschuh-sportlich-herren",
  "title": "Modischer Herrenlaufschuh in rot",
  "description": "Robuster und langlebiger Laufschuh für Herren",
  "keywords": "robust,laufen,modisch,maenner,herren"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":199,
  "name":"name",
  "label":"Name",
  "value":"Laufschuh rot"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":202,
  "name":"price",
  "label":"Preis",
  "value":95
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}


  
 
},
"contents":{
  
    "Teaser 1":
  
{
  "object":"content",
  "id":5,
  "name":"Teaser 1",
  "creation_date":"2016-03-25 12:38:23",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":51,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":52,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
            
    ,                    "text":

{
  "type":"TXT",
  "id":53,
  "name":"text",
  "label":"Text",
  "value":""
}


                            
        
    
  },
  "variations":{
  
    
    
 }
}


    

}
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<shopobjects_in_category>
<category>
<id>1</id>
<name>Start</name>
<prio>1</prio>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink>start</permalink>
<title>demo</title>
<description></description>
<keywords></keywords>
</seo>

<attributes></attributes>
</category>
<products>
<product>
<id>15</id>
<name>Schuh blau</name>
<creation_date>2016-03-25 14:17:46</creation_date>
<class>colorprod</class>
<seo>
<permalink>blaue-laufschuhe-robust</permalink>
<title>Blaue Laufschuhe mit wasserdichter Oberfläche</title>
<description>Blaue Laufschuhe für Männer</description>
<keywords>blau,Schuhe,Laufschuhe</keywords>
</seo>

<availability>
<quantity>5</quantity>
<quantity_warning>3</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="154">
<name>name</name>
<label>Name</label>
<value>Laufschuh blau</value>
</attribute>

<attribute type="FLOAT" id="157">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>
<product>
<id>17</id>
<name>Schuh grün</name>
<creation_date>2016-03-25 14:24:01</creation_date>
<class>colorprod</class>
<seo>
<permalink>gruen-laufschuh-herren</permalink>
<title>Stylischer Herrenlaufschuh in grün</title>
<description>Aus der neuen Kollektion: Unser &amp;amp;quot;Lauf,Schuh!&amp;amp;quot;-Herrenlaufschuh</description>
<keywords>laufen,schuhe,herren,neu,widerstandsfaehig</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="184">
<name>name</name>
<label>Name</label>
<value>Laufschuh grün</value>
</attribute>

<attribute type="FLOAT" id="187">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>18</id>
<name>Schuh rot</name>
<creation_date>2016-03-25 14:25:33</creation_date>
<class>colorprod</class>
<seo>
<permalink>laufschuh-sportlich-herren</permalink>
<title>Modischer Herrenlaufschuh in rot</title>
<description>Robuster und langlebiger Laufschuh für Herren</description>
<keywords>robust,laufen,modisch,maenner,herren</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="199">
<name>name</name>
<label>Name</label>
<value>Laufschuh rot</value>
</attribute>

<attribute type="FLOAT" id="202">
<name>price</name>
<label>Preis</label>
<value>95</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</variations>
</product>


</products>
<contents>
<content>
<id>5</id>
<name>Teaser 1</name>
<creation_date>2016-03-25 12:38:23</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>
<attribute type="IMG" id="51">
<name>img</name>
<label>Bild</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg</value>
<width>NAN</width>
<height>NAN</height>
</attribute>

<attribute type="CHAR" id="52">
<name>headline</name>
<label>Überschrift</label>
<value></value>
</attribute>

<attribute type="TXT" id="53">
<name>text</name>
<label>Text</label>
<value></value>
</attribute>


</attributes>
<variations>

</variations>
</content>


</contents>
</shopobjects_in_category>
                    

Explanation

categorySection containing informations about the category.
productsSection containing all products in the category.
contentsSection containing all contents in the category.

get_product_details

Delivers the product - details for the product defined by its id.


Arguments

  • id_product (int)

    The id of the product.

  • language (string)

    A valid language-code.

  • country (string)

    A valid country-code.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_product_details' \ -d id_product=42 \ -d language="de_DE" \ -d country="DE" \ -d needed_attributes='["name","price"]'


Here we are requesting the product - details for the product with the id:42. We want the product to be listed in german defined by the language - code "de_DE" for the country germany defined by the country - code "DE".. The attributes we want to be listed are "name" and "price".

Response

                    {
  "object":"product",
  "id":42,
  "name":"Schneehut dunkelblau",
  "creation_date":"2016-03-25 17:22:22",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "dunkelblau-schneehut-warm",
  "title": "Dunkelblauer Schneehut",
  "description": "Cooler Schneehut in dunkelblau",
  "keywords": "dunkelblau, Schneehut, Muetze"
}

,
  
"availability":
{
  "quantity": 14,
  "quantity_warning": 6,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "123321",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":20,
  "width":18,
  "height":25,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":532,
  "name":"name",
  "label":"Name",
  "value":"Schneehut dunkelblau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":535,
  "name":"price",
  "label":"Preis",
  "value":27.9
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<product>
<id>42</id>
<name>Schneehut dunkelblau</name>
<creation_date>2016-03-25 17:22:22</creation_date>
<class>colorprod</class>
<seo>
<permalink>dunkelblau-schneehut-warm</permalink>
<title>Dunkelblauer Schneehut</title>
<description>Cooler Schneehut in dunkelblau</description>
<keywords>dunkelblau, Schneehut, Muetze</keywords>
</seo>

<availability>
<quantity>14</quantity>
<quantity_warning>6</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number>123321</element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>20</length>
<width>18</width>
<height>25</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="532">
<name>name</name>
<label>Name</label>
<value>Schneehut dunkelblau</value>
</attribute>

<attribute type="FLOAT" id="535">
<name>price</name>
<label>Preis</label>
<value>27.9</value>
</attribute>


</attributes>
<variations>

</variations>
</product>
                    

Explanation

idThe id of the product.
nameThe name of the product.
creation_dateThe creation date of the product.
classThe class of the product.
seoThe SEO - section for the product.
availabilityThe availability - section for the product.
metadataThe metadata section of the product.
attributesThe attributes section of the product.
variationsThe section containing all variations.

get_content_details

Delivers the content - details for the product defined by its id.


Arguments

  • id_content (int)

    The id of the content object.

  • language (string)

    A valid language-code.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_content_details' \ -d id_content=5 \ -d language="de_DE"


Here we are requesting the content - details for the content with the id:5. We want the product to be listed in german defined by the language - code "de_DE".

Response

                    {
  "object":"content",
  "id":5,
  "name":"Teaser 1",
  "creation_date":"2016-03-25 12:38:23",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                "img":

{
  "type":"IMG",
  "id":51,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg",
  "width":"NAN",
  "height":"NAN"
  
    
}


                                    
            
    ,                "headline":

{
  "type":"CHAR",
  "id":52,
  "name":"headline",
  "label":"Überschrift",
  "value":""
}


                                
            
    ,                    "text":

{
  "type":"TXT",
  "id":53,
  "name":"text",
  "label":"Text",
  "value":""
}


                            
        
    
  },
  "variations":{
  
    
    
 }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<content>
<id>5</id>
<name>Teaser 1</name>
<creation_date>2016-03-25 12:38:23</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>
<attribute type="IMG" id="51">
<name>img</name>
<label>Bild</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/1c14058528a52ddae559cb29d7faa94a.jpg</value>
<width>NAN</width>
<height>NAN</height>
</attribute>

<attribute type="CHAR" id="52">
<name>headline</name>
<label>Überschrift</label>
<value></value>
</attribute>

<attribute type="TXT" id="53">
<name>text</name>
<label>Text</label>
<value></value>
</attribute>


</attributes>
<variations>

</variations>
</content>
                    

Explanation

idThe id of the content.
nameThe name of the content.
creation_dateThe creation date of the content.
classThe class of the content.
seoThe SEO - section for the content.
attributesThe attributes section of the content.
variationsThe section containing all variations. In the actual version this section will always be empty for content - objects.

seo_get_product_details

Delivers the product - details for the product defined by its permalink.


Arguments

  • permalink (string)

    The permalink of the product.

  • country (string)

    A valid country-code.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='seo_get_product_details' \ -d permalink='dunkelblau-schneehut-warm' \ -d country="DE" \ -d needed_attributes='["name","price"]'


Here we are requesting the product determined by the permalink. We want the product to be listed  for the country germany defined by the country - code "DE". The attributes we want to be listed are "name" and "price".

Response

                    {
  "object":"product",
  "id":42,
  "name":"Schneehut dunkelblau",
  "creation_date":"2016-03-25 17:22:22",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "dunkelblau-schneehut-warm",
  "title": "Dunkelblauer Schneehut",
  "description": "Cooler Schneehut in dunkelblau",
  "keywords": "dunkelblau, Schneehut, Muetze"
}

,
  
"availability":
{
  "quantity": 14,
  "quantity_warning": 6,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "123321",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":20,
  "width":18,
  "height":25,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":532,
  "name":"name",
  "label":"Name",
  "value":"Schneehut dunkelblau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":535,
  "name":"price",
  "label":"Preis",
  "value":27.9
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<product>
<id>42</id>
<name>Schneehut dunkelblau</name>
<creation_date>2016-03-25 17:22:22</creation_date>
<class>colorprod</class>
<seo>
<permalink>dunkelblau-schneehut-warm</permalink>
<title>Dunkelblauer Schneehut</title>
<description>Cooler Schneehut in dunkelblau</description>
<keywords>dunkelblau, Schneehut, Muetze</keywords>
</seo>

<availability>
<quantity>14</quantity>
<quantity_warning>6</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number>123321</element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>20</length>
<width>18</width>
<height>25</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="532">
<name>name</name>
<label>Name</label>
<value>Schneehut dunkelblau</value>
</attribute>

<attribute type="FLOAT" id="535">
<name>price</name>
<label>Preis</label>
<value>27.9</value>
</attribute>


</attributes>
<variations>

</variations>
</product>
                    

Explanation

idThe id of the product.
nameThe name of the product.
creation_dateThe creation date of the product.
classThe class of the product.
seoThe SEO - section for the product.
availabilityThe availability - section for the product.
metadataThe metadata section of the product.
attributesThe attributes section of the product.
variationsThe section containing all variations.

seo_get_content_details

Delivers the content - details for the content defined by its permalink.


Arguments

  • permalink (string)

    The permalink of the object.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='seo_get_content_details' \ -d permalink='impressum'


Here we are requesting the content - details for the content determined by its permalink. 

Response

                    {
  "object":"content",
  "id":52,
  "name":"imprint",
  "creation_date":"2016-07-29 16:04:24",
  "class":"content",
  
  
"seo":
{
  "permalink": "impressum",
  "title": "Impressum",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
            
                    "headline":

{
  "type":"CHAR",
  "id":647,
  "name":"headline",
  "label":"Überschrift",
  "value":"Impressum"
}


                                
            
    ,                                            "content":

{
  "type":"HTML",
  "id":648,
  "name":"content",
  "label":"Inhalt",
  "value":"<p>Hier steht das Impressum</p><br><p><br></p>"
}


    
            
    ,            "img":

{
  "type":"IMG",
  "id":649,
  "name":"img",
  "label":"Bild",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
        
    
  },
  "variations":{
  
    
    
 }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<content>
<id>52</id>
<name>imprint</name>
<creation_date>2016-07-29 16:04:24</creation_date>
<class>content</class>
<seo>
<permalink>impressum</permalink>
<title>Impressum</title>
<description></description>
<keywords></keywords>
</seo>

<attributes>
<attribute type="CHAR" id="647">
<name>headline</name>
<label>Überschrift</label>
<value>Impressum</value>
</attribute>

<attribute type="HTML" id="648">
<name>content</name>
<label>Inhalt</label>
<value>&amp;lt;p&amp;gt;Hier steht das Impressum&amp;lt;/p&amp;gt;&amp;lt;br&amp;gt;&amp;lt;p&amp;gt;&amp;lt;br&amp;gt;&amp;lt;/p&amp;gt;</value>
</attribute>

<attribute type="IMG" id="649">
<name>img</name>
<label>Bild</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>


</attributes>
<variations>

</variations>
</content>
                    

Explanation

idThe id of the content.
nameThe name of the content.
creation_dateThe creation date of the content.
classThe class of the content.
seoThe SEO - section for the content.
attributesThe attributes section of the content.
variationsThe section containing all variations. In the actual version this section will always be empty for content - objects.

create_product

This request can be used to create products. The request will be executed as long as an error occurs. In this case the error will be returned.


Arguments

  • class (string)

    The class of the new product.

  • name (string)

    The name of the new product.

  • shop_active (int)

    Indicating wether the product is shop_active or not. Use 1 for active an 0 for inactive.

  • attributes (json-array)

    A json - array with all attributes you want to set the value. 

  • seo (json-array)

    A json - array with all seo - attributes you want to set.

  • metadata (json-array)

    A json - array with all metadata you want to set.

  • availability (json-array)

    A json - array with all availability - data.

  • categories (json-array)

    A json - array containing all categories you want the product to be in.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.

  • licence_secret_key (string)

    Your licence - secret - key.


attributes (json-array):

The array is an associative array which has the language as key and an associative array for attributes for the corresponding language. Here you use the the name of the attribute as key and the desired value as value. As an example, if you want to set the attribute named attr1 with the value myvalue in the german language you would provide the following array:

{"de_DE":{"attr1":"myvalue"}}

seo (json-array):

The array is an associative array which has the language as key and an associative array for seo fields for the corresponding language. Here you use the the name of the seo element as key and the desired value as value. As an example, if you want to set the permalink with the value myvalue in the german language you would provide the following array:

{"de_DE":{"permalink":"myvalue"}}

The following fields are available:

  • permalink
  • title
  • description
  • keywords

metadata (json-array)

This array is an associative array containing the metadata as key and the desired value as value. As an example, if you want to set the element_number with the value 123 you can provide the following array:

{"element_number":"123"}

The following fields are available:

  • element_number
  • ean
  • length
  • width
  • height
  • kg

availability (json-array)

This array is an associative array containing the availability-field as key and the desired value as value. As an example, if you want to set the quantity with the value 123 you can provide the following array:

{"quantity":123}

The following fields are available:

  • quantity
  • quantity_warning
  • active (0 or 1)
  • allow_override (0 or 1)

categories (json-array)

This array is an  array containing the categories by name you want the product to be in. So if you want to add the product to the categories cat1 and cat2 then you provide the following array:

["cat1", "cat2]


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d licence_secret_key='your_secret_key' \ -d request='create_product' \ -d class='product' \ -d name='name_new' \ -d shop_active=1 \ -d attributes='{"de_DE":{"name":"Test"}}' \ -d metadata='{"element_number":"123321"}' \ -d seo='{"de_DE":{"permalink":"test546576"}}' \ -d availability='{"quantity":2,"active":1}'


Response

                    {
  "object":"create_product",
  "id":"162"
  
 
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_product>
<id>161</id>
</create_product>
                    

Explanation

idThe id of the product just created.

update_product

This request can be used to update products. The request will be executed as long as an error occurs. In this case the error will be returned.


Arguments

  • id_product (int)

    The id of the product you want to update.

  • name (string)

    The name of the new product.

  • shop_active (int)

    Indicating wether the product is shop_active or not. Use 1 for active an 0 for inactive.

  • attributes (json-array)

    A json - array with all attributes you want to set the value. 

  • seo (json-array)

    A json - array with all seo - attributes you want to set.

  • metadata (json-array)

    A json - array with all metadata you want to set.

  • availability (json-array)

    A json - array with all availability - data.

  • categories (json-array)

    A json - array containing all categories you want the product to be in.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.

  • licence_secret_key (string)

    Your licence - secret - key.


attributes (json-array):

The array is an associative array which has the language as key and an associative array for attributes for the corresponding language. Here you use the the name of the attribute as key and the desired value as value. As an example, if you want to set the attribute named attr1 with the value myvalue in the german language you would provide the following array:

{"de_DE":{"attr1":"myvalue"}}

seo (json-array):

The array is an associative array which has the language as key and an associative array for seo fields for the corresponding language. Here you use the the name of the seo element as key and the desired value as value. As an example, if you want to set the permalink with the value myvalue in the german language you would provide the following array:

{"de_DE":{"permalink":"myvalue"}}

The following fields are available:

  • permalink
  • title
  • description
  • keywords

metadata (json-array)

This array is an associative array containing the metadata as key and the desired value as value. As an example, if you want to set the element_number with the value 123 you can provide the following array:

{"element_number":"123"}

The following fields are available:

  • element_number
  • ean
  • length
  • width
  • height
  • kg

availability (json-array)

This array is an associative array containing the availability-field as key and the desired value as value. As an example, if you want to set the quantity with the value 123 you can provide the following array:

{"quantity":123}

The following fields are available:

  • quantity
  • quantity_warning
  • active (0 or 1)
  • allow_override (0 or 1)

categories (json-array)

This array is an  array containing the categories by name you want the product to be in. So if you want to add the product to the categories cat1 and cat2 then you provide the following array:

["cat1", "cat2]


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d licence_secret_key='your_secret_key' \ -d request='update_product' \ -d id_product=163 \ -d name='name_new2' \ -d shop_active=1 \ -d attributes='{"de_DE":{"name":"Test"}}' \ -d metadata='{"element_number":"12asddsa3321"}' \ -d seo='{"de_DE":{"permalink":"test546576"}}' \ -d availability='{"quantity":2,"active":1}'


Response

                    {
  "object":"update_product",
  "status":"success"
  
 
}
                    

                      <update_product>
<status>success</status>
</update_product>
                    

Explanation

statusThe status of the operation.

create_variation

This request can be used to create variations of products. The request will be executed as long as an error occurs. In this case the error will be returned.


Arguments

  • id_product (int)

    The id of the product you want to create a variation for.

  • name (string)

    The name of the new product.

  • shop_active (int)

    Indicating wether the product is shop_active or not. Use 1 for active an 0 for inactive.

  • attributes (json-array)

    A json - array with all attributes you want to set the value. 

  • seo (json-array)

    A json - array with all seo - attributes you want to set.

  • metadata (json-array)

    A json - array with all metadata you want to set.

  • availability (json-array)

    A json - array with all availability - data.

  • categories (json-array)

    A json - array containing all categories you want the product to be in.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.

  • licence_secret_key (string)

    Your licence - secret - key.


attributes (json-array):

The array is an associative array which has the language as key and an associative array for attributes for the corresponding language. Here you use the the name of the attribute as key and the desired value as value. As an example, if you want to set the attribute named attr1 with the value myvalue in the german language you would provide the following array:

{"de_DE":{"attr1":"myvalue"}}

seo (json-array):

The array is an associative array which has the language as key and an associative array for seo fields for the corresponding language. Here you use the the name of the seo element as key and the desired value as value. As an example, if you want to set the permalink with the value myvalue in the german language you would provide the following array:

{"de_DE":{"permalink":"myvalue"}}

The following fields are available:

  • permalink
  • title
  • description
  • keywords

metadata (json-array)

This array is an associative array containing the metadata as key and the desired value as value. As an example, if you want to set the element_number with the value 123 you can provide the following array:

{"element_number":"123"}

The following fields are available:

  • element_number
  • ean
  • length
  • width
  • height
  • kg

availability (json-array)

This array is an associative array containing the availability-field as key and the desired value as value. As an example, if you want to set the quantity with the value 123 you can provide the following array:

{"quantity":123}

The following fields are available:

  • quantity
  • quantity_warning
  • active (0 or 1)
  • allow_override (0 or 1)

categories (json-array)

This array is an  array containing the categories by name you want the product to be in. So if you want to add the product to the categories cat1 and cat2 then you provide the following array:

["cat1", "cat2]


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d licence_secret_key='your_secret_key' \ -d request='create_variation' \ -d id_product=163 \ -d name='name_new_variation' \ -d shop_active=1 \ -d attributes='{"de_DE":{"name":"Test"}}' \ -d metadata='{"element_number":"123321"}' \ -d seo='{"de_DE":{"permalink":"test546576"}}' \ -d availability='{"quantity":2,"active":1}'


Response

                    {
  "object":"create_variation",
  "id":"165"
  
 
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_variation>
<id>165</id>
</create_variation>
                    

Explanation

idThe id of the product just created.

search_products

Delivers products matching the constraint defined.


Arguments

  • constraint (json-array)

    A constraint defining defining which products to deliver.

  • language (string)

    A valid language-code.

  • country (string)

    A valid country-code.

  • order_columns (json-array)

    The order columns.

  • order_type (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='search_products' \ -d constraint='{"name":["LIKE","a"]}' \ -d language="de_DE" \ -d country="DE" \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=2 \ -d needed_attributes='["name","price"]'


Here we are requesting the products matching the constraint. We want the products to be listed in german defined by the language - code "de_DE" for the country germany defined by the country - code "DE". Further we want the products to be listed ordered by the price descending. Left - limit is 0 an right - limit is 2 so only 2 product will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {
  "object":"search_products_result",
  "count":16,
  "limit_count":2,
  "result":[
  
    
{
  "object":"product",
  "id":30,
  "name":"Polar Jacket blau",
  "creation_date":"2016-03-25 14:36:37",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "blaue-funktionsjacke-baumwolle",
  "title": "Damen Funktionsjacke aus BIO-Baumwolle",
  "description": "Blaue Funktionsjacke für Damen",
  "keywords": "damen,blau,bio,baumwolle,funktionsjacke"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":366,
  "name":"name",
  "label":"Name",
  "value":"Polar Jacket blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":369,
  "name":"price",
  "label":"Preis",
  "value":75
}


                
                                                                                                
    
  },
  "variations":{
  
      "Polar Jacket pink":
  
{
  "object":"product",
  "id":31,
  "name":"Polar Jacket pink",
  "creation_date":"2016-03-25 14:37:29",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "polar-jacket-damen",
  "title": "Pinke Funktionsjacke für Damen",
  "description": "Damenjacke in Top-Qualität",
  "keywords": "warm,jacke,damen,pink"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":381,
  "name":"name",
  "label":"Name",
  "value":"Polar Jacket pink"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":384,
  "name":"price",
  "label":"Preis",
  "value":75
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}


    ,
      
{
  "object":"product",
  "id":34,
  "name":"Mütze orange",
  "creation_date":"2016-03-25 16:19:24",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "muetze-orange-onesize",
  "title": "Trendige Mütze mit Aztekenmuster",
  "description": "Superwarme und flauschige Mütze",
  "keywords": "warm, flauschig, orange, muetze, aztekenmuster"
}

,
  
"availability":
{
  "quantity": 1,
  "quantity_warning": 3,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":422,
  "name":"name",
  "label":"Name",
  "value":"Mu00fctze orange"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":425,
  "name":"price",
  "label":"Preis",
  "value":17.5
}


                
                                                                                                
    
  },
  "variations":{
  
      "Mütze blau":
  
{
  "object":"product",
  "id":35,
  "name":"Mütze blau",
  "creation_date":"2016-03-25 16:20:50",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "gemusterte-blaue-muetze",
  "title": "Moderne Mütze mit Aztekenmuster und süßen Fransen",
  "description": "Superwarme Mütze mit Fransendetails",
  "keywords": "warm, muetze, fransen, aztekenmuster, unisex"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":437,
  "name":"name",
  "label":"Name",
  "value":"Mu00fctze blau"
}


                                
                            
    ,                                "price":

{
  "type":"FLOAT",
  "id":440,
  "name":"price",
  "label":"Preis",
  "value":17.5
}


                
                                                                                                
    
  },
  "variations":{
  
    
    
 }
}


  
    
 }
}


    
  ]

}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<search_products_result>
 <count>
  15
 </count>
 <limit_count>
   2
 </limit_count>
<product>
<id>40</id>
<name>Sneakers</name>
<creation_date>2016-03-25 16:47:51</creation_date>
<class>sizeprod</class>
<seo>
<permalink>gruene-sneaker-leder</permalink>
<title>Grüne Herrensneaker aus Leder</title>
<description>Modischer Sneaker fuer Herren</description>
<keywords>gruen,sneaker,leder,italienisch</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number>123</element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>26</length>
<width>8</width>
<height>4</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="506">
<name>name</name>
<label>Name</label>
<value>Sneakers grün</value>
</attribute>

<attribute type="FLOAT" id="509">
<name>price</name>
<label>Preis</label>
<value>65</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>30</id>
<name>Polar Jacket blau</name>
<creation_date>2016-03-25 14:36:37</creation_date>
<class>colorprod</class>
<seo>
<permalink>blaue-funktionsjacke-baumwolle</permalink>
<title>Damen Funktionsjacke aus BIO-Baumwolle</title>
<description>Blaue Funktionsjacke für Damen</description>
<keywords>damen,blau,bio,baumwolle,funktionsjacke</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="366">
<name>name</name>
<label>Name</label>
<value>Polar Jacket blau</value>
</attribute>

<attribute type="FLOAT" id="369">
<name>price</name>
<label>Preis</label>
<value>75</value>
</attribute>


</attributes>
<variations>
<product>
<id>31</id>
<name>Polar Jacket pink</name>
<creation_date>2016-03-25 14:37:29</creation_date>
<class>colorprod</class>
<seo>
<permalink>polar-jacket-damen</permalink>
<title>Pinke Funktionsjacke für Damen</title>
<description>Damenjacke in Top-Qualität</description>
<keywords>warm,jacke,damen,pink</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="381">
<name>name</name>
<label>Name</label>
<value>Polar Jacket pink</value>
</attribute>

<attribute type="FLOAT" id="384">
<name>price</name>
<label>Preis</label>
<value>75</value>
</attribute>


</attributes>
<variations>

</variations>
</product>


</variations>
</product>


</search_products_result>
                    

Explanation

countThe total number of objects matching the constraint.
limit_countThe number of objects matching our limitations.
resultA listing of all products the search delivered.

search_contents

Allows you to search contents matching a determined constraint.


Arguments

  • constraint (json-array)

    The constraint determining which contents to deliver.

  • language (string)

    A valid language-code.

  • country (string)

    A valid country-code.

  • order_columns (json-array)

    The order column.

  • order_type (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • needed_attributes (json-array)

    This arrays specifies a selection of attributes you want to be listed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='search_contents' \ -d constraint='{"main.name":["LIKE","a"]}' \ -d language="de_DE" \ -d country="DE" \ -d order_column="price" \ -d order="DESC" \ -d left_limit=0 \ -d right_limit=2 \ -d needed_attributes='["name","price"]'


Here we are requesting the contents where the name is like "a". We want the contents to be listed in german defined by the language - code "de_DE". Further we want the products to be listed ordered by the price descending. Left - limit is 0 an right - limit is 2 so only 2 contents will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {
  "object":"search_contents_result",
  "count":3,
  "limit_count":2,
  "result":[
  
    
{
  "object":"content",
  "id":5,
  "name":"Teaser 1",
  "creation_date":"2016-03-25 12:38:23",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
                                
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"content",
  "id":6,
  "name":"Teaser 2",
  "creation_date":"2016-03-25 12:42:29",
  "class":"teaser_pic",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  "attributes":{
                                
    
  },
  "variations":{
  
    
    
 }
}


    
  ]

}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<search_contents_result>
 <count>
  3
 </count>
 <limit_count>
   2
 </limit_count>
<content>
<id>5</id>
<name>Teaser 1</name>
<creation_date>2016-03-25 12:38:23</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>

</attributes>
<variations>

</variations>
</content>

<content>
<id>6</id>
<name>Teaser 2</name>
<creation_date>2016-03-25 12:42:29</creation_date>
<class>teaser_pic</class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<attributes>

</attributes>
<variations>

</variations>
</content>


</search_contents_result>
                    

Explanation

countThe total number of objects matching the constraint.
limit_countThe number of objects matching our limitations.
resultA listing of all products the search delivered.

search_distinct_products

Delivers the distinct values of a field in a set of products matching the constraint.


Arguments

  • constraint (json-array)

    A valid constraint array in json-format.

  • field (string)

    A field-name.

  • language (string)

    A valid language-code.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='search_distinct_products' \ -d field='name' \ -d constraint='{"main.name":["LIKE","a"]}' \ -d language="de_DE"


Here we are searching the distinct value of the field name in the set of products where main.name value is like "a"

Response

                    {
  "object":"search_distinct_products_result",
  "count":13,
  "result":[
   
      "Polar Jacket pink"      ,
         "Polar Jacket blau"      ,
         "winterjacke rot L"      ,
         "Winterjacke rot S"      ,
         "Winterjacke rot M"      ,
         "winterjacke rot XL"      ,
         "Laufschuh blau"      ,
         "Sneakers italian"      ,
         "Schneehut dunkelblau"      ,
         "Mütze blau"      ,
         "Mütze orange"      ,
         "Sneakers grün"      ,
         " Schneehut schwarz"      
   
  ]
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<search_distinct_products_result>
 <count>
  13
</count>
<field>Polar Jacket pink</field>
<field>Polar Jacket blau</field>
<field>winterjacke rot L</field>
<field>Winterjacke rot S</field>
<field>Winterjacke rot M</field>
<field>winterjacke rot XL</field>
<field>Laufschuh blau</field>
<field>Sneakers italian</field>
<field>Schneehut dunkelblau</field>
<field>Mütze blau</field>
<field>Mütze orange</field>
<field>Sneakers grün</field>
<field> Schneehut schwarz</field>

</search_distinct_products_result>
                    

Explanation

countThe count of found elements.
fieldA set of field values.

search_orders

Delivers all orders matching the constraint.


Arguments

  • constraint (json-array)

    A valid constraint.

  • language (string)

    A valid language-code.

  • order_columns (json-array)

    The order column.

  • order_type (string)

    The order of sorting, valid values are ASC (ascending) or DESC (descending).

  • left_limit (int)

    The left limit of your selection.

  • right_limit (int)

    The right limit of your selection.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='search_orders' \ -d constraint='{"delivery_firstname":"kaveh"}' \ -d language="de_DE" \ -d left_limit=0 \ -d right_limit=1


Here we are requesting the orders matching the constraint that defines we want all orders with the delivery_firstname="kaveh"

Response

                    {
  "object":"search_orders_result",
  "orders":[
   
       
    {
      "id":3,
      "order_number":3,
      "creation_date":"2016-11-13 16:31:46",
      "order_delivery_companyname":"sleekcommerce UG",
      "order_delivery_department":"",
      "order_delivery_salutation":"Herr",
      "order_delivery_firstname":"kaveh",
      "order_delivery_lastname":"raji",
      "order_delivery_street":"Max-Brauer-Allee",
      "order_delivery_number":"218",
      "order_delivery_zip":"22769",
      "order_delivery_state":"Hamburg",
      "order_delivery_city":"Hamburg",
      "order_delivery_country":"Germany",
      "order_invoice_companyname":"sleekcommerce UG",
      "order_invoice_department":"",
      "order_invoice_salutation":"Herr",
      "order_invoice_firstname":"kaveh",
      "order_invoice_lastname":"raji",
      "order_invoice_street":"Max-Brauer-Allee",
      "order_invoice_number":"218",
      "order_invoice_zip":"22769",
      "order_invoice_state":"Hamburg",
      "order_invoice_city":"Hamburg",
      "order_invoice_country":"Germany",
      "order_email":"info@vitabytes.de",
      "order_phone":"",
      "order_note":"",
      "payment_method":"PrePayment",
      "payment_state":
      {
        "name":"PAYMENT_NOT_RECEIVED",
        "label":"Zahlung nicht erhalten"
      },
      "delivery_method":"Shipping",
      "delivery_state":{
        "name":"PROCESSING",
        "label":"In Bearbeitung"
      },
      "order_state":"PROCESSING",
      "attributes":{
         
         
         
      },
      "cart":
      {
        
                
        "creation_date":"2016-11-13 16:20:11",
        "sum":18.9,
        
        
"contents":[
  
     

{
    "type":"FREE_ELEMENT",
    "id":190,
    "id_product":36,
    "quantity":1,
    "price":18.9,
    "sum_price":18.9,
    "tax":3.01765,
    "sum_tax":3.01765,
    "name":" Schneehut schwarz",
    "description":"Superflauschiger Schneehut in schwarz - OneSize",
    "attributes":{
       
                                   "pic":
       
       {
         "name":"pic",
         "value":"http://demo.sleekshop.net/srv/uploads/shopobject_images/5d618534dfd89666cf496cece4355397.jpg"
       }
       
              ,              "sys_tax":
       
       {
         "name":"sys_tax",
         "value":"0.19"
       }
       
              ,              "sys_tax_calc":
       
       {
         "name":"sys_tax_calc",
         "value":"INC"
       }
       
              ,              "sys_length":
       
       {
         "name":"sys_length",
         "value":"23"
       }
       
              ,              "sys_width":
       
       {
         "name":"sys_width",
         "value":"15"
       }
       
              ,              "sys_height":
       
       {
         "name":"sys_height",
         "value":"26"
       }
       
              ,              "sys_weight":
       
       {
         "name":"sys_weight",
         "value":"0"
       }
       
              ,              "sys_notes":
       
       {
         "name":"sys_notes",
         "value":""
       }
       
       
       
    }
  }






      ,
        




{
    "type":"DELIVERY_COSTS",
    "id":191,
    "id_product":0,
    "quantity":1,
    "price":0,
    "sum_price":0,
    "tax":0,
    "sum_tax":0,
    "name":"Versandkosten",
    "description":" ",
    "attributes":{
       
                                   "sys_tax":
       
       {
         "name":"sys_tax",
         "value":"0.19"
       }
       
              ,              "sys_tax_calc":
       
       {
         "name":"sys_tax_calc",
         "value":"INC"
       }
       
              ,              "sys_length":
       
       {
         "name":"sys_length",
         "value":"0"
       }
       
              ,              "sys_width":
       
       {
         "name":"sys_width",
         "value":"0"
       }
       
              ,              "sys_height":
       
       {
         "name":"sys_height",
         "value":"0"
       }
       
              ,              "sys_weight":
       
       {
         "name":"sys_weight",
         "value":"0"
       }
       
              ,              "sys_notes":
       
       {
         "name":"sys_notes",
         "value":""
       }
       
       
       
    }
}



     
  
],
"delivery_costs":{
     "sum":0,
     "positions":[
      
      
       
     ]
}


        
      },
      "parcels":
      [
      
                
        {
        "id":9,
        "width":20,
        "length":15,
        "height":8,
        "weight":"20",
        "arg1":"",
        "arg2":"",
        "arg3":""
        }
        
                
        
      ]
    }
    
       
   
 ]
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<search_orders_result>
<order>
<id>3</id>
<order_number>3</order_number>
<creation_date>2016-11-13 16:31:46</creation_date>
<order_delivery_companyname>sleekcommerce UG</order_delivery_companyname>
<order_delivery_department></order_delivery_department>
<order_delivery_salutation>Herr</order_delivery_salutation>
<order_delivery_firstname>kaveh</order_delivery_firstname>
<order_delivery_lastname>raji</order_delivery_lastname>
<order_delivery_street>Max-Brauer-Allee</order_delivery_street>
<order_delivery_number></order_delivery_number>
<order_delivery_zip>22769</order_delivery_zip>
<order_delivery_state>Hamburg</order_delivery_state>
<order_delivery_city>Hamburg</order_delivery_city>
<order_delivery_country>Germany</order_delivery_country>
<order_invoice_companyname>sleekcommerce UG</order_invoice_companyname>
<order_invoice_department></order_invoice_department>
<order_invoice_salutation>Herr</order_invoice_salutation>
<order_invoice_firstname>kaveh</order_invoice_firstname>
<order_invoice_lastname>raji</order_invoice_lastname>
<order_invoice_street>Max-Brauer-Allee</order_invoice_street>
<order_invoice_number>218</order_invoice_number>
<order_invoice_zip>22769</order_invoice_zip>
<order_invoice_state>Hamburg</order_invoice_state>
<order_invoice_city>Hamburg</order_invoice_city>
<order_invoice_country>Germany</order_invoice_country>
<order_email>info@vitabytes.de</order_email>
<order_phone></order_phone>
<order_note></order_note>
<payment_method>PrePayment</payment_method>
<payment_state><name>PAYMENT_NOT_RECEIVED</name><label>Zahlung nicht erhalten</label></payment_state>
<delivery_method>Shipping</delivery_method>
<delivery_state><name>PROCESSING</name><label>In Bearbeitung</label></delivery_state>
<order_state>PROCESSING</order_state>
<attributes></attributes>
<cart>
<creation_date>2016-11-13 16:20:11</creation_date>
<sum>18.9</sum>
<contents>
   
 <element type="FREE_ELEMENT">
 <id>190</id>
 <id_product>36</id_product>
 <quantity>1</quantity>
 <price>18.9</price>
 <sum_price>18.9</sum_price>
<tax>3.01765</tax>
<sum_tax>3.01765</sum_tax>
<name> Schneehut schwarz</name>
<description>Superflauschiger Schneehut in schwarz - OneSize</description>
<attributes><attribute name="pic">http://demo.sleekshop.net/srv/uploads/shopobject_images/5d618534dfd89666cf496cece4355397.jpg</attribute><attribute name="sys_tax">0.19</attribute><attribute name="sys_tax_calc">INC</attribute><attribute name="sys_length">23</attribute><attribute name="sys_width">15</attribute><attribute name="sys_height">26</attribute><attribute name="sys_weight">0</attribute><attribute name="sys_notes"></attribute></attributes>
</element>





   



 <element type="DELIVERY_COSTS">
 <id>191</id>
 <id_product>0</id_product>
 <quantity>1</quantity>
 <price>0</price>
 <sum_price>0</sum_price>
<tax>0</tax>
<sum_tax>0</sum_tax>
<name>Versandkosten</name>
<description> </description>
<attributes><attribute name="sys_tax">0.19</attribute><attribute name="sys_tax_calc">INC</attribute><attribute name="sys_length">0</attribute><attribute name="sys_width">0</attribute><attribute name="sys_height">0</attribute><attribute name="sys_weight">0</attribute><attribute name="sys_notes"></attribute></attributes>
</element>


 
</contents>
<delivery_costs>
<sum></sum>
<positions>

</positions>
</delivery_costs>

</cart>
<parcels>
<parcel>
<id>9</id>
<width>20</width>
<length>15</length>
<height>8</height>
<weight>20</weigth>
<arg1></arg1>
<arg2></arg2>
<arg3></arg3>
</parcel>

</parcels>
</order>

</search_orders_result>
                    

Explanation

idThe id of the order.
order_numberThe order number.
creation_dateThe creation date of the order.
order_delivery fieldsSome fields showing the delivery - data.
order_invoice fieldsSome fields showing the invoice - data.
order_emailThe email of the order.
order_phoneThe order - phone number.
order_notesThe notes for the order.
payment_methodThe payment method.
payment_stateThe payment state informations.
delivery_methodThe delivery method.
delivery_stateThe delivery state informations.
order_stateThe state of the order.
cartThe cart and cart - contents of the order.
parcelsThe corresponding parcels of the order.

Adressing attributes

Before constraints can be formed, you need to understand how to address the needed attributes.

Shopobject attributes

Class attributes

You can formulate constraints with different attributes. The normal attributes can be addressed by their names defined in the object - definition.

If you have objects with an attribute named as "name" you can search for products which have the name : "test" when you formulate a constraint like this: 

{"name":"test"}


Main attributes

Each object has also so called "main-attributes" which also can be addressed. These main attributes are the following ones: 

  • id_shopobject (the id of the object)
  • name (the system name of the object)
  • creation_date (the creation date of the object)
  • class (the class of the object)

If you want to address one of these attributes you have to put the "main-modifier" in front of it. As example, if you want to find objects with the class: product you can form a constraint like this: 

{"main.class":"product"}


Categories

You can also address the corresponding categories of an object. Therefore you have to use the "categories-modifier". 

The following category - attributes are available: 

  • id_shopcategory(the id of the category)
  • name (the name of the category)
  • id_shopcategory_parent (the id of the parent category)
  • label (the label of the category)

An example constraint could look like this: 

{"category.name":"Start"}

or 

{"category.id_shopcategory":1}


Metadata

Some objects (products) also have metadata informations which also can be addressed. To achieve this you have to use the "metadata-modifier".

The following metadata-attributes can be user:

  • element_number (The unique number of the element SKU)
  • length 
  • width
  • height
  • weight

To search for objects with with the element_number 123 you can use a constraint like this:

{"metadata.element_number":"123"}


Availability

There is also the possibility to address the availability attributes of shopobjects (products):

  • quantity (the available quantity)
  • quantity_warning (the warning quantity)
  • allow_override (a flag showing wether an override is allowed or not)

To address these attributes you have to use the "availability - modifier". If you search for products with an availability of 1 you can form the following constraint:

{"availability.quantity":1}


Order attributes

There several possibilities to address order - data attributes. The following fields are available:

  • id_order (the id of the order)
  • order_number (the order number)
  • delivery_companyname
  • delivery_department
  • delivery_salutation
  • delivery_firstname
  • delivery_lastname
  • delivery_street
  • delivery_number
  • delivery_zip
  • delivery_state
  • delivery_city
  • delivery_country
  • invoice_companyname
  • invoice_department
  • invoice_salutation
  • invoice_firstname
  • invoice_lastname
  • invoice_street
  • invoice_number
  • invoice_zip
  • invoice_state
  • invoice_city
  • invoice_country
  • email
  • phone
  • notes




Forming constraints

There are a lot of possibilities to form search constraints. This rich set of elements you can combine enables the formulation of very complex queries which are executed fast and reliable.

AND catenation

You can form easily a combination of AND combination of attributes. To do that you use valid attributes and values combinations in you j-son array, seperated by a comma.

The following example shows a constraint querying all products with the name: test and a price of 100:

{"name":"test", "price":100}


OR catenation

The OR constraints alway begin {with the OR - keyword followed by several attrubute:values combinations. This pieces can be terms with arbitary complexity. The following constraint searches for products with the name:"test" or price:100:

[{"OR":{"name":"test"},"0":{"price":100}}]


Between operator

You can query objects using the between operator.  You use an attribute identifier where you define a between array as value. 

If you for example want to query products where the price is between 30 and 90 you can formulate the following constraint: 

{"price":["BETWEEN",30,90]}


> (Greater than operator)

The greater than operator is used similar to the between operator. You define a valid attribute and use a json-array as value. If you search all products with the price greater than 100 you can use the following constraint:

{"price":[">",100]}


< (Less than operator)

The less than operator works exactly like the greater than operator. If you are looking for products with a price less than 100, you can form the following constraint:

{"price":["<",100]}


LIKE operator

The like operator allows you to implement  fulltext - search over your attributes.  You can use the LIKE - operator by defining an attribute with an array as value where you use the like - operator. If you are searching for objects where the name is like "a" then you can use the following statement: 

{"name":["LIKE","a"]}


IN operator

You can query objects where the desired attribute - value is in an set of given values. As an example you can query all objects with a price in the following set : 100,99,98: 

{"price":["IN",[100,99,98]]}


Complex constraints

The power of the search service unleashes when you start combining all the explained operators. You can combine them in all needed ways as long you have a well-formed json-array.

In the following example we want to query all products where the main name is like "a" and the price bigger than 10 or less than 8:

{"main.name":["LIKE","a"],"0":{"OR":{"price":[">",10]},"0":{"price":["<",8]}}}




add_to_cart

Adds an element to the cart determined by a session.


Arguments

  • session (string)

    A valid session code.

  • id_shopobject (int)

    The id of the object you want to add to the cart. The value can also be 0. This is interesting for FREE_ELEMENTS.

  • element_type (string)

    A valid element_type. Valid values are: PRODUCT, PRODUCT_GR, FREE_ELEMENT, FREE_ELEMENT_GR.

  • id_parent_element (int)

    If needed you can add a parent element. This value can also be 0 when no parent is needed.

  • quantity (float)

    The quantity you want to be added.

  • price_field (string)

    A field determining the field the the price is stored. For free elements you can also set the price directly.

  • name_field (string)

    A field determining where the name is stored.

  • description_field (string)

    A field where the description is stored.

  • language (string)

    A valid language - code.

  • country (string)

    A valid country - code.

  • attributes (json-array)

    Additional attributes you want to be stored.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='add_to_cart' \ -d session=A_VALID_SESSION_CODE \ -d id_shopobject=42 \ -d element_type="PRODUCT" \ -d id_parent_element=0 \ -d quantity=1 \ -d price_field="price" \ -d name_field="name" \ -d description_field="short_description" \ -d language="de_DE" \ -d country="DE"


Here we want to insert a cart into the session cart determined by the session-attribute. The product id is 42 and we want the name field to be used as name and the short_description field as description for the cart element. The price is read out of the price - field. Quantity is 1.

Response

                    {
  "object":"cart",
  "creation_date":"2018-08-09 21:16:15",
  "sum":27.9,
  "last_inserted_element_id":498,
  
  
"contents":[
  
      
{
    "type":"PRODUCT",
    "id":498,
    "id_product":42,
    "quantity":1,
    "price":27.9,
    "sum_price":27.9,
    "tax":4.45462,
    "sum_tax":4.45462,
    "name":"Schneehut dunkelblau",
    "description":"Warmer und superweicher Schneehut in dunkelblau",
    "attributes":{
       
                                   "sys_tax":
       
       {
         "name":"sys_tax",
         "value":"0.19"
       }
       
              ,              "sys_tax_calc":
       
       {
         "name":"sys_tax_calc",
         "value":"INC"
       }
       
              ,              "sys_length":
       
       {
         "name":"sys_length",
         "value":"20"
       }
       
              ,              "sys_width":
       
       {
         "name":"sys_width",
         "value":"18"
       }
       
              ,              "sys_height":
       
       {
         "name":"sys_height",
         "value":"25"
       }
       
              ,              "sys_weight":
       
       {
         "name":"sys_weight",
         "value":"0"
       }
       
              ,              "sys_notes":
       
       {
         "name":"sys_notes",
         "value":""
       }
       
       
       
    }
  }







     
  
],
"delivery_costs":{
     "sum":0,
     "positions":[
      
      
       
     ]
}


  
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<cart>
<creation_date>2018-08-09 21:16:15</creation_date>
<sum>55.8</sum>
<last_inserted_element_id>498</last_inserted_element_id>
<contents>
     <element type="PRODUCT">
 <id>498</id>
 <id_product>42</id_product>
 <quantity>2</quantity>
 <price>27.9</price>
 <sum_price>55.8</sum_price>
 <tax>4.45462</tax>
<sum_tax>8.90924</sum_tax>
<name>Schneehut dunkelblau</name>
<description>Warmer und superweicher Schneehut in dunkelblau</description>
<attributes><attribute name="sys_tax">0.19</attribute><attribute name="sys_tax_calc">INC</attribute><attribute name="sys_length">20</attribute><attribute name="sys_width">18</attribute><attribute name="sys_height">25</attribute><attribute name="sys_weight">0</attribute><attribute name="sys_notes"></attribute></attributes> 
</element>






 
</contents>
<delivery_costs>
<sum>0</sum>
<positions>

</positions>
</delivery_costs>

</cart>

                    

Explanation

creation_dateDate of creation.
sumThe total sum of the cart.
last_inserted_element_idThe id of the last element id which was inserted.
productsSection containing all products in the category.
contentsA section containing all cart elements.
delivery_costsA section containing the calculated delivery costs.

sub_from_cart

Decreases an element from the cart by one.


Arguments

  • session (string)

    A valid session string.

  • id_element (int)

    A valid element_id. This is the id which is set by the cart, not the id_product.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='sub_from_cart' \ -d session='A_VALID_SESSION_ID' \ -d id_element=A_VALID_ELEMENT_ID


Here we decrease the element count in the cart with the an id that has to be a valid element id.

Response

                    {
  "object":"cart",
  "creation_date":"2018-08-09 21:16:15",
  "sum":27.9,
  
  
"contents":[
  
      
{
    "type":"PRODUCT",
    "id":498,
    "id_product":42,
    "quantity":1,
    "price":27.9,
    "sum_price":27.9,
    "tax":4.45462,
    "sum_tax":13.3639,
    "name":"Schneehut dunkelblau",
    "description":"Warmer und superweicher Schneehut in dunkelblau",
    "attributes":{
       
                                   "sys_tax":
       
       {
         "name":"sys_tax",
         "value":"0.19"
       }
       
              ,              "sys_tax_calc":
       
       {
         "name":"sys_tax_calc",
         "value":"INC"
       }
       
              ,              "sys_length":
       
       {
         "name":"sys_length",
         "value":"20"
       }
       
              ,              "sys_width":
       
       {
         "name":"sys_width",
         "value":"18"
       }
       
              ,              "sys_height":
       
       {
         "name":"sys_height",
         "value":"25"
       }
       
              ,              "sys_weight":
       
       {
         "name":"sys_weight",
         "value":"0"
       }
       
              ,              "sys_notes":
       
       {
         "name":"sys_notes",
         "value":""
       }
       
       
       
    }
  }







     
  
],
"delivery_costs":{
     "sum":0,
     "positions":[
      
      
       
     ]
}


  
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<cart>
<creation_date>2018-08-09 21:16:15</creation_date>
<sum>55.8</sum>
<contents>
     <element type="PRODUCT">
 <id>498</id>
 <id_product>42</id_product>
 <quantity>2</quantity>
 <price>27.9</price>
 <sum_price>55.8</sum_price>
 <tax>4.45462</tax>
<sum_tax>13.3639</sum_tax>
<name>Schneehut dunkelblau</name>
<description>Warmer und superweicher Schneehut in dunkelblau</description>
<attributes><attribute name="sys_tax">0.19</attribute><attribute name="sys_tax_calc">INC</attribute><attribute name="sys_length">20</attribute><attribute name="sys_width">18</attribute><attribute name="sys_height">25</attribute><attribute name="sys_weight">0</attribute><attribute name="sys_notes"></attribute></attributes> 
</element>






 
</contents>
<delivery_costs>
<sum>0</sum>
<positions>

</positions>
</delivery_costs>

</cart>
                    

Explanation

cartDelivers a cart.

del_from_cart

Deletes an element from the cart.


Arguments

  • session (string)

    A valid session string.

  • id_element (int)

    A valid element_id. This is the id which is set by the cart, not the id_product.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='del_from_cart' \ -d session='A_VALID_SESSION_ID' \ -d id_element=A_VALID_ELEMENT_ID


Here we delete the element in the cart with the an id that has to be a valid element id.

Response

                    {
  "object":"cart",
  "creation_date":"2018-08-09 21:16:15",
  "sum":27.9,
  
  
"contents":[
  
      
{
    "type":"PRODUCT",
    "id":498,
    "id_product":42,
    "quantity":1,
    "price":27.9,
    "sum_price":27.9,
    "tax":4.45462,
    "sum_tax":13.3639,
    "name":"Schneehut dunkelblau",
    "description":"Warmer und superweicher Schneehut in dunkelblau",
    "attributes":{
       
                                   "sys_tax":
       
       {
         "name":"sys_tax",
         "value":"0.19"
       }
       
              ,              "sys_tax_calc":
       
       {
         "name":"sys_tax_calc",
         "value":"INC"
       }
       
              ,              "sys_length":
       
       {
         "name":"sys_length",
         "value":"20"
       }
       
              ,              "sys_width":
       
       {
         "name":"sys_width",
         "value":"18"
       }
       
              ,              "sys_height":
       
       {
         "name":"sys_height",
         "value":"25"
       }
       
              ,              "sys_weight":
       
       {
         "name":"sys_weight",
         "value":"0"
       }
       
              ,              "sys_notes":
       
       {
         "name":"sys_notes",
         "value":""
       }
       
       
       
    }
  }







     
  
],
"delivery_costs":{
     "sum":0,
     "positions":[
      
      
       
     ]
}


  
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<cart>
<creation_date>2018-08-09 21:16:15</creation_date>
<sum>55.8</sum>
<contents>
     <element type="PRODUCT">
 <id>498</id>
 <id_product>42</id_product>
 <quantity>2</quantity>
 <price>27.9</price>
 <sum_price>55.8</sum_price>
 <tax>4.45462</tax>
<sum_tax>13.3639</sum_tax>
<name>Schneehut dunkelblau</name>
<description>Warmer und superweicher Schneehut in dunkelblau</description>
<attributes><attribute name="sys_tax">0.19</attribute><attribute name="sys_tax_calc">INC</attribute><attribute name="sys_length">20</attribute><attribute name="sys_width">18</attribute><attribute name="sys_height">25</attribute><attribute name="sys_weight">0</attribute><attribute name="sys_notes"></attribute></attributes> 
</element>






 
</contents>
<delivery_costs>
<sum>0</sum>
<positions>

</positions>
</delivery_costs>

</cart>
                    

Explanation

cartDelivers a cart.

get_cart

Delivers the cart and its contents from a given session.


Arguments

  • session (string)

    A valid session.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_cart' \ -d session='A_VALID_SESSION'


Here we are requesting the products in the category with the id:1. We want the products to be listed in german defined by the language - code "de_DE" for the country germany defined by the country - code "DE". Further we want the products to be listed ordered by the price descending. Left - limit is 0 an right - limit is 1 so only 1 product will be listed. The attributes we want to be listed are "name" and "price".

Response

                    {
  "object":"cart",
  "creation_date":"2018-08-09 21:16:15",
  "sum":0,
  
  
"contents":[
  
  
  
],
"delivery_costs":{
     "sum":0,
     "positions":[
      
      
       
     ]
}


  
}


{
  "object":"cart",
  "creation_date":"2018-08-09 21:16:15",
  "sum":0,
  
  
"contents":[
  
  
  
],
"delivery_costs":{
     "sum":0,
     "positions":[
      
      
       
     ]
}


  
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<cart>
<creation_date>2018-08-09 21:16:15</creation_date>
<sum>0</sum>
<contents>
 
</contents>
<delivery_costs>
<sum>0</sum>
<positions>

</positions>
</delivery_costs>

</cart>
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<cart>
<creation_date>2018-08-09 21:16:15</creation_date>
<sum>0</sum>
<contents>
 
</contents>
<delivery_costs>
<sum>0</sum>
<positions>

</positions>
</delivery_costs>

</cart>
                    

Explanation

creation_dateThe creation date.
contentsThe contents of the cart.
delivery_costsThe delivery costs section.

register_user

Is used to create user - accounts via API.


Arguments

  • language (string)

    The language of the user.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


The following arguments have to be encoded as a json-array which is then sent in the argument named args:

  • username (string)

    The unique username of the user. This is a string with the length between 4 and 60 characters containing a-z A-Z 0-9 !@$

  • passwd1 (string)

    A valid password for the user. This is a string with the length between 3 and 30 characters containing a-z A-Z 0-9 !@$

  • passwd2 (string)

    The same as passwd1.

  • email (string)

    A valid email for the user.

  • class (string)

    The class that has to be used for creating the user. If you don't specify a class the default class will be used which is normally names 'user'.


Request

curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='register_user' \
-d language='de_DE' \
-d args='{"username":"testuser123",
          "passwd1":"thesecret",
          "passwd2":"thesecret",
          "email":"info@sleekcommerce.com"}'

Here we are trying to create a user with the username testuser123 and the other credentials listed.

Response

                    {
  "object":"register_user",
  "status":"SUCCESS",
  "id_user":26,
  "session_id":"UvZABz5GKvOLtyYPC6wQ"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<register_user>
<status>SUCCESS</status>
<id_user>25</id_user>
<session_id>wArDqiDsd9OAGwCdLknH</session_id>
</register_user>
                    

Explanation

statusA statuscode which shows wether the action was successful or not.
id_userThe id of the created user.
session_idThe session_id of the created user which can be used to verify the user.

verify_user

Verification method for the user - accounts.

After a user-account is created the account has to be verified to work properly. If this not happens the user cant login.

Arguments

  • id_user (int)

    The id of the user.

  • session_id (string)

    A valid session-code. Here the session_code has to be used which is generated and transferred after registration by the method register_user.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='verify_user' \ -d id_user=1 \ -d session_id="asddsaasddas"


Response

                    {
  "object":"verify_user",
  "status":"SUCCESS"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<verify_user>
<status>SUCCESS</status>
</verify_user>
                    

Explanation

statusThe status message which indicates wether the action successfull or not.

login_user

This is the method to login exisiting and verified users into a valid session.


Arguments

  • username (string)

    The username of the user that has to be logged in.

  • password (string)

    The valid password of the user.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='login_user' \ -d username='testuser' \ -d password="thesecret123" \ -d session="asddsaasddsa"


Here we try to login with his credentials into an existing session.

Response

                    {
  "object":"login_user",
  "status":"SUCCESS",
  "id_user":1,
  "session_id":"uXu6SddddsdsaqO8UA74qdGZMUDk",
  "username":"root",
  "email":"info@xyz.de",
  "default_language":"de_DE",
  "reg_date":"2016-03-22 11:08:58",
  "first_login":"2016-03-22 11:41:07",
  "last_login":"2018-11-05 15-17-40"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<login_user>
<status>SUCCESS</status>
<id_user>1</id_user>
<session_id>uXu6SddddsdsaqO8UA74qdGZMUDk</session_id>
<username>root</username>
<email>info@xyz.de</email>
<default_language>de_DE</default_language>
<reg_date>2016-03-22 11:08:58</reg_date>
<first_login>2016-03-22 11:41:07</first_login>
<last_login>2018-11-05 15-18-46</last_login>
</login_user>
                    

Explanation

statusA status determining wether the action was successful or not.
id_userThe id of the user.
session_idThe session_id of the user.
usernameThe username of the user.
emailThe email of the user.
default_languageThe language code presenting the default language of the user.
reg_dateRegistration date of the user.
first_loginDate of the first login.
last_loginDate of the last login.

logout_user

This method logs - out a user from a session. Because for each session only one user can be logged in, the attribute needed is only a valid session.


Arguments

  • session (string)

    A valid session with a user logged in.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='logout_user' \ -d session="asddsaasd123321s"


Response

                    {
  "object":"logout_user",
  "status":"SUCCESS"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<logout_user>
<status>SUCCESS</status>
</logout_user>
                    

Explanation

statusA status showing wether the action was successful or not.

set_user_password

Overwrites the current user - password with the delivered password.


Arguments

  • session (string)

    A session of a logged-in user.

  • old_passwd (string)

    The current password of the logged-in user.

  • new_passwd1 (string)

    The new password.

  • new_passwd2 (string)

    Repetition of the new password.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d session='valid_session' \ -d request='set_user_password' \ -d old_passwd='old_password' \ -d new_passwd1="thesecret123" \ -d new_passwd2="thesecret123"


Here we are setting the password for an logged-in user. The user is determined by the session. First we need the actual password. Furthermore we have to deliver the new password twice.

Response

                    {
  "object":"set_user_password",
  "status":"SUCCESS"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<set_user_password>
<status>SUCCESS</status>
</set_user_password>
                    

Explanation

statusContaining the status - message of the operation.

reset_user_password (init)

This function is used to reset the user password. The reset is divided into two calls. In the first call we send the email and receive informations we need in the second call.


Arguments

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


The following arguments have to be encoded as a json-array which is then sent in the argument named args:

  • email (string)

    The email of the user you want to reset the password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='reset_user_password' \ -d args='{"email":"email@domain.com"}'


Response

                    {
  "object":"reset_user_password",
  "status":"init",
  "id_user":13,
  "session_id":"SG6mLKG2ml1WPsssySg3vLW",
  "username":"the_username",
  "email":"email@domain.com",
  "default_language":"de_DE"
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<reset_user_password>
<status>init</status>
<id_user>13</id_user>
<session_id>SG6mLKG2ml1WPsssySg3vLW</session_id>
<username>the_username</username>
<email>email@domain.com</email>
<default_language>de_DE</default_language>
</reset_user_password>
                    

Explanation

statusContaining the status - message of the operation.
id_userThe id of the user.
session_idThe session_id of the user.
usernameThe username of the user.
emailThe email of the user.
default_languageA language code representing the default language of the user.

reset_user_password (success)

This is the second part of the reset_user_password process. Here we send needed parameters to finally reset the user-password. These parameters were delivered by the same function in the previous description : reset_user_password (init)


Arguments

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


The following arguments have to be encoded as a json-array which is then sent in the argument named args:

  • session_id (string)

    This is the unique session_id delivered by the function in the init - process.

  • id_user (int)

    The id of the user you want to reset the password for. The id_user is also delivered in the init-process.

  • new_passwd1 (string)

    The new password for the user.

  • new_passwd2 (string)

    The new password repeated.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='reset_user_password' \ -d args='{"session_id":"valid_session","id_user":13,"new_passwd1":"secret123","new_passwd2":"secret123"}'


Response

                    {
  "object":"reset_user_password",
  "status":"success",
  "id_user":13,
  "session_id":"SG6mLKG2ml1WPsssySg3vLW",
  "username":"the_username",
  "email":"email@domain.com",
  "default_language":"de_DE"
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<reset_user_password>
<status>success</status>
<id_user>13</id_user>
<session_id>SG6mLKG2ml1WPsssySg3vLW</session_id>
<username>the_username</username>
<email>email@domain.com</email>
<default_language>de_DE</default_language>
</reset_user_password>
                    

Explanation

statusContaining the status - message of the operation.
id_userThe id of the user.
session_idThe session_id of the user.
usernameThe username of the user.
emailThe email of the user.
default_languageA language code representing the default language of the user.

get_user_orders

Delivers the orders of a user determined by the session where the user is logged in.


Arguments

  • session (string)

    The session where the user is logged in.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_user_orders' \ -d session='SESSION'


Response

                    {
  "object":"get_user_orders",
  "orders":[
   
       
    {
      "id":63,
      "order_number":63,
      "creation_date":"2019-01-01 21:03:57",
      "order_delivery_companyname":"",
      "order_delivery_department":"",
      "order_delivery_salutation":"Herr",
      "order_delivery_firstname":"test",
      "order_delivery_lastname":"user",
      "order_delivery_street":"max-brauer-allee",
      "order_delivery_number":"218",
      "order_delivery_zip":"22769",
      "order_delivery_state":"hamburg",
      "order_delivery_city":"hamburg",
      "order_delivery_country":"Germany",
      "order_invoice_companyname":"",
      "order_invoice_department":"",
      "order_invoice_salutation":"Herr",
      "order_invoice_firstname":"test",
      "order_invoice_lastname":"user",
      "order_invoice_street":"max-brauer-allee",
      "order_invoice_number":"218",
      "order_invoice_zip":"22769",
      "order_invoice_state":"hamburg",
      "order_invoice_city":"hamburg",
      "order_invoice_country":"Germany",
      "order_email":"info@sleekshop.io",
      "order_phone":"",
      "order_note":"",
      "payment_method":"PrePayment",
      "payment_state":
      {
        "name":"PAYMENT_NOT_RECEIVED",
        "label":"Zahlung nicht erhalten"
      },
      "delivery_method":"Shipping",
      "delivery_state":{
        "name":"PROCESSING",
        "label":"In Bearbeitung"
      },
      "order_state":"OPEN",
      "cart":
      {
        
                
        "creation_date":"2019-01-01 21:02:16",
        "sum":17.5,
        
        
"contents":[
  
     

{
    "type":"FREE_ELEMENT",
    "id":599,
    "id_product":34,
    "quantity":1,
    "price":17.5,
    "sum_price":17.5,
    "tax":2.79412,
    "sum_tax":2.79412,
    "name":"Mütze orange",
    "description":"Tolle Mütze in orange - OneSize",
    "attributes":{
       
                                   "pic":
       
       {
         "name":"pic",
         "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/27aedf1752b483b41b6287ce885468d7.jpg"
       }
       
              ,              "sys_tax":
       
       {
         "name":"sys_tax",
         "value":"0.19"
       }
       
              ,              "sys_tax_calc":
       
       {
         "name":"sys_tax_calc",
         "value":"INC"
       }
       
              ,              "sys_length":
       
       {
         "name":"sys_length",
         "value":"0"
       }
       
              ,              "sys_width":
       
       {
         "name":"sys_width",
         "value":"0"
       }
       
              ,              "sys_height":
       
       {
         "name":"sys_height",
         "value":"0"
       }
       
              ,              "sys_weight":
       
       {
         "name":"sys_weight",
         "value":"0"
       }
       
              ,              "sys_notes":
       
       {
         "name":"sys_notes",
         "value":""
       }
       
       
       
    }
  }






      ,
        




{
    "type":"DELIVERY_COSTS",
    "id":600,
    "id_product":0,
    "quantity":1,
    "price":0,
    "sum_price":0,
    "tax":0,
    "sum_tax":0,
    "name":"Versandkosten",
    "description":" ",
    "attributes":{
       
                                   "sys_tax":
       
       {
         "name":"sys_tax",
         "value":"0.19"
       }
       
              ,              "sys_tax_calc":
       
       {
         "name":"sys_tax_calc",
         "value":"INC"
       }
       
              ,              "sys_length":
       
       {
         "name":"sys_length",
         "value":"0"
       }
       
              ,              "sys_width":
       
       {
         "name":"sys_width",
         "value":"0"
       }
       
              ,              "sys_height":
       
       {
         "name":"sys_height",
         "value":"0"
       }
       
              ,              "sys_weight":
       
       {
         "name":"sys_weight",
         "value":"0"
       }
       
              ,              "sys_notes":
       
       {
         "name":"sys_notes",
         "value":""
       }
       
       
       
    }
}



     
  
],
"delivery_costs":{
     "sum":0,
     "positions":[
      
      
       
     ]
}


        
      },
      "parcels":
      [
      
        
        
      ]
    }
    
       
   
 ]
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<get_user_orders>
<order>
<id>63</id>
<order_number>63</order_number>
<creation_date>2019-01-01 21:03:57</creation_date>
<order_delivery_companyname></order_delivery_companyname>
<order_delivery_department></order_delivery_department>
<order_delivery_salutation>Herr</order_delivery_salutation>
<order_delivery_firstname>test</order_delivery_firstname>
<order_delivery_lastname>user</order_delivery_lastname>
<order_delivery_street>max-brauer-allee</order_delivery_street>
<order_delivery_number>218</order_delivery_number>
<order_delivery_zip>22769</order_delivery_zip>
<order_delivery_state>hamburg</order_delivery_state>
<order_delivery_city>hamburg</order_delivery_city>
<order_delivery_country>Germany</order_delivery_country>
<order_invoice_companyname></order_invoice_companyname>
<order_invoice_department></order_invoice_department>
<order_invoice_salutation>Herr</order_invoice_salutation>
<order_invoice_firstname>test</order_invoice_firstname>
<order_invoice_lastname>user</order_invoice_lastname>
<order_invoice_street>max-brauer-allee</order_invoice_street>
<order_invoice_number>218</order_invoice_number>
<order_invoice_zip>22769</order_invoice_zip>
<order_invoice_state>hamburg</order_invoice_state>
<order_invoice_city>hamburg</order_invoice_city>
<order_invoice_country>Germany</order_invoice_country>
<order_email>info@sleekshop.io</order_email>
<order_phone></order_phone>
<order_note></order_note>
<payment_method>PrePayment</payment_method>
<payment_state><name>PAYMENT_NOT_RECEIVED</name><label>Zahlung nicht erhalten</label></payment_state>
<delivery_method>Shipping</delivery_method>
<delivery_state><name>PROCESSING</name><label>In Bearbeitung</label></delivery_state>
<order_state>OPEN</order_state>
<cart>
<creation_date>2019-01-01 21:02:16</creation_date>
<sum>17.5</sum>
<contents>
   
 <element type="FREE_ELEMENT">
 <id>599</id>
 <id_product>34</id_product>
 <quantity>1</quantity>
 <price>17.5</price>
 <sum_price>17.5</sum_price>
<tax>2.79412</tax>
<sum_tax>2.79412</sum_tax>
<name>Mütze orange</name>
<description>Tolle Mütze in orange - OneSize</description>
<attributes><attribute name="pic">https://demo.sleekshop.net/srv/uploads/shopobject_images/27aedf1752b483b41b6287ce885468d7.jpg</attribute><attribute name="sys_tax">0.19</attribute><attribute name="sys_tax_calc">INC</attribute><attribute name="sys_length">0</attribute><attribute name="sys_width">0</attribute><attribute name="sys_height">0</attribute><attribute name="sys_weight">0</attribute><attribute name="sys_notes"></attribute></attributes>
</element>





   



 <element type="DELIVERY_COSTS">
 <id>600</id>
 <id_product>0</id_product>
 <quantity>1</quantity>
 <price>0</price>
 <sum_price>0</sum_price>
<tax>0</tax>
<sum_tax>0</sum_tax>
<name>Versandkosten</name>
<description> </description>
<attributes><attribute name="sys_tax">0.19</attribute><attribute name="sys_tax_calc">INC</attribute><attribute name="sys_length">0</attribute><attribute name="sys_width">0</attribute><attribute name="sys_height">0</attribute><attribute name="sys_weight">0</attribute><attribute name="sys_notes"></attribute></attributes>
</element>


 
</contents>
<delivery_costs>
<sum></sum>
<positions>

</positions>
</delivery_costs>

</cart>
<parcels>

</parcels>
</order>

</get_user_orders>
                    

Explanation

order dataSection containing all order specific data like delivery-data and invoice-data.
cartContaining all purchased products of the order.
parcelsAn array containing all parcel - informations of the order.

get_user_data

Delivers all user data of the logged - in user.


Arguments

  • session (string)

    The session of the logged-in user.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_user_data' \ -d session='SESSION'


Response

                    {
"object":"get_user_data",
"status":"active",
"id_user":29,
"session_id":"JUPozxdbsBtQSlEtb1Lp",
"username":"testuser",
"email":"info@sleekshop.io",
"default_language":"de_DE",
"reg_date":"2019-01-01 21:03:01",
"first_login":"2019-01-01 21:03:16",
"last_login":"2019-01-01 21:04:25",
"attributes":{
  
          "salutation":
  
  {
    "name":"salutation",
    "value":"Herr"
  }
  
    ,    "firstname":
  
  {
    "name":"firstname",
    "value":"test"
  }
  
    ,    "lastname":
  
  {
    "name":"lastname",
    "value":"user"
  }
  
    ,    "companyname":
  
  {
    "name":"companyname",
    "value":""
  }
  
    ,    "department":
  
  {
    "name":"department",
    "value":""
  }
  
    ,    "street":
  
  {
    "name":"street",
    "value":"max-brauer-allee"
  }
  
    ,    "number":
  
  {
    "name":"number",
    "value":"218"
  }
  
    ,    "zip":
  
  {
    "name":"zip",
    "value":"22769"
  }
  
    ,    "city":
  
  {
    "name":"city",
    "value":"hamburg"
  }
  
    ,    "state":
  
  {
    "name":"state",
    "value":"hamburg"
  }
  
    ,    "country":
  
  {
    "name":"country",
    "value":"DE"
  }
  
    ,    "vat_number":
  
  {
    "name":"vat_number",
    "value":""
  }
  
  
  
},
"additional_attributes":
 {
   
                        "gjhgjhgjh":

{
  "type":"CHAR",
  "id":1519,
  "name":"gjhgjhgjh",
  "label":"test1",
  "value":""
}


                                    ,            "h1":

{
  "type":"CHAR",
  "id":1520,
  "name":"h1",
  "label":"",
  "value":""
}


                                    ,            "attribute_1291":

{
  "type":"CHAR",
  "id":1521,
  "name":"attribute_1291",
  "label":"",
  "value":""
}


                                    ,            "attribute_1292":

{
  "type":"CHAR",
  "id":1522,
  "name":"attribute_1292",
  "label":"",
  "value":""
}


                                    ,            "attribute_1293":

{
  "type":"CHAR",
  "id":1523,
  "name":"attribute_1293",
  "label":"",
  "value":""
}


                                    ,            "attribute_1294":

{
  "type":"CHAR",
  "id":1524,
  "name":"attribute_1294",
  "label":"",
  "value":""
}


                              
   
 },
 "addresses":
 [
  
     
   
 ]
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<get_user_data>
<status>active</status>
<id_user>29</id_user>
<session_id>JUPozxdbsBtQSlEtb1Lp</session_id>
<username>testuser</username>
<email>info@sleekshop.io</email>
<default_language>de_DE</default_language>
<reg_date>2019-01-01 21:03:01</reg_date>
<first_login>2019-01-01 21:03:16</first_login>
<last_login>2019-01-01 21:04:25</last_login>
<attributes>
<salutation>Herr</salutation>
<firstname>test</firstname>
<lastname>user</lastname>
<companyname></companyname>
<department></department>
<street>max-brauer-allee</street>
<number>218</number>
<zip>22769</zip>
<city>hamburg</city>
<state>hamburg</state>
<country>DE</country>
<vat_number></vat_number>

</attributes>
<additional_attributes>
          <attribute type="CHAR" id="1519">
<name>gjhgjhgjh</name>
<label>test1</label>
<value></value>
</attribute>

                            <attribute type="CHAR" id="1520">
<name>h1</name>
<label></label>
<value></value>
</attribute>

                            <attribute type="CHAR" id="1521">
<name>attribute_1291</name>
<label></label>
<value></value>
</attribute>

                            <attribute type="CHAR" id="1522">
<name>attribute_1292</name>
<label></label>
<value></value>
</attribute>

                            <attribute type="CHAR" id="1523">
<name>attribute_1293</name>
<label></label>
<value></value>
</attribute>

                            <attribute type="CHAR" id="1524">
<name>attribute_1294</name>
<label></label>
<value></value>
</attribute>

                    
</additional_attributes>
<addresses>
  
</addresses>
</get_user_data>

                    

Explanation

user-main dataSection containing the main data of the user like email and username.
attributesSection containing all main attributes which belong to all users like firstname, lastname and street.
additional_attributesSection containing all additional - attributes of the user.
addressesAdditional user addresses.

set_user_data

Sets the userdata for a logged-in user.


Arguments

  • session (string)

    The session of the logged-in user.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


The following arguments have to be encoded as a json-array which is then sent in the argument named attributes:

  • email (string)

    A valid email - address for the user.

  • salutation (string)

    The salutation of the user.

  • firstname (string)

    The firstname of the user.

  • lastname (string)

    The lastname of the user.

  • companyname (string)

    The companyname of the user.

  • department (string)

    The department of the user.

  • street (string)

    The street of the user.

  • number (string)

    The housenumber of the user.

  • zip (string)

    The zipcode for the user.

  • city (string)

    The city of the user.

  • state (string)

    The state of the user.

  • country (string)

    A valid countrycode for the user.

Furthermore you can set additional - attribute - values which are specified by the class of the userobject. Here you can use the name which you have defined to set the value.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='set_user_data' \ -d session='SESSION' \ -d attributes='{"department":"test", "firstname":"my_firstname", "lastname":"my_lastname"}'


Here we set the department, the firstname and the lastname of the user. It is possible to set the userdata incrementally. That enables you to build up the data - collection in the way you want to build up your checkout - process.

Response

                    {
"object":"set_user_data",
"status":"SUCCESS"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<set_user_data>
<status>SUCCESS</status>
</set_user_data>
                    

Explanation

statusA status message which determines wether the request was successful or not.

instant_login

This login - method can be used for login of users from the backend into remote - applications communicating with the api. Therefore no username and password are needed.

The instant - login is especially built for applications adding value to the users sleekshop - backend. These applications can use the users backend - login to grant access to the application itself. 

The applications you want to implement into the backend can be implemented in the applications - section and will be displayed in an iframe within the backend of the user.

The verification process:

  • The user logs in into his sleekshop - backend. 
  • In the application - menu the user clicks on an application you have registered.
  • During that time an access - token will be generated which can be used to verify a user. This token is activated for 5 minutes.
  • The token will be delivered to the url you entered while creating the application via GET. The URL will also deliver a username. The parameters are namend : token and username (which is the shopname).
  • After that you can use the application_token and the delivered token to login the user via api by calling the instant_login - request.


Arguments

  • token (string)

    The token delivered to the iframe.

  • application_token (string)

    The application - token which was generated when creating the application in the backend.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='instant_login' \ -d token='asddsaasddasdasdasdasd' \ -d application_token="asdalskdjlasjdlkasdlasjdkasjd"


Response

                    {
  "object":"login_user",
  "status":"SUCCESS",
  "id_user":1,
  "session_id":"uXu6SddddsdsaqO8UA74qdGZMUDk",
  "remote_session":"aslkjdlaksjdlkajdlkajsdkljasdlkjsa",
  "username":"root",
  "email":"info@xyz.de",
  "default_language":"de_DE",
  "reg_date":"2016-03-22 11:08:58",
  "first_login":"2016-03-22 11:41:07",
  "last_login":"2018-11-05 15-17-40"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<login_user>
<status>SUCCESS</status>
<id_user>1</id_user>
<session_id>uXu6SddddsdsaqO8UA74qdGZMUDk</session_id>
<remote_session>aslkjdlaksjdlkajdlkajsdkljasdlkjsa</remote_session>
<username>root</username>
<email>info@xyz.de</email>
<default_language>de_DE</default_language>
<reg_date>2016-03-22 11:08:58</reg_date>
<first_login>2016-03-22 11:41:07</first_login>
<last_login>2018-11-05 15-18-46</last_login>
</login_user>
                    

Explanation

statusA status determining wether the action was successful or not.
id_userThe id of the user.
session_idThe session_id of the user.
remote_sessionA valid session with the user logged - in which can be used for further api-requests.
usernameThe username of the user.
emailThe email of the user.
default_languageThe language code presenting the default language of the user.
reg_dateRegistration date of the user.
first_loginDate of the first login.
last_loginDate of the last login.

set_order_details

Setting the order specific attributes in the checkout - process. This data is only stored in the session which is determined by the "session" argument.


Arguments

  • session (string)

    A valid session.

  • id_payment_method (int)

    A valid id specifying the desired payment - method. This id can be identified with the get_payment_methods request.

  • id_delivery_method (int)

    A valid delivery - id.

  • delivery_companyname (string)

    The delivery companyname.

  • delivery_department (string)

    The delivery - department.

  • delivery_salutation (string)

    The delivery salutation.

  • delivery_firstname (string)

    The delivery firstname.

  • delivery_lastname (string)

    The delivery lastname.

  • delivery_street (string)

    The delivery street.

  • delivery_number (string)

    The delivery number.

  • delivery_zip (string)

    The delivery zip.

  • delivery_state (string)

    The delivery state.

  • delivery_city (string)

    The delivery city.

  • delivery_country (string)

    A valid delivery country code.

  • invoice_companyname (string)

    The invoice companyname.

  • invoice_department (string)

    The invoice - department.

  • invoice_salutation (string)

    The invoice salutation.

  • invoice_firstname (string)

    The invoice firstname.

  • invoice_lastname (string)

    The invoice lastname.

  • invoice_street (string)

    The invoice street.

  • invoice_number (string)

    The invoice number.

  • invoice_zip (string)

    The invoice zip.

  • invoice_state (string)

    The invoice state.

  • invoice_city (string)

    The invoice city.

  • invoice_country (string)

    A valid invoice country code.

  • note (string)

    A note that has to be attached to the order.

  • email (string)

    A valid email for the order.

  • phone (string)

    A phone - number that has to be attached to the order.

  • attributes (json-array)

    An array containing additional attributes if needed.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='set_order_details' \ -d session='SESSION' \ -d delivery_companyname="sleekcommerce" \ -d delivery_firstname="test123" \ -d delivery_lastname="test456" \ -d invoice_firstname="invoice_test" \ -d email="test@test.de" \ -d phone="123321" \ -d attributes='[{"lang":"en_EN","name":"more-infos","value":"here is something important"}]'


Here we are setting some order infos. Its important to mention that you can set the order - details incrementally. This is very important to build up an individualized checkout - process.

The order - data we are setting wont be permanent until we checkout the session - order. So this data is only stored in the corresponding session.

Response

                    {
  "object":"order_details",
  "user":{
    "id_user":0,
    "username":"not_specified"
  },
  "order_payment_method":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_delivery_method":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_payment_state":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_delivery_state":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_state":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_type":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_number":"",
  "username_creator":"",
  "creation_date":"",
  "username_modifier":"",
  "modification_date":"",
  "delivery_companyname":"sleekcommerce",
  "delivery_department":"",
  "delivery_salutation":"",
  "delivery_firstname":"test123",
  "delivery_lastname":"test456",
  "delivery_street":"",
  "delivery_number":"",
  "delivery_zip":"0",
  "delivery_state":"",
  "delivery_city":"",
  "delivery_country":"",
  "delivery_country_code":"",
  "invoice_companyname":"",
  "invoice_department":"",
  "invoice_salutation":"",
  "invoice_firstname":"invoice_test",
  "invoice_lastname":"",
  "invoice_street":"",
  "invoice_number":"",
  "invoice_zip":"0",
  "invoice_state":"",
  "invoice_city":"",
  "invoice_country":"",
  "invoice_country_code":"",
  "note":"",
  "email":"test@test.de",
  "phone":"123321",
  "attributes":{
     
          "more-infos":
     
     {
       "name":"more-infos",
       "value":"here is something important"
     }
     
          
     
  }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<order_details>
 <user>
  <id_user>0</id_user>
  <username>not_specified</username>
 </user>

<order_payment_method>
 <id>0</id>
 <name>not_specified</name>
</order_payment_method>

<order_delivery_method>
 <id>0</id>
 <name>not_specified</name>
</order_delivery_method>

<order_payment_state>
 <id>0</id>
 <name>not_specified</name>
</order_payment_state>

<order_delivery_state>
 <id>0</id>
 <name>not_specified</name>
</order_delivery_state>

<order_state>
 <id>0</id>
 <name>not_specified</name>
</order_state>

<order_type>
 <id>0</id>
 <name>not_specified</name>
</order_type>

<order_number></order_number>
<username_creator></username_creator>
<creation_date></creation_date>
<username_modifier></username_modifier>
<modification_date></modification_date>
<delivery_companyname>sleekcommerce</delivery_companyname>
<delivery_department></delivery_department>
<delivery_salutation></delivery_salutation>
<delivery_firstname>test123</delivery_firstname>
<delivery_lastname>test456</delivery_lastname>
<delivery_street></delivery_street>
<delivery_number></delivery_number>
<delivery_zip>0</delivery_zip>
<delivery_state></delivery_state>
<delivery_city></delivery_city>
<delivery_country></delivery_country>
<delivery_country_code></delivery_country_code>
<invoice_companyname></invoice_companyname>
<invoice_department></invoice_department>
<invoice_salutation></invoice_salutation>
<invoice_firstname>invoice_test</invoice_firstname>
<invoice_lastname></invoice_lastname>
<invoice_street></invoice_street>
<invoice_number></invoice_number>
<invoice_zip>0</invoice_zip>
<invoice_state></invoice_state>
<invoice_city></invoice_city>
<invoice_country></invoice_country>
<invoice_country_code></invoice_country_code>
<note></note>
<email>test@test.de</email>
<phone>123321</phone>
<attributes><attribute name="more-infos">here is something important</attribute></attributes>
</order_details>
                    

Explanation

user-sectionInfos about the user belonging to this order. If a user is logged in this section will contain the user after checkout.
order_payment_method-sectionSection containing informations about the payment-method you set.
order_delivery_method-sectionSection containing informations about the delivery-method you set.
order_payment_state-sectionSection containing informations about the payment-state of the order.
order_delivery_state-sectionSection containing informations about the delivery-state of the order.
order_state-sectionSection containing informations about the order-state.
order_type-sectionSection containing informations about the order-type.
main order data fieldsHere you get the whole order-detail - fields.
attributes-sectionThe additional attributes you set.

get_order_details

Delivers the order - details of a specific session.


Arguments

  • session (string)

    A valid session.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_order_details' \ -d session='SESSION'


Response

                    {
  "object":"order_details",
  "user":{
    "id_user":0,
    "username":"not_specified"
  },
  "order_payment_method":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_delivery_method":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_payment_state":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_delivery_state":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_state":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_type":
  {
    "id":0,
    "name":"not_specified"
  },
  "order_number":"",
  "username_creator":"",
  "creation_date":"",
  "username_modifier":"",
  "modification_date":"",
  "delivery_companyname":"sleekcommerce",
  "delivery_department":"",
  "delivery_salutation":"",
  "delivery_firstname":"test123",
  "delivery_lastname":"test456",
  "delivery_street":"",
  "delivery_number":"",
  "delivery_zip":"0",
  "delivery_state":"",
  "delivery_city":"",
  "delivery_country":"",
  "delivery_country_code":"",
  "invoice_companyname":"",
  "invoice_department":"",
  "invoice_salutation":"",
  "invoice_firstname":"invoice_test",
  "invoice_lastname":"",
  "invoice_street":"",
  "invoice_number":"",
  "invoice_zip":"0",
  "invoice_state":"",
  "invoice_city":"",
  "invoice_country":"",
  "invoice_country_code":"",
  "note":"",
  "email":"test@test.de",
  "phone":"123321",
  "attributes":{
     
          "more-infos":
     
     {
       "name":"more-infos",
       "value":"here is something important"
     }
     
          
     
  }
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<order_details>
 <user>
  <id_user>0</id_user>
  <username>not_specified</username>
 </user>

<order_payment_method>
 <id>0</id>
 <name>not_specified</name>
</order_payment_method>

<order_delivery_method>
 <id>0</id>
 <name>not_specified</name>
</order_delivery_method>

<order_payment_state>
 <id>0</id>
 <name>not_specified</name>
</order_payment_state>

<order_delivery_state>
 <id>0</id>
 <name>not_specified</name>
</order_delivery_state>

<order_state>
 <id>0</id>
 <name>not_specified</name>
</order_state>

<order_type>
 <id>0</id>
 <name>not_specified</name>
</order_type>

<order_number></order_number>
<username_creator></username_creator>
<creation_date></creation_date>
<username_modifier></username_modifier>
<modification_date></modification_date>
<delivery_companyname>sleekcommerce</delivery_companyname>
<delivery_department></delivery_department>
<delivery_salutation></delivery_salutation>
<delivery_firstname>test123</delivery_firstname>
<delivery_lastname>test456</delivery_lastname>
<delivery_street></delivery_street>
<delivery_number></delivery_number>
<delivery_zip>0</delivery_zip>
<delivery_state></delivery_state>
<delivery_city></delivery_city>
<delivery_country></delivery_country>
<delivery_country_code></delivery_country_code>
<invoice_companyname></invoice_companyname>
<invoice_department></invoice_department>
<invoice_salutation></invoice_salutation>
<invoice_firstname>invoice_test</invoice_firstname>
<invoice_lastname></invoice_lastname>
<invoice_street></invoice_street>
<invoice_number></invoice_number>
<invoice_zip>0</invoice_zip>
<invoice_state></invoice_state>
<invoice_city></invoice_city>
<invoice_country></invoice_country>
<invoice_country_code></invoice_country_code>
<note></note>
<email>test@test.de</email>
<phone>123321</phone>
<attributes><attribute name="more-infos">here is something important</attribute></attributes>
</order_details>
                    

Explanation

user-sectionInfos about the user belonging to this order. If a user is logged in this section will contain the user after checkout.
order_payment_method-sectionSection containing informations about the payment-method you set.
order_delivery_method-sectionSection containing informations about the delivery-method you set.
order_payment_state-sectionSection containing informations about the payment-state of the order.
order_delivery_state-sectionSection containing informations about the delivery-state of the order.
order_state-sectionSection containing informations about the order-state.
order_type-sectionSection containing informations about the order-type.
main order data fieldsHere you get the whole order-detail - fields.
attributes-sectionThe additional attributes you set.

checkout

Checks out a session - order. Makes the order permament.


Arguments

  • session (string)

    A valid session with an order.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='checkout' \ -d session='SESSION'


Response

                    {
  "object":"checkout",
  "status":"success",
  "id_order":65,
  "session":"",
  "message":"",
  "param":""
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<checkout>
<status>success</status>
<id_order>64</id_order>
<session></session>
<message></message>
<param></param>
</checkout>
                    

Explanation

statusThe status showing wether the process was successful or not.
id_orderThe unique ID of the order you just created.
sessionA new session you should use for further activities where the logged in user is logged in. If no user was logged in into the session you just checked - out then this field will be empty and you can get a new session with get_new_session.
messageA message telling you something about the status.
paramParameters belonging to the message.

get_payment_methods

Delivers all availably payment_methods.


Arguments

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_payment_methods'


Response

                    {
  "object":"payment_methods",
  
    "PayPal":
  
  {
    "id":1,
    "name":"PayPal",
    "attributes":
    {
      
            
    
    }
  }
  
    ,
    
  
    "PrePayment":
  
  {
    "id":2,
    "name":"PrePayment",
    "attributes":
    {
      
            
    
    }
  }
  
    ,
    
  
    "Cash":
  
  {
    "id":3,
    "name":"Cash",
    "attributes":
    {
      
            
    
    }
  }
  
    ,
    
  
    "EC-Cash":
  
  {
    "id":4,
    "name":"EC-Cash",
    "attributes":
    {
      
            
    
    }
  }
  
    ,
    
  
    "Sofortueberweisung":
  
  {
    "id":5,
    "name":"Sofortueberweisung",
    "attributes":
    {
      
            
    
    }
  }
  
    ,
    
  
    "PayMill":
  
  {
    "id":6,
    "name":"PayMill",
    "attributes":
    {
      
                              "bridge_url":"https://bridge.paymill.com/"
            ,            "public_key":""
      
    
    }
  }
  
    ,
    
  
    "Stripe":
  
  {
    "id":7,
    "name":"Stripe",
    "attributes":
    {
      
            
    
    }
  }
  
    
  
  
  
}

                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<payment_methods>
<payment_method>
<id>1</id>
<name>PayPal</name>
<attributes>

</attributes>
</payment_method>
<payment_method>
<id>2</id>
<name>PrePayment</name>
<attributes>

</attributes>
</payment_method>
<payment_method>
<id>3</id>
<name>Cash</name>
<attributes>

</attributes>
</payment_method>
<payment_method>
<id>4</id>
<name>EC-Cash</name>
<attributes>

</attributes>
</payment_method>
<payment_method>
<id>5</id>
<name>Sofortueberweisung</name>
<attributes>

</attributes>
</payment_method>
<payment_method>
<id>6</id>
<name>PayMill</name>
<attributes>
<attribute name="bridge_url">https://bridge.paymill.com/</attribute>
<attribute name="public_key"></attribute>

</attributes>
</payment_method>
<payment_method>
<id>7</id>
<name>Stripe</name>
<attributes>

</attributes>
</payment_method>

</payment_methods>
                    

Explanation

You receive a list of all available payment methods. Each payment - method contains several fields described below:
idThe id of the payment_method. This id is used to select the payment_method with set_order_details.
nameThe name of the payment - method.
attributesA list of attributes you may need for the payment - method.

do_payment

Initiates the payment - process for an permanent order determined by its id.


Arguments

  • id_order (int)

    The id of the order you want to initiate the payment.

  • args (json-array)

    Some payment - methods need several arguments you have to provide as an json - array.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='do_payment' \ -d id_order=1 \ -d args="[]"


Response

                    {
  "object":"do_payment",
  "method":"PayPal",
  "status":"Success",
  "redirect":"https://www.paypal.com/webscr&amp;amp;cmd=_express-checkout&amp;amp;token=EC-255618719P542743Y&amp;amp;cmd=_express-checkout&amp;amp;useraction=commit"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<do_payment>
<method>PayPal</method>
<status>Success</status>
<redirect>https://www.paypal.com/webscr&amp;amp;cmd=_express-checkout&amp;amp;token=EC-46313304JF205524A&amp;amp;cmd=_express-checkout&amp;amp;useraction=commit</redirect>
</do_payment>
                    

Explanation

methodYou see the selected method in the order.
statusDetermines wether the request was successful or not.
redirectMany payment - services need a redirect to the page of the PSP. If so then you will receive the correct redirect - link here. HTML special characters are encoded.

add_delivery_costs

Adds delivery costs to the cart of a valid session.


Arguments

  • session (string)

    The id of the category.

  • delivery_costs (json-array)

    An array containing all deilvery - positions you want to add.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


You are free in adding delivery costs at your will. The estimated delivery costs in the cart are only recommendation. The json-array of the delivery - costs has always the same structure.

An array containing other array representing the delivery - cost positions with the following structure:

1.) Name

2.) Amount

3.) Tax

Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='add_delivery_costs' \ -d session='SESSION' \ -d delivery_costs="[["Delivery",4.90,0.19],["Delivery2",5.90,0.19]]"


Response

                    {
  "object":"add_delivery_costs",
  "status":"SUCCESS"
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<add_delivery_costs>
<status>SUCCESS</status>
</add_delivery_costs>
                    

Explanation

statusA message showing wether the action was successful or not.

aggregate

This request allows you to perform several tasks with only one call. You can send several requests in the pipe.


Arguments

  • pipe (json-array)

    A well formed array containing all requests you want to perform.

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


The following requests are allowed for use (for now): 

  • get_shopobjects_in_category
  • get_product_details
  • search_distinct_products
  • search_products
  • seo_get_shopobjects_in_category

The parameters you need to send for each request are the same as described for the corresponding call.

The json-array is an array containing identifiers and request-arrays. The request arrays contain two fields: request and args.

The request determines the request and the args contain the valid arguments.

As an example a request array looks like this:  

{

  "request":"search_distinct_products",

  "args":{"field":"material","constraint":[],"language":"en_EN"}

}.

So here we are requesting distinct material fields.

To be able to separate the answers we need also a identifier as key in the pipe. So the final pipe json-array could look like this: 

{

  "materials":

    {

     "request":"search_distinct_products",

      "args":{"field":"material","constraint":[],"language":"en_EN"}

     }

  }


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='aggregate' \ -d pipe='{ "names":{"request":"search_distinct_products","args":{ "field":"name","constraint":[],"language":"de_DE"}}, "special_product":{"request":"get_product_details","args":{ "id_product":42,"language":"de_DE","country":"DE","needed_attributes":"[]"}} }'


Here we requesting serch_distinct_products and get_product_details in one request.

Response

                    {"object":"aggregate","aggregate_names":
{
  "object":"search_distinct_products_result",
  "count":18,
  "result":[
   
      "Mütze orange"      ,
         "Hunting Pullover S"      ,
         "winterjacke rot XL"      ,
         "Laufschuh rot"      ,
         "Laufschuh blau"      ,
         "Laufschuh grün"      ,
         "Sneakers grün"      ,
         " Schneehut schwarz"      ,
         "Polar Jacket pink"      ,
         "Mütze blau"      ,
         "Polar Jacket blau"      ,
         "Schneehut dunkelblau"      ,
         "Sneakers italian"      ,
         "Hunting Pullover L"      ,
         "Hunting Pullover M"      ,
         "Winterjacke rot M"      ,
         "Winterjacke rot S"      ,
         "winterjacke rot L"      
   
  ]
}

,"aggregate_special_product":
{
  "object":"product",
  "id":42,
  "name":"Schneehut dunkelblau",
  "creation_date":"2016-03-25 17:22:22",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "dunkelblau-schneehut-warm",
  "title": "Dunkelblauer Schneehut",
  "description": "Cooler Schneehut in dunkelblau",
  "keywords": "dunkelblau, Schneehut, Muetze"
}

,
  
"availability":
{
  "quantity": 12,
  "quantity_warning": 6,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "123321",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":20,
  "width":18,
  "height":25,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":532,
  "name":"name",
  "label":"Name",
  "value":"Schneehut dunkelblau"
}


                                
            
    ,                    "short_description":

{
  "type":"TXT",
  "id":533,
  "name":"short_description",
  "label":"Kurzbeschreibung",
  "value":"Warmer und superweicher Schneehut in dunkelblau"
}


                            
            
    ,                                            "description":

{
  "type":"HTML",
  "id":534,
  "name":"description",
  "label":"Beschreibung",
  "value":"<p>Dieser trendige Schneehut in der Farbe dunkelblau hat eine hohe Qualitu00e4t, ist sehr robust und gemu00fctlich.nAuu00dferdem besitzt er ein su00fcu00dfes Detail aus vielen Fransen am oberen Ende des Hutes.n-Rollsaumn-sehr fein gewebter Stoffn-Stoff: leicht und elastischn-Passform: normaln-Muster: unin-Material: 65%Baumwolle 35%PolyesternPflegehinweise: Maschinenwu00e4sche bei 30 GradnArtikelnummer: XX932048-34</p><br><p><br></p>"
}


    
            
    ,                                "price":

{
  "type":"FLOAT",
  "id":535,
  "name":"price",
  "label":"Preis",
  "value":27.9
}


                
            
    ,            "img1":

{
  "type":"IMG",
  "id":536,
  "name":"img1",
  "label":"Bild 1",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/cadf5ae384c909a010d3ab31bdb94456.jpg",
  "width":"200",
  "height":"200"
  
    
}


                                    
            
    ,            "img2":

{
  "type":"IMG",
  "id":537,
  "name":"img2",
  "label":"Bild 2",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                "color":

{
  "type":"CHAR",
  "id":538,
  "name":"color",
  "label":"Farbe",
  "value":"dunkelblau"
}


                                
            
    ,            "img3":

{
  "type":"IMG",
  "id":539,
  "name":"img3",
  "label":"Bild 3",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,            "img4":

{
  "type":"IMG",
  "id":540,
  "name":"img4",
  "label":"Bild 4",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                        "related_items":

{
  "type":"PRODUCTS",
  "id":541,
  "name":"related_items",
  "label":"ähnliche Produkte",
  "value":[
  
    
{
  "object":"product",
  "id":35,
  "name":"Mütze blau",
  "creation_date":"2016-03-25 16:20:50",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "gemusterte-blaue-muetze",
  "title": "Moderne Mütze mit Aztekenmuster und süßen Fransen",
  "description": "Superwarme Mütze mit Fransendetails",
  "keywords": "warm, muetze, fransen, aztekenmuster, unisex"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":437,
  "name":"name",
  "label":"Name",
  "value":"Mu00fctze blau"
}


                                
            
    ,                    "short_description":

{
  "type":"TXT",
  "id":438,
  "name":"short_description",
  "label":"Kurzbeschreibung",
  "value":"Blaue Mu00fctze in superweicher Qualitu00e4t"
}


                            
            
    ,                                            "description":

{
  "type":"HTML",
  "id":439,
  "name":"description",
  "label":"Beschreibung",
  "value":"Flauschige Mu00fctze der Marke &quot;Mu00fctzenLiebe&quot;. In Spanien hergestellt.n-su00fcu00dfe Fransendetailsn-breiter Umschlagn-Lu00e4nge: 21 cm bei Gru00f6u00dfe One Sizen-Materialkonstruktion: Rippn-Fu00fctterungsdicke: ungefu00fcttertn-Muster: Aztekenmustern-Material Oberstoff: 100% Polyacryln-Pflegehinweise: nicht Trockner geeignet, Handwu00e4schen-Breite: 21 cm bei Gru00f6u00dfe One SizenArtikelnummer: C1454B00O-M11"
}


    
            
    ,                                "price":

{
  "type":"FLOAT",
  "id":440,
  "name":"price",
  "label":"Preis",
  "value":17.5
}


                
            
    ,            "img1":

{
  "type":"IMG",
  "id":441,
  "name":"img1",
  "label":"Bild 1",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/c613e0ea8b6640dae6f10697c37889da.jpg",
  "width":"200",
  "height":"200"
  
    
}


                                    
            
    ,            "img2":

{
  "type":"IMG",
  "id":442,
  "name":"img2",
  "label":"Bild 2",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                "color":

{
  "type":"CHAR",
  "id":443,
  "name":"color",
  "label":"Farbe",
  "value":"himmelblau"
}


                                
            
    ,            "img3":

{
  "type":"IMG",
  "id":444,
  "name":"img3",
  "label":"Bild 3",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,            "img4":

{
  "type":"IMG",
  "id":445,
  "name":"img4",
  "label":"Bild 4",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                        "related_items":

{
  "type":"PRODUCTS",
  "id":446,
  "name":"related_items",
  "label":"ähnliche Produkte",
  "value":[
  
    
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    
  ]
  
}


                        
            
    ,                        "featured_items":

{
  "type":"PRODUCTS",
  "id":447,
  "name":"featured_items",
  "label":"beliebte Produkte",
  "value":[
  
  
  ]
  
}


                        
            
    ,                "vendor":

{
  "type":"CHAR",
  "id":448,
  "name":"vendor",
  "label":"Verkäufer",
  "value":"MuetzenLiebe.de"
}


                                
            
    ,                "type":

{
  "type":"CHAR",
  "id":449,
  "name":"type",
  "label":"Art",
  "value":""
}


                                
            
    ,                    "tags":

{
  "type":"TXT",
  "id":450,
  "name":"tags",
  "label":"Tags",
  "value":"Made in Spain,blau,Mu00fctze,onesize,warm,Aztekenmuster,Fransen,Bommel"
}


                            
            
    ,                "size":

{
  "type":"CHAR",
  "id":451,
  "name":"size",
  "label":"Größe",
  "value":"OneSize"
}


                                
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":36,
  "name":"Mütze schwarz",
  "creation_date":"2016-03-25 16:24:52",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "flauschiger-schneehut-schwarz",
  "title": "Superweicher schwarzer Schneehut",
  "description": "Warmer Schneehut der Trendmarke SchneeHut",
  "keywords": "schwarz, schneehut, weich, warm"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 0,
  "allow_override": 0,
  "active": 0
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":23,
  "width":15,
  "height":26,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":452,
  "name":"name",
  "label":"Name",
  "value":" Schneehut schwarz"
}


                                
            
    ,                    "short_description":

{
  "type":"TXT",
  "id":453,
  "name":"short_description",
  "label":"Kurzbeschreibung",
  "value":"Superflauschiger Schneehut in schwarz"
}


                            
            
    ,                                            "description":

{
  "type":"HTML",
  "id":454,
  "name":"description",
  "label":"Beschreibung",
  "value":"Flauschige Mu00fctze der Marke &quot;SchneeHut&quot;n-Logo-Patchn-breiter Umschlagn-Lu00e4nge: 21 cm bei Gru00f6u00dfe One Sizen-Materialkonstruktion: Rippn-Fu00fctterungsdicke: ungefu00fcttertn-Muster: unifarbenn-Material Oberstoff: 100% Polyacryln-Pflegehinweise: nicht Trockner geeignet, Handwu00e4schen-Breite: 21 cm bei Gru00f6u00dfe One SizenArtikelnummer: C1454B00O-M11nn"
}


    
            
    ,                                "price":

{
  "type":"FLOAT",
  "id":455,
  "name":"price",
  "label":"Preis",
  "value":18.9
}


                
            
    ,            "img1":

{
  "type":"IMG",
  "id":456,
  "name":"img1",
  "label":"Bild 1",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/5d618534dfd89666cf496cece4355397.jpg",
  "width":"200",
  "height":"200"
  
    
}


                                    
            
    ,            "img2":

{
  "type":"IMG",
  "id":457,
  "name":"img2",
  "label":"Bild 2",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                "color":

{
  "type":"CHAR",
  "id":458,
  "name":"color",
  "label":"Farbe",
  "value":"schwarz"
}


                                
            
    ,            "img3":

{
  "type":"IMG",
  "id":459,
  "name":"img3",
  "label":"Bild 3",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,            "img4":

{
  "type":"IMG",
  "id":460,
  "name":"img4",
  "label":"Bild 4",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                        "related_items":

{
  "type":"PRODUCTS",
  "id":461,
  "name":"related_items",
  "label":"ähnliche Produkte",
  "value":[
  
    
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    
  ]
  
}


                        
            
    ,                        "featured_items":

{
  "type":"PRODUCTS",
  "id":462,
  "name":"featured_items",
  "label":"beliebte Produkte",
  "value":[
  
  
  ]
  
}


                        
            
    ,                "vendor":

{
  "type":"CHAR",
  "id":463,
  "name":"vendor",
  "label":"Verkäufer",
  "value":"SchneeHut.de"
}


                                
            
    ,                "type":

{
  "type":"CHAR",
  "id":464,
  "name":"type",
  "label":"Art",
  "value":"Huete und Muetzen"
}


                                
            
    ,                    "tags":

{
  "type":"TXT",
  "id":465,
  "name":"tags",
  "label":"Tags",
  "value":"warm,flauschig,modisch,schwarz,unisex,onesize,Fleece"
}


                            
            
    ,                "size":

{
  "type":"CHAR",
  "id":466,
  "name":"size",
  "label":"Größe",
  "value":"OneSize"
}


                                
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":34,
  "name":"Mütze orange",
  "creation_date":"2016-03-25 16:19:24",
  "class":"colorprod",
  
  
"seo":
{
  "permalink": "muetze-orange-onesize",
  "title": "Trendige Mütze mit Aztekenmuster",
  "description": "Superwarme und flauschige Mütze",
  "keywords": "warm, flauschig, orange, muetze, aztekenmuster"
}

,
  
"availability":
{
  "quantity": 0,
  "quantity_warning": 3,
  "allow_override": 0,
  "active": 1
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"Standard",
   "calculation":"INC",
   "value":0.19
  },
  "length":0,
  "width":0,
  "height":0,
  "weight":0,
  "notes":""
  }

,
  "attributes":{
            
                    "name":

{
  "type":"CHAR",
  "id":422,
  "name":"name",
  "label":"Name",
  "value":"Mu00fctze orange"
}


                                
            
    ,                    "short_description":

{
  "type":"TXT",
  "id":423,
  "name":"short_description",
  "label":"Kurzbeschreibung",
  "value":"Tolle Mu00fctze in orange"
}


                            
            
    ,                                            "description":

{
  "type":"HTML",
  "id":424,
  "name":"description",
  "label":"Beschreibung",
  "value":"Flauschige Mu00fctze der Marke &quot;Mu00fctzenLiebe&quot;. In Spanien hergestellt.n-Farbe: orangen-Bommel aus su00fcu00dfen Fransenn-breiter Umschlagn-Lu00e4nge: 21 cm bei Gru00f6u00dfe One Sizen-Materialkonstruktion: Rippn-Fu00fctterungsdicke: ungefu00fcttertn-Muster: Aztekenmustern-Material Oberstoff: 100% Polyacryln-Pflegehinweise: nicht Trockner geeignet, Handwu00e4schen-Breite: 21 cm bei Gru00f6u00dfe One SizenArtikelnummer: C1454B00O-M11"
}


    
            
    ,                                "price":

{
  "type":"FLOAT",
  "id":425,
  "name":"price",
  "label":"Preis",
  "value":17.5
}


                
            
    ,            "img1":

{
  "type":"IMG",
  "id":426,
  "name":"img1",
  "label":"Bild 1",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/27aedf1752b483b41b6287ce885468d7.jpg",
  "width":"200",
  "height":"200"
  
    
}


                                    
            
    ,            "img2":

{
  "type":"IMG",
  "id":427,
  "name":"img2",
  "label":"Bild 2",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                "color":

{
  "type":"CHAR",
  "id":428,
  "name":"color",
  "label":"Farbe",
  "value":"orange"
}


                                
            
    ,            "img3":

{
  "type":"IMG",
  "id":429,
  "name":"img3",
  "label":"Bild 3",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,            "img4":

{
  "type":"IMG",
  "id":430,
  "name":"img4",
  "label":"Bild 4",
  
    
  "value":"https://demo.sleekshop.net/srv/uploads/shopobject_images/",
  "width":"",
  "height":""
  
    
}


                                    
            
    ,                        "related_items":

{
  "type":"PRODUCTS",
  "id":431,
  "name":"related_items",
  "label":"ähnliche Produkte",
  "value":[
  
    
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    ,
      
{
  "object":"product",
  "id":,
  "name":"",
  "creation_date":"",
  "class":"",
  
  
"seo":
{
  "permalink": "",
  "title": "",
  "description": "",
  "keywords": ""
}

,
  
"availability":
{
  "quantity": ,
  "quantity_warning": ,
  "allow_override": ,
  "active": 
}

,
  
"metadata":
{
  "element_number": "",
  "taxclass":
  {
   "name":"",
   "calculation":"",
   "value":
  },
  "length":,
  "width":,
  "height":,
  "weight":,
  "notes":""
  }

,
  "attributes":{
        
    
  },
  "variations":{
  
    
    
 }
}


    
  ]
  
}


                        
            
    ,                        "featured_items":

{
  "type":"PRODUCTS",
  "id":432,
  "name":"featured_items",
  "label":"beliebte Produkte",
  "value":[
  
  
  ]
  
}


                        
            
    ,                "vendor":

{
  "type":"CHAR",
  "id":433,
  "name":"vendor",
  "label":"Verkäufer",
  "value":"MuetzenLiebe.de"
}


                                
            
    ,                "type":

{
  "type":"CHAR",
  "id":434,
  "name":"type",
  "label":"Art",
  "value":""
}


                                
            
    ,                    "tags":

{
  "type":"TXT",
  "id":435,
  "name":"tags",
  "label":"Tags",
  "value":"Made in Spain,Mu00fctze,orange,Aztekenmuster,Fransen,Bommel,Damen,onesize"
}


                            
            
    ,                "size":

{
  "type":"CHAR",
  "id":436,
  "name":"size",
  "label":"Größe",
  "value":"OneSize"
}


                                
        
    
  },
  "variations":{
  
    
    
 }
}


    
  ]
  
}


                        
            
    ,                        "featured_items":

{
  "type":"PRODUCTS",
  "id":542,
  "name":"featured_items",
  "label":"beliebte Produkte",
  "value":[
  
  
  ]
  
}


                        
            
    ,                "vendor":

{
  "type":"CHAR",
  "id":543,
  "name":"vendor",
  "label":"Verkäufer",
  "value":"sleekcommerce"
}


                                
            
    ,                "type":

{
  "type":"CHAR",
  "id":544,
  "name":"type",
  "label":"Art",
  "value":"Made in Germany"
}


                                
            
    ,                    "tags":

{
  "type":"TXT",
  "id":545,
  "name":"tags",
  "label":"Tags",
  "value":"Made in Germany"
}


                            
            
    ,                "size":

{
  "type":"CHAR",
  "id":546,
  "name":"size",
  "label":"Größe",
  "value":"one size"
}


                                
        
    
  },
  "variations":{
  
    
    
 }
}


}
                    

As you can see we have a main aggregate object and the two parts: aggregate_names and aggregate_special_product. These two parts contain the response for the corresponding requests.
                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<aggregate><aggregate_names><search_distinct_products_result>
 <count>
  18
</count>
<field>Mütze orange</field>
<field>Hunting Pullover S</field>
<field>winterjacke rot XL</field>
<field>Laufschuh rot</field>
<field>Laufschuh blau</field>
<field>Laufschuh grün</field>
<field>Sneakers grün</field>
<field> Schneehut schwarz</field>
<field>Polar Jacket pink</field>
<field>Mütze blau</field>
<field>Polar Jacket blau</field>
<field>Schneehut dunkelblau</field>
<field>Sneakers italian</field>
<field>Hunting Pullover L</field>
<field>Hunting Pullover M</field>
<field>Winterjacke rot M</field>
<field>Winterjacke rot S</field>
<field>winterjacke rot L</field>

</search_distinct_products_result>
</aggregate_names><aggregate_special_product><product>
<id>42</id>
<name>Schneehut dunkelblau</name>
<creation_date>2016-03-25 17:22:22</creation_date>
<class>colorprod</class>
<seo>
<permalink>dunkelblau-schneehut-warm</permalink>
<title>Dunkelblauer Schneehut</title>
<description>Cooler Schneehut in dunkelblau</description>
<keywords>dunkelblau, Schneehut, Muetze</keywords>
</seo>

<availability>
<quantity>12</quantity>
<quantity_warning>6</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number>123321</element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>20</length>
<width>18</width>
<height>25</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="532">
<name>name</name>
<label>Name</label>
<value>Schneehut dunkelblau</value>
</attribute>

<attribute type="TXT" id="533">
<name>short_description</name>
<label>Kurzbeschreibung</label>
<value>Warmer und superweicher Schneehut in dunkelblau</value>
</attribute>

<attribute type="HTML" id="534">
<name>description</name>
<label>Beschreibung</label>
<value>&amp;lt;p&amp;gt;Dieser trendige Schneehut in der Farbe dunkelblau hat eine hohe Qualität, ist sehr robust und gemütlich.
Außerdem besitzt er ein süßes Detail aus vielen Fransen am oberen Ende des Hutes.
-Rollsaum
-sehr fein gewebter Stoff
-Stoff: leicht und elastisch
-Passform: normal
-Muster: uni
-Material: 65%Baumwolle 35%Polyester
Pflegehinweise: Maschinenwäsche bei 30 Grad
Artikelnummer: XX932048-34&amp;lt;/p&amp;gt;&amp;lt;br&amp;gt;&amp;lt;p&amp;gt;&amp;lt;br&amp;gt;&amp;lt;/p&amp;gt;</value>
</attribute>

<attribute type="FLOAT" id="535">
<name>price</name>
<label>Preis</label>
<value>27.9</value>
</attribute>

<attribute type="IMG" id="536">
<name>img1</name>
<label>Bild 1</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/cadf5ae384c909a010d3ab31bdb94456.jpg</value>
<width>200</width>
<height>200</height>
</attribute>

<attribute type="IMG" id="537">
<name>img2</name>
<label>Bild 2</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="CHAR" id="538">
<name>color</name>
<label>Farbe</label>
<value>dunkelblau</value>
</attribute>

<attribute type="IMG" id="539">
<name>img3</name>
<label>Bild 3</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="IMG" id="540">
<name>img4</name>
<label>Bild 4</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="PRODUCTS" id="541">
<name>related_items</name>
<label>ähnliche Produkte</label>
<value><product>
<id>35</id>
<name>Mütze blau</name>
<creation_date>2016-03-25 16:20:50</creation_date>
<class>colorprod</class>
<seo>
<permalink>gemusterte-blaue-muetze</permalink>
<title>Moderne Mütze mit Aztekenmuster und süßen Fransen</title>
<description>Superwarme Mütze mit Fransendetails</description>
<keywords>warm, muetze, fransen, aztekenmuster, unisex</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="437">
<name>name</name>
<label>Name</label>
<value>Mütze blau</value>
</attribute>

<attribute type="TXT" id="438">
<name>short_description</name>
<label>Kurzbeschreibung</label>
<value>Blaue Mütze in superweicher Qualität</value>
</attribute>

<attribute type="HTML" id="439">
<name>description</name>
<label>Beschreibung</label>
<value>Flauschige Mütze der Marke &amp;amp;quot;MützenLiebe&amp;amp;quot;. In Spanien hergestellt.
-süße Fransendetails
-breiter Umschlag
-Länge: 21 cm bei Größe One Size
-Materialkonstruktion: Ripp
-Fütterungsdicke: ungefüttert
-Muster: Aztekenmuster
-Material Oberstoff: 100% Polyacryl
-Pflegehinweise: nicht Trockner geeignet, Handwäsche
-Breite: 21 cm bei Größe One Size
Artikelnummer: C1454B00O-M11</value>
</attribute>

<attribute type="FLOAT" id="440">
<name>price</name>
<label>Preis</label>
<value>17.5</value>
</attribute>

<attribute type="IMG" id="441">
<name>img1</name>
<label>Bild 1</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/c613e0ea8b6640dae6f10697c37889da.jpg</value>
<width>200</width>
<height>200</height>
</attribute>

<attribute type="IMG" id="442">
<name>img2</name>
<label>Bild 2</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="CHAR" id="443">
<name>color</name>
<label>Farbe</label>
<value>himmelblau</value>
</attribute>

<attribute type="IMG" id="444">
<name>img3</name>
<label>Bild 3</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="IMG" id="445">
<name>img4</name>
<label>Bild 4</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="PRODUCTS" id="446">
<name>related_items</name>
<label>ähnliche Produkte</label>
<value><product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

<product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

<product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

</value>
</attribute>

<attribute type="PRODUCTS" id="447">
<name>featured_items</name>
<label>beliebte Produkte</label>
<value></value>
</attribute>

<attribute type="CHAR" id="448">
<name>vendor</name>
<label>Verkäufer</label>
<value>MuetzenLiebe.de</value>
</attribute>

<attribute type="CHAR" id="449">
<name>type</name>
<label>Art</label>
<value></value>
</attribute>

<attribute type="TXT" id="450">
<name>tags</name>
<label>Tags</label>
<value>Made in Spain,blau,Mütze,onesize,warm,Aztekenmuster,Fransen,Bommel</value>
</attribute>

<attribute type="CHAR" id="451">
<name>size</name>
<label>Größe</label>
<value>OneSize</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>36</id>
<name>Mütze schwarz</name>
<creation_date>2016-03-25 16:24:52</creation_date>
<class>colorprod</class>
<seo>
<permalink>flauschiger-schneehut-schwarz</permalink>
<title>Superweicher schwarzer Schneehut</title>
<description>Warmer Schneehut der Trendmarke SchneeHut</description>
<keywords>schwarz, schneehut, weich, warm</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
<allow_override>0</allow_override>
<active>0</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>23</length>
<width>15</width>
<height>26</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="452">
<name>name</name>
<label>Name</label>
<value> Schneehut schwarz</value>
</attribute>

<attribute type="TXT" id="453">
<name>short_description</name>
<label>Kurzbeschreibung</label>
<value>Superflauschiger Schneehut in schwarz</value>
</attribute>

<attribute type="HTML" id="454">
<name>description</name>
<label>Beschreibung</label>
<value>Flauschige Mütze der Marke &amp;amp;quot;SchneeHut&amp;amp;quot;
-Logo-Patch
-breiter Umschlag
-Länge: 21 cm bei Größe One Size
-Materialkonstruktion: Ripp
-Fütterungsdicke: ungefüttert
-Muster: unifarben
-Material Oberstoff: 100% Polyacryl
-Pflegehinweise: nicht Trockner geeignet, Handwäsche
-Breite: 21 cm bei Größe One Size
Artikelnummer: C1454B00O-M11

</value>
</attribute>

<attribute type="FLOAT" id="455">
<name>price</name>
<label>Preis</label>
<value>18.9</value>
</attribute>

<attribute type="IMG" id="456">
<name>img1</name>
<label>Bild 1</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/5d618534dfd89666cf496cece4355397.jpg</value>
<width>200</width>
<height>200</height>
</attribute>

<attribute type="IMG" id="457">
<name>img2</name>
<label>Bild 2</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="CHAR" id="458">
<name>color</name>
<label>Farbe</label>
<value>schwarz</value>
</attribute>

<attribute type="IMG" id="459">
<name>img3</name>
<label>Bild 3</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="IMG" id="460">
<name>img4</name>
<label>Bild 4</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="PRODUCTS" id="461">
<name>related_items</name>
<label>ähnliche Produkte</label>
<value><product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

<product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

<product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

</value>
</attribute>

<attribute type="PRODUCTS" id="462">
<name>featured_items</name>
<label>beliebte Produkte</label>
<value></value>
</attribute>

<attribute type="CHAR" id="463">
<name>vendor</name>
<label>Verkäufer</label>
<value>SchneeHut.de</value>
</attribute>

<attribute type="CHAR" id="464">
<name>type</name>
<label>Art</label>
<value>Huete und Muetzen</value>
</attribute>

<attribute type="TXT" id="465">
<name>tags</name>
<label>Tags</label>
<value>warm,flauschig,modisch,schwarz,unisex,onesize,Fleece</value>
</attribute>

<attribute type="CHAR" id="466">
<name>size</name>
<label>Größe</label>
<value>OneSize</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

<product>
<id>34</id>
<name>Mütze orange</name>
<creation_date>2016-03-25 16:19:24</creation_date>
<class>colorprod</class>
<seo>
<permalink>muetze-orange-onesize</permalink>
<title>Trendige Mütze mit Aztekenmuster</title>
<description>Superwarme und flauschige Mütze</description>
<keywords>warm, flauschig, orange, muetze, aztekenmuster</keywords>
</seo>

<availability>
<quantity>0</quantity>
<quantity_warning>3</quantity_warning>
<allow_override>0</allow_override>
<active>1</active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="Standard" calculation="INC">0.19</taxclass>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>

<attributes>
<attribute type="CHAR" id="422">
<name>name</name>
<label>Name</label>
<value>Mütze orange</value>
</attribute>

<attribute type="TXT" id="423">
<name>short_description</name>
<label>Kurzbeschreibung</label>
<value>Tolle Mütze in orange</value>
</attribute>

<attribute type="HTML" id="424">
<name>description</name>
<label>Beschreibung</label>
<value>Flauschige Mütze der Marke &amp;amp;quot;MützenLiebe&amp;amp;quot;. In Spanien hergestellt.
-Farbe: orange
-Bommel aus süßen Fransen
-breiter Umschlag
-Länge: 21 cm bei Größe One Size
-Materialkonstruktion: Ripp
-Fütterungsdicke: ungefüttert
-Muster: Aztekenmuster
-Material Oberstoff: 100% Polyacryl
-Pflegehinweise: nicht Trockner geeignet, Handwäsche
-Breite: 21 cm bei Größe One Size
Artikelnummer: C1454B00O-M11</value>
</attribute>

<attribute type="FLOAT" id="425">
<name>price</name>
<label>Preis</label>
<value>17.5</value>
</attribute>

<attribute type="IMG" id="426">
<name>img1</name>
<label>Bild 1</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/27aedf1752b483b41b6287ce885468d7.jpg</value>
<width>200</width>
<height>200</height>
</attribute>

<attribute type="IMG" id="427">
<name>img2</name>
<label>Bild 2</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="CHAR" id="428">
<name>color</name>
<label>Farbe</label>
<value>orange</value>
</attribute>

<attribute type="IMG" id="429">
<name>img3</name>
<label>Bild 3</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="IMG" id="430">
<name>img4</name>
<label>Bild 4</label>
<value>https://demo.sleekshop.net/srv/uploads/shopobject_images/</value>
<width></width>
<height></height>
</attribute>

<attribute type="PRODUCTS" id="431">
<name>related_items</name>
<label>ähnliche Produkte</label>
<value><product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

<product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

<product>
<id></id>
<name></name>
<creation_date></creation_date>
<class></class>
<seo>
<permalink></permalink>
<title></title>
<description></description>
<keywords></keywords>
</seo>

<availability>
<quantity></quantity>
<quantity_warning></quantity_warning>
<allow_override></allow_override>
<active></active>
</availability>

<metadata>
<element_number></element_number>
<taxclass name="" calculation=""></taxclass>
<length></length>
<width></width>
<height></height>
<weight></weight>
<notes></notes>
</metadata>

<attributes>

</attributes>
<variations>

</variations>
</product>

</value>
</attribute>

<attribute type="PRODUCTS" id="432">
<name>featured_items</name>
<label>beliebte Produkte</label>
<value></value>
</attribute>

<attribute type="CHAR" id="433">
<name>vendor</name>
<label>Verkäufer</label>
<value>MuetzenLiebe.de</value>
</attribute>

<attribute type="CHAR" id="434">
<name>type</name>
<label>Art</label>
<value></value>
</attribute>

<attribute type="TXT" id="435">
<name>tags</name>
<label>Tags</label>
<value>Made in Spain,Mütze,orange,Aztekenmuster,Fransen,Bommel,Damen,onesize</value>
</attribute>

<attribute type="CHAR" id="436">
<name>size</name>
<label>Größe</label>
<value>OneSize</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

</value>
</attribute>

<attribute type="PRODUCTS" id="542">
<name>featured_items</name>
<label>beliebte Produkte</label>
<value></value>
</attribute>

<attribute type="CHAR" id="543">
<name>vendor</name>
<label>Verkäufer</label>
<value>sleekcommerce</value>
</attribute>

<attribute type="CHAR" id="544">
<name>type</name>
<label>Art</label>
<value>Made in Germany</value>
</attribute>

<attribute type="TXT" id="545">
<name>tags</name>
<label>Tags</label>
<value>Made in Germany</value>
</attribute>

<attribute type="CHAR" id="546">
<name>size</name>
<label>Größe</label>
<value>one size</value>
</attribute>


</attributes>
<variations>

</variations>
</product>

</aggregate_special_product></aggregate>
                    

<p>As you can see we have a main aggregate object and the two parts: aggregate_names and aggregate_special_product. These two parts contain the response for the corresponding requests.</p>

get_status

This command will return the status of the server

For simply getting the server - status you can use these command.

Arguments

  • licence_username (string)

    Your licence - username.

  • licence_password (string)

    Your licence - password.


Request

curl https://demo.sleekshop.net/srv/service/ \ -d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \ -d licence_password='s9vmrbwT23B7bmjR4Vmz' \ -d request='get_status'


Response

                    {
  "object":"status",
  "server_status":"running",
  "data_status":"incomplete",
  "products_count":22,
  "contents_count":4
}
                    

                      <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<status>
<server_status>running</server_status>
<data_status>incomplete</data_status>
<products_count>22</products_count>
<contents_count>4</contents_count>
</status>
                    

Explanation

server_statusThe status of the server, wether running or stopped.
data_statusIndicated wether the data for debiting is complete or not.
products_countCount of products.
contents_countCount of contents.