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
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 on the right hand side, where we want to fetch the details of the product with the id: 37.
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.
This request delivers data of the desired product. Which data sleekshop returns depends first of all on the class the product extends and can be restricted with "needed_attributes". In the example we only want to fetch the data of the attributes "name" and "price". We also want to hide the variations.
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.
If you don't have a sleekshop - backend, create one here : startnow. We recommend you to choose "demoshop" as sample - data.
1. Create a class
If you already have classes and products you can go to step 2.
First create your first class by clicking: Administration->Objects->Create a new class.
After this enter a name describing your class and click on the button "Create class".
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.
2. Execute an api call
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.
We highly recommend to use our Postman library to get started: Click here
All requests are collected in the postman file and are ready to execute after you replace your api-credentials.
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. |
Using Postman
You can use postman for execution of the requests described.
We highly recommend you to download postman and run the following collection which includes all requests in this documentation. After importing the collection you have to set the environment - variables in the collection. Just click the following button or search in postman for sleekshops api:
Postman enables you to execute all the sleekshop - requests comfortable via postman - application.
For more informations about postman visit: Postman Website
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
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_date | Date of creation for the session. |
|---|---|
| expiration_date | Date of expiration for the session. |
| code | The session code which has to be used for identifying this session. |
get_categories
Delivers the categories with the parent defined by id.
Arguments
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_category | Section containing informations about the parent category. |
|---|---|
| categories | Section 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_columns (json-array)
The order columns.
-
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_columns=["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;quot;Lauf,Schuh!&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;quot;Lauf,Schuh!&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
| category | Section containing informations about the category. |
|---|---|
| products | Section 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_columns (json-array)
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_columns=["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
| category | Section containing informations about the category. |
|---|---|
| contents | Section 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_columns (json-array)
The order columns.
-
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_columns=["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;quot;Lauf,Schuh!&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;quot;Lauf,Schuh!&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
| category | Section containing informations about the category. |
|---|---|
| products | Section containing all products in the category. |
| contents | Section 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_columns (json-array)
The order columns.
-
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.needed_attributes (json-array)
-
depth (int)
Specifies the depth you want to be listed in the tree you are iterating. If you use 0 then the maximum available depth will be iterated.
-
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_columns=["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;quot;Lauf,Schuh!&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;quot;Lauf,Schuh!&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_category | Section containing informations about the corresponding parent category. |
|---|---|
| products_in_category | Section containing all products in the category. |
| contents_in_category | Section containing all contents in the category. |
| shop_categories | Section 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_columns (json-array)
The order columns.
-
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_columns=["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
| category | Section containing informations about the category. |
|---|---|
| products | Section 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_columns (json-array)
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_columns=["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
| category | Section containing informations about the category. |
|---|---|
| contents | Section 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_columns (json-array)
The order columns.
-
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_columns=["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;quot;Lauf,Schuh!&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;quot;Lauf,Schuh!&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
| category | Section containing informations about the category. |
|---|---|
| products | Section containing all products in the category. |
| contents | Section containing all contents in the category. |
create_category
This request can be used to create categories. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
-
id_parent (int)
The id of the parent - category. Use 0 if you want to add a node at the root.
-
name (string)
The name of the new category.
-
labels (json-array)
A JSON - array containing the labels for the category.
-
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.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
labels (json-array):
The array is an associative array which has the language as key and the desired label as value. As an example, if you want to set the label in german with the value myvalue, you would provide the following array:
{"de_DE":"myvalue"}
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
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_category' \
-d id_parent=123 \
-d name='name_new' \
-d labels='{"de_DE":"123321"}' \
-d attributes='{"de_DE":{"name":"Test"}}' \
-d seo='{"de_DE":{"permalink":"test546576"}}' \
Response
{
"object":"create_category",
"id":"162"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_category>
<id>161</id>
</create_category>
Explanation
| id | The id of the category just created. |
|---|
update_category
This request can be used to update categories. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
-
id_category (int)
The id of the parent - category. Use 0 if you want to add a node at the root.
-
name (string)
The name of the new category.
-
labels (json-array)
A JSON - array containing the labels for the category.
-
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.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
labels (json-array):
The array is an associative array which has the language as key and the desired label as value. As an example, if you want to set the label in german with the value myvalue, you would provide the following array:
{"de_DE":"myvalue"}
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
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_category' \
-d id_category=123 \
-d name='name_new' \
-d labels='{"de_DE":"123321"}' \
-d attributes='{"de_DE":{"name":"Test"}}' \
-d seo='{"de_DE":{"permalink":"test546576"}}' \
Response
{
"object":"update_category",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<update_category>
<status>success</status>
</update_category>
Explanation
| status | The status of the operation. |
|---|
delete_category
This request can be used to delete categories. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
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='delete_category' \
-d id_category=123 \
Response
{
"object":"delete_category",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<delete_category>
<status>success</status>
</delete_category>
Explanation
| status | The status of the operation. |
|---|
get_class_details
Delivers the details of a given class determined by its id.
Arguments
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='get_class_details' \
-d id_class=265 \
-d language='de_DE'
Response
{
"object": "class",
"id": 265,
"name": "test",
"creation_date": "2024-06-14 02:01:51",
"attributes": {
"attribute_5122": {
"type": "CHAR",
"id": 5123,
"name": "attribute_5122",
"label": "",
"value": ""
},
"short_description": {
"type": "TXT",
"id": 5124,
"name": "short_description",
"label": "Kurzbeschreibung",
"value": ""
},
"price": {
"type": "FLOAT",
"id": 5125,
"name": "price",
"label": "Preis",
"value": 0
}
}
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<class>
<id>265</id>
<name>test</name>
<creation_date>2024-06-14 02:01:51</creation_date>
<class></class>
<attributes>
<attribute type="CHAR" id="5123">
<name>attribute_5122</name>
<label></label>
<value></value>
</attribute>
<attribute type="TXT" id="5124">
<name>short_description</name>
<label>Kurzbeschreibung</label>
<value></value>
</attribute>
<attribute type="FLOAT" id="5125">
<name>price</name>
<label>Preis</label>
<value>0</value>
</attribute>
</attributes>
</class>
create_class
This request can be used to create classes. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
name (string):
A unique name which determines the class.
type (string):
A valid type which can be one of the following:
- product
- content
- warehouse_entity
- user
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_class' \
-d name='your-class' \
-d type='product'
Response
{
"object":"create_class",
"id":"42"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_class>
<id>42</id>
</create_class>
Explanation
| id | The id of the class just created. |
|---|
delete_class
This request can be used to delete classes.
Arguments
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='delete_class' \
-d id_class=163
Response
{
"object":"delete_class",
"status":"success"
}
<delete_class>
<status>success</status>
</delete_class>
Explanation
| status | The status of the operation. |
|---|
create_class_attributes
This request can be used to create class-attributes. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
attributes (json-array):
The array which contains arrays, one for each attribute. The attribute arrays contain the name and the type followed by language key which also contains an array with label and value:
[{"name":"test", "type":"TXT", "de_DE":{"label":"testlabel", "value":"test-val"}}]
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_class_attributes' \
-d id_class=42 \
-d attributes='[{"name":"test","type":"TXT","de_DE":{"label":"testlabel","value":"test-val"}}]'
Response
{
"object":"create_class_attributes",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_class_attributes>
<status>success</status>
</create_class_attributes>
delete_class_attributes
This request can be used to delete class-attributes. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
attributes (json-array):
The array which contains the attributes by name we want to delete:
["attr1","attr2"]
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='delete_class_attributes' \
-d id_class=42 \
-d attributes='["attr1","attr2"]'
Response
{
"object":"delete_class_attributes",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<delete_class_attributes>
<status>success</status>
</delete_class_attributes>
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": 15,
"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":""
}
,
"categories":[
{
"name":"Start",
"prio":1,
"id":1,
"id_parent":0,
"label":"Start",
"seo":
{
"permalink": "start",
"title": "demo"
},
"attributes":{
}
}
]
,
"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>15</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>
<categories>
<category>
<name>Start</name>
<prio>1</prio>
<id>1</id>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink>start</permalink>
<title>demo</title>
</seo>
<attributes></attributes>
</category>
</categories>
<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
| id | The id of the product. |
|---|---|
| name | The name of the product. |
| creation_date | The creation date of the product. |
| class | The class of the product. |
| seo | The SEO - section for the product. |
| availability | The availability - section for the product. |
| metadata | The metadata section of the product. |
| categories | The categories section of the product. |
| attributes | The attributes section of the product. |
| variations | The section containing all variations. |
get_content_details
Delivers the content - details for the product defined by its id.
Arguments
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
| id | The id of the content. |
|---|---|
| name | The name of the content. |
| creation_date | The creation date of the content. |
| class | The class of the content. |
| seo | The SEO - section for the content. |
| attributes | The attributes section of the content. |
| variations | The 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
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": 15,
"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":""
}
,
"categories":[
{
"name":"Start",
"prio":1,
"id":1,
"id_parent":0,
"label":"Start",
"seo":
{
"permalink": "start",
"title": "demo"
},
"attributes":{
}
}
]
,
"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>15</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>
<categories>
<category>
<name>Start</name>
<prio>1</prio>
<id>1</id>
<id_parent>0</id_parent>
<label>Start</label>
<seo>
<permalink>start</permalink>
<title>demo</title>
</seo>
<attributes></attributes>
</category>
</categories>
<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
| id | The id of the product. |
|---|---|
| name | The name of the product. |
| creation_date | The creation date of the product. |
| class | The class of the product. |
| seo | The SEO - section for the product. |
| availability | The availability - section for the product. |
| metadata | The metadata section of the product. |
| categories | The categories section of the product. |
| attributes | The attributes section of the product. |
| variations | The section containing all variations. |
seo_get_content_details
Delivers the content - details for the content defined by its permalink.
Arguments
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>&lt;p&gt;Hier steht das Impressum&lt;/p&gt;&lt;br&gt;&lt;p&gt;&lt;br&gt;&lt;/p&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
| id | The id of the content. |
|---|---|
| name | The name of the content. |
| creation_date | The creation date of the content. |
| class | The class of the content. |
| seo | The SEO - section for the content. |
| attributes | The attributes section of the content. |
| variations | The 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 product you want to create.
-
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.
-
add_binding (boolean)
This parameter determines wether the created product shall be bound to its warehouse_entity which is the normal behavior.
-
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
- taxclass (use the name of the corresponding class)
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='your-class' \
-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":"create_product",
"id":"162"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_product>
<id>161</id>
</create_product>
Explanation
| id | The 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
- taxclass (use the name of the corresponding class)
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
| status | The 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
| id | The id of the product just created. |
|---|
delete_product
This request can be used to delete products.
Arguments
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='delete_product' \
-d id_product=163
Response
{
"object":"delete_product",
"status":"success"
}
<delete_product>
<status>success</status>
</delete_product>
Explanation
| status | The status of the operation. |
|---|
create_content
This request can be used to create contents. 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 product you want to create.
-
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.
-
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
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_content' \
-d class='your-class' \
-d name='name_new2' \
-d shop_active=1 \
-d attributes='{"de_DE":{"name":"Test"}}' \
-d seo='{"de_DE":{"permalink":"test546576"}}' \
Response
{
"object":"create_content",
"id":"162"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_content>
<id>161</id>
</create_content>
Explanation
| id | The id of the content just created. |
|---|
update_content
This request can be used to update contents. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
-
id_content (int)
The id of the content 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.
-
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
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_content' \
-d id_content=163 \
-d name='name_new2' \
-d shop_active=1 \
-d attributes='{"de_DE":{"name":"Test"}}' \
-d seo='{"de_DE":{"permalink":"test546576"}}'
Response
{
"object":"update_content",
"status":"success"
}
<update_content>
<status>success</status>
</update_content>
Explanation
| status | The status of the operation. |
|---|
delete_content
This request can be used to delete contents.
Arguments
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='delete_content' \
-d id_product=163
Response
{
"object":"delete_content",
"status":"success"
}
<delete_content>
<status>success</status>
</delete_content>
Explanation
| status | The status of the operation. |
|---|
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_columns='["price"]' \
-d order_type="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
| count | The total number of objects matching the constraint. |
|---|---|
| limit_count | The number of objects matching our limitations. |
| result | A 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.
-
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 order_columns='["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
| count | The total number of objects matching the constraint. |
|---|---|
| limit_count | The number of objects matching our limitations. |
| result | A 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
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
| count | The count of found elements. |
|---|---|
| field | A 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.
-
needed_attributes (json-array)
This arrays specifies a selection of attributes you want to be listed. Here you can select main order attributes. In the hideblock you can user : cart,attributes,parcels.
-
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",
"count": 12,
"limit_count": 6,
"result":[
{
"object":"order",
"id":3,
"order_number":3,
"creation_date":"2016-11-13 16:31:46",
"username":"root",
"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_delivery_country_code":"DE",
"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_invoice_country_code":"DE",
"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,
"element_number":"123",
"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>
<count>12</count>
<limit_count>6</limit_count>
<order>
<id>3</id>
<order_number>3</order_number>
<creation_date>2016-11-13 16:31:46</creation_date>
<username>root</username>
<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>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_delivery_country_code>DE</order_delivery_country_code>
<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_invoice_country_code>DE</order_invoice_country_code>
<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>
<element_number>123</element_number>
<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</weight>
<arg1></arg1>
<arg2></arg2>
<arg3></arg3>
</parcel>
</parcels>
</order>
</search_orders_result>
Explanation
| id | The id of the order. |
|---|---|
| order_number | The order number. |
| creation_date | The creation date of the order. |
| order_delivery fields | Some fields showing the delivery - data. |
| order_invoice fields | Some fields showing the invoice - data. |
| order_email | The email of the order. |
| order_phone | The order - phone number. |
| order_notes | The notes for the order. |
| payment_method | The payment method. |
| payment_state | The payment state informations. |
| delivery_method | The delivery method. |
| delivery_state | The delivery state informations. |
| order_state | The state of the order. |
| cart | The cart and cart - contents of the order. |
| parcels | The corresponding parcels of the order. |
search_users
Delivers users matching the constraint defined.
Arguments
-
constraint (json-array)
A constraint defining defining which products to deliver.
-
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.
-
licence_secret_key (string)
Your licence - secret - key.
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='' \
-d request='search_users' \
-d constraint='{"main.firstname":["LIKE","a"]}' \
-d order_columns='["main.username"]' \
-d order="DESC" \
-d left_limit=0 \
-d right_limit=2 \
-d needed_attributes='["name_extra","account"]'
Here we are requesting the users where the main - firstname attribute has an a, and we are sorting by the username DESC.
Response
{
"object":"search_users_result",
"count":1,
"limit_count":1,
"result":[
{
"object":"user",
"status":"active",
"id_user":481,
"username":"testuser",
"email":"test123@test123.de",
"default_language":"de_DE",
"reg_date":"2023-05-17 01:56:51",
"first_login":"",
"last_login":"",
"attributes":{
"salutation":
{
"name":"salutation",
"value":"Mrs"
},
"firstname":
{
"name":"firstname",
"value":"test1"
},
"lastname":
{
"name":"lastname",
"value":"test123"
},
"companyname":
{
"name":"companyname",
"value":""
},
"department":
{
"name":"department",
"value":""
},
"street":
{
"name":"street",
"value":"street test"
},
"number":
{
"name":"number",
"value":"123"
},
"zip":
{
"name":"zip",
"value":"12345"
},
"city":
{
"name":"city",
"value":"hamburg"
},
"state":
{
"name":"state",
"value":"hamburg"
},
"country":
{
"name":"country",
"value":""
},
"vat_number":
{
"name":"vat_number",
"value":""
}
},
"additional_attributes":{
},
"addresses":
[
]
}
]
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<search_users_result>
<count>
1
</count>
<limit_count>
1
</limit_count>
<user>
<status>active</status>
<id_user>481</id_user>
<username>testuser</username>
<email>test123@test123.de</email>
<default_language>de_DE</default_language>
<reg_date>2023-05-17 01:56:51</reg_date>
<first_login></first_login>
<last_login></last_login>
<attributes>
<salutation>Mrs</salutation>
<firstname>test1</firstname>
<lastname>test123</lastname>
<companyname></companyname>
<department></department>
<street>street test</street>
<number>123</number>
<zip>12345</zip>
<city>hamburg</city>
<state>hamburg</state>
<country></country>
<vat_number></vat_number>
</attributes>
<additional_attributes>
</additional_attributes>
<addresses>
</addresses>
</user>
</search_users_result>
Explanation
| count | The total number of objects matching the constraint. |
|---|---|
| limit_count | The number of objects matching our limitations. |
| result | A listing of all warehouse entities the search delivered. |
search_warehouse_entities
Delivers warehouse entities matching the constraint defined.
Arguments
-
constraint (json-array)
A constraint defining defining which products to deliver.
-
language (string)
A valid language-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.
-
licence_secret_key (string)
Your licence - secret - key.
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='' \
-d request='search_products' \
-d constraint='{"name":["LIKE","a"]}' \
-d language="de_DE" \
-d order_columns='["price"]' \
-d order="DESC" \
-d left_limit=0 \
-d right_limit=2 \
-d needed_attributes='["name","price"]'
Here we are requesting the warehouse entities matching the constraint. We want the products to be listed in german defined by the language - code "de_DE". Further we want the entities to be listed ordered by the price descending. Left - limit is 0 an right - limit is 2 so only 2 warehouse entities will be listed. The attributes we want to be listed are "name" and "price".
Response
{
"object":"search_warehouse_entities_result",
"count":4,
"limit_count":2,
"result":[
{
"object":"warehouse_entity",
"id":153,
"name":"tchibo_1_blonde_roast",
"creation_date":"2021-02-25 00:52:52",
"class":"product",
"availability":
{
"quantity": 0,
"quantity_warning": 0
},
"metadata":
{
"element_number": "",
"length":0,
"width":0,
"height":0,
"weight":0,
"notes":""
},
"attributes":{
"name":
{
"type":"CHAR",
"id":2343,
"name":"name",
"label":"Name",
"value":"Blonde Roast"
}
, "price":
{
"type":"FLOAT",
"id":2346,
"name":"price",
"label":"Preis",
"value":9
}
}
}
,
{
"object":"warehouse_entity",
"id":3,
"name":"Schneehut dunkelblau",
"creation_date":"2016-03-25 17:22:22",
"class":"colorprod",
"availability":
{
"quantity": 102,
"quantity_warning": 2
},
"metadata":
{
"element_number": "123321",
"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
}
}
}
]
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<search_warehouse_entities_result>
<count>
4
</count>
<limit_count>
2
</limit_count>
<warehouse_entity>
<id>153</id>
<name>tchibo_1_blonde_roast</name>
<creation_date>2021-02-25 00:52:52</creation_date>
<class>product</class>
<availability>
<quantity>0</quantity>
<quantity_warning>0</quantity_warning>
</availability>
<metadata>
<element_number></element_number>
<length>0</length>
<width>0</width>
<height>0</height>
<weight>0</weight>
<notes></notes>
</metadata>
<attributes>
<attribute type="CHAR" id="2343">
<name>name</name>
<label>Name</label>
<value>Blonde Roast</value>
</attribute>
<attribute type="FLOAT" id="2346">
<name>price</name>
<label>Preis</label>
<value>9</value>
</attribute>
</attributes>
</warehouse_entity>
<warehouse_entity>
<id>3</id>
<name>Schneehut dunkelblau</name>
<creation_date>2016-03-25 17:22:22</creation_date>
<class>colorprod</class>
<availability>
<quantity>102</quantity>
<quantity_warning>2</quantity_warning>
</availability>
<metadata>
<element_number>123321</element_number>
<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>
</warehouse_entity>
</search_warehouse_entities_result>
Explanation
| count | The total number of objects matching the constraint. |
|---|---|
| limit_count | The number of objects matching our limitations. |
| result | A listing of all warehouse entities the search delivered. |
search_classes
Delivers classes matching the constraint defined.
Arguments
-
constraint (json-array)
A constraint defining defining which classes to deliver.
-
language (string)
A valid language-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.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='' \
-d request='search_classes' \
-d constraint='{"name":["LIKE","a"]}' \
-d language="de_DE" \
-d order_columns='["price"]' \
-d order="DESC" \
-d left_limit=0 \
-d right_limit=2 \
Response
{
"object": "search_classes_result",
"count": 1,
"limit_count": 1,
"result": [
{
"object": "class",
"id": 265,
"name": "test",
"creation_date": "2024-06-14 02:01:51",
"attributes": {
"name": {
"type": "CHAR",
"id": 5123,
"name": "name",
"label": "Name",
"value": ""
},
"short_description": {
"type": "TXT",
"id": 5124,
"name": "short_description",
"label": "Kurzbeschreibung",
"value": ""
},
"price": {
"type": "FLOAT",
"id": 5125,
"name": "price",
"label": "Preis",
"value": 0
}
}
}
]
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<search_classes_result>
<count>
1
</count>
<limit_count>
1
</limit_count>
<class>
<id>265</id>
<name>test</name>
<creation_date>2024-06-14 02:01:51</creation_date>
<class></class>
<attributes>
<attribute type="CHAR" id="5123">
<name>name</name>
<label>Name</label>
<value></value>
</attribute>
<attribute type="TXT" id="5124">
<name>short_description</name>
<label>Kurzbeschreibung</label>
<value></value>
</attribute>
<attribute type="FLOAT" id="5125">
<name>price</name>
<label>Preis</label>
<value>0</value>
</attribute>
</attributes>
</class>
</search_classes_result>
Explanation
| count | The total number of objects matching the constraint. |
|---|---|
| limit_count | The number of objects matching our limitations. |
| result | A listing of all classes the search delivered. |
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)
- id_variation (the variation 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)
- permalink (the permalink of the category)
- title (the title of the attribute)
- path (an attribute containing nodes like described below)
An example constraint could look like this:
{"category.name":"Start"}
or
{"category.id_shopcategory":1}
Category - Path and Nodes
You can also address the node structure of categories that contain shopobjects. The entire node structure is contained in the Path attribute:
- name (a string that contains the path)
- path.nodes - array (an array of nodes that belong to the path)
The path nodes can also be addressed:
- name ( the name of the node)
- prio ( the prio )
- id_parent ( the parent id )
- label ( the label of the node )
So if you want to address the products that are in a category which belongs to a path that contains a category named : "test" you can form the following constraint:
{"category.path.nodes.name":"test"}
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}
Seo
There is also the possibility to address the seo attributes of shopobjects:
- permalink (the permalink)
- title (the title)
- description (the description)
- keywords (the keywords)
To address these attributes you have to use the "seo - modifier". If you search for products with an seo permalink matching "my-permalink" you can form the following constraint:
{"seo.permalink":"my-permalink"}
The PRODUCT - attribute
You can apply all defined modifiers to attributes of products inherited in a PRODUCTS - attribute. If your PRODUCTS - attribute is named prod and contains products
that have an attribute named color you can search for products that have products in the prod - attribute with the color red:
{"prod.color":"red"}
Variations
There is also the possibility to address all the fields of variations of a product:
To address these attributes you have to use the "variations - modifier". If you search for products with with a variation which has the color red:
{"variations.color":"red"}
You can use all modifiers that fit for products also for variations.
Order attributes
Main attributes
There are several possibilities to address order - data attributes. The following fields are available:
- id_order (the id of the order)
- order_number (the order number)
- id_user (the id of the user)
- username (the username)
- creation_date
- modification_date
- delivery_companyname
- delivery_department
- delivery_salutation
- delivery_firstname
- delivery_lastname
- delivery_street
- delivery_number
- delivery_zip
- delivery_state
- delivery_city
- delivery_country
- delivery_country_code
- invoice_companyname
- invoice_department
- invoice_salutation
- invoice_firstname
- invoice_lastname
- invoice_street
- invoice_number
- invoice_zip
- invoice_state
- invoice_city
- invoice_country
- invoice_country_code
- phone
- notes
- payment_method_name
- payment_state_name
- delivery_method_name
- delivery_state_name
- order_state_name
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 order with the delivery_firstname: test you can form a constraint like this:
{"main.delivery_firstname":"test"}
Cart attributes
- element_type_name (COUPON, DELIVERY, PRODUCT. PRODUCT_GR, FREE_ELEMENT, FREE_ELEMENT_GR)
- id_shopobject
- element_number
- quantity
- price
- sum_price
- name
- description
You have also the possibility to search for cart contents. Therefore you can use the contents - modifier. If you want to search for orders with cart - elements that have the name product1 then you can form a constraint like this:
{"contents.name":"product1"}
Order attributes
You can also search for orders with special attributes you have set while creation. Therefore you can easily use the name of the attribute and the value:
{"attribute1":"value1","attribute2","value2"}
Please notice that all order attributes are saved as strings so the value have to delivered as string.
User attributes
Main attributes
There are several possibilities to address user - data attributes. The following fields are available:
- status (the status of the user)
- id_user (the id of the user)
- username
- default_language
- reg_date
- first_login
- last_login
- salutation
- firstname
- companyname
- department
- street
- number
- zip
- city
- state
- country
- vat_number
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 the user with the
firstname: test you can form a constraint like this:
{"main.firstname":"test"}
additional attributes
There attributes are attributes that are inherited by the mother - class. They can be addressed like normal attributes of shopobjects.
So if you have an additional class attribute with the name : test_field and you want to find users where test_field has the value 111 then you can form a constraint like this:
{"test_field":111}
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},"1":{"short_description":"short_txt"}}]
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,
"element_number":"123",
"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":""
}
}
}
],
"coupons":{
"sum":12,
"positions":[
{
"name":"campaign",
"code":"mg7a-c41a-d9h7-i5aa",
"amount":12,
"used_amount":12,
"tax":0.16
}
]
},
"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>
<element_number>42</element_number>
<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>
<coupons>
<sum>12</sum>
<positions>
<position>
<name>campaign</name>
<code>mg7a-c41a-d9h7-i5aa</code>
<amount>12</amount>
<used_amount>12</used_amount>
<tax>0.16</tax>
</position>
</positions>
</coupons>
<delivery_costs>
<sum>0</sum>
<positions>
</positions>
</delivery_costs>
</cart>
Explanation
| creation_date | Date of creation. |
|---|---|
| sum | The total sum of the cart. |
| contents | A section containing all cart elements. |
| coupons | A section containing the calculated coupons. |
| delivery_costs | A section containing the calculated delivery costs. |
sub_from_cart
Decreases an element from the cart by one.
Arguments
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,
"element_number":"123",
"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":""
}
}
}
],
"coupons":{
"sum":12,
"positions":[
{
"name":"campaign",
"code":"mg7a-c41a-d9h7-i5aa",
"amount":12,
"used_amount":12,
"tax":0.16
}
]
},
"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>
<element_number>42</element_number>
<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>
<coupons>
<sum>12</sum>
<positions>
<position>
<name>campaign</name>
<code>mg7a-c41a-d9h7-i5aa</code>
<amount>12</amount>
<used_amount>12</used_amount>
<tax>0.16</tax>
</position>
</positions>
</coupons>
<delivery_costs>
<sum>0</sum>
<positions>
</positions>
</delivery_costs>
</cart>
Explanation
| cart | Delivers a cart. |
|---|
del_from_cart
Deletes an element from the cart.
Arguments
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,
"element_number":"123",
"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":""
}
}
}
],
"coupons":{
"sum":12,
"positions":[
{
"name":"campaign",
"code":"mg7a-c41a-d9h7-i5aa",
"amount":12,
"used_amount":12,
"tax":0.16
}
]
},
"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>
<element_number>42</element_number>
<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>
<coupons>
<sum>12</sum>
<positions>
<position>
<name>campaign</name>
<code>mg7a-c41a-d9h7-i5aa</code>
<amount>12</amount>
<used_amount>12</used_amount>
<tax>0.16</tax>
</position>
</positions>
</coupons>
<delivery_costs>
<sum>0</sum>
<positions>
</positions>
</delivery_costs>
</cart>
Explanation
| cart | Delivers a cart. |
|---|
clear_cart
Deletes the complete cart and delivers an empty one.
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='clear_cart' \
-d session='A_VALID_SESSION_ID'
Response
{
"object":"cart",
"creation_date":"2022-02-11 03:47:31",
"sum":0,
"contents":[
],
"coupons":{
"sum":0,
"positions":[
]
},
"delivery_costs":{
"sum":0,
"positions":[
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<cart>
<creation_date>2022-02-11 03:59:37</creation_date>
<sum>0</sum>
<contents>
</contents>
<coupons>
<sum>0</sum>
<positions>
</positions>
</coupons>
<delivery_costs>
<sum>0</sum>
<positions>
</positions>
</delivery_costs>
</cart>
Explanation
| cart | Delivers a cart. |
|---|
get_cart
Delivers the cart and its contents from a given session.
Arguments
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":27.9,
"contents":[
{
"type":"PRODUCT",
"id":498,
"id_product":42,
"element_number":"123",
"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":""
}
}
}
],
"coupons":{
"sum":12,
"positions":[
{
"name":"campaign",
"code":"mg7a-c41a-d9h7-i5aa",
"amount":12,
"used_amount":12,
"tax":0.16
}
]
},
"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>
<element_number>42</element_number>
<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>
<coupons>
<sum>12</sum>
<positions>
<position>
<name>campaign</name>
<code>mg7a-c41a-d9h7-i5aa</code>
<amount>12</amount>
<used_amount>12</used_amount>
<tax>0.16</tax>
</position>
</positions>
</coupons>
<delivery_costs>
<sum>0</sum>
<positions>
</positions>
</delivery_costs>
</cart>
Explanation
| creation_date | Date of creation. |
|---|---|
| sum | The total sum of the cart. |
| contents | A section containing all cart elements. |
| coupons | A section containing the calculated coupons. |
| delivery_costs | A section containing the calculated delivery costs. |
register_user
Is used to create user - accounts via API.
Arguments
language (string)
The language of the user.
args (json-array)
The data of the user you want to register.
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
| status | A statuscode which shows wether the action was successful or not. |
|---|---|
| id_user | The id of the created user. |
| session_id | The 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
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
| status | The 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
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",
"security_level":1001
}
<?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>
<security_level>101</security_level>
</login_user>
Explanation
| status | A status determining wether the action was successful or not. |
|---|---|
| id_user | The id of the user. |
| session_id | The session_id of the user. |
| username | The username of the user. |
| The email of the user. | |
| default_language | The language code presenting the default language of the user. |
| reg_date | Registration date of the user. |
| first_login | Date of the first login. |
| last_login | Date of the last login. |
| security_level | This level determines which groups the user belongs to: Normal user: >0 Management: > 100 Admin: > 1000 root>100000 |
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
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
| status | A 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
| status | Containing 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
The following arguments have to be encoded as a json-array which is then sent in the argument named args:
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
| status | Containing the status - message of the operation. |
|---|---|
| id_user | The id of the user. |
| session_id | The session_id of the user. |
| username | The username of the user. |
| The email of the user. | |
| default_language | A 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
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
| status | Containing the status - message of the operation. |
|---|---|
| id_user | The id of the user. |
| session_id | The session_id of the user. |
| username | The username of the user. |
| The email of the user. | |
| default_language | A 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
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,
"element_number":"123",
"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>
<element_number>123</element_number>
<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 data | Section containing all order specific data like delivery-data and invoice-data. |
|---|---|
| cart | Containing all purchased products of the order. |
| parcels | An array containing all parcel - informations of the order. |
get_user_data
Delivers all user data of the logged - in user.
Arguments
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 data | Section containing the main data of the user like email and username. |
|---|---|
| attributes | Section containing all main attributes which belong to all users like firstname, lastname and street. |
| additional_attributes | Section containing all additional - attributes of the user. |
| addresses | Additional user addresses. |
get_user_by_id
Delivers the user_data of the user determined by id.
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='get_user_by_id' \
-d id_user=1
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 data | Section containing the main data of the user like email and username. |
|---|---|
| attributes | Section containing all main attributes which belong to all users like firstname, lastname and street. |
| additional_attributes | Section containing all additional - attributes of the user. |
| addresses | Additional 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
| status | A status message which determines wether the request was successful or not. |
|---|
update_user_data
This request can be used to update an existing user. You have to provide the corresponding id_user.
Arguments
attributes (json-array):
The array is an associative array which has the attribute - name as key and the value as the attributes value. As an example, if you want to set the attribute named attr1 with the value myvalue you would provide the following array:
{"attr1":"myvalue"}
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_user_data' \
-d id_user=1 \
-d attributes='{"name":"Test"}'
Response
{
"object":"update_user_data",
"status":"success"
}
<update_user_data>
<status>success</status>
</update_user_data>
Explanation
| status | The status of the operation. |
|---|
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
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
| status | A status determining wether the action was successful or not. |
|---|---|
| id_user | The id of the user. |
| session_id | The session_id of the user. |
| remote_session | A valid session with the user logged - in which can be used for further api-requests. |
| username | The username of the user. |
| The email of the user. | |
| default_language | The language code presenting the default language of the user. |
| reg_date | Registration date of the user. |
| first_login | Date of the first login. |
| last_login | Date 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-section | Infos about the user belonging to this order. If a user is logged in this section will contain the user after checkout. |
|---|---|
| order_payment_method-section | Section containing informations about the payment-method you set. |
| order_delivery_method-section | Section containing informations about the delivery-method you set. |
| order_payment_state-section | Section containing informations about the payment-state of the order. |
| order_delivery_state-section | Section containing informations about the delivery-state of the order. |
| order_state-section | Section containing informations about the order-state. |
| order_type-section | Section containing informations about the order-type. |
| main order data fields | Here you get the whole order-detail - fields. |
| attributes-section | The additional attributes you set. |
get_delivery_countries
Getting all activated delivery countries
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='get_delivery_countries' \
Response
{
"object": "get_delivery_countries",
"countries":[
{
"id":1,
"name":"AFGHANISTAN",
"iso":"AF",
"printable_name":"Afghanistan"
}
,
{
"id":2,
"name":"ALBANIA",
"iso":"AL",
"printable_name":"Albania"
}
,
{
"id":3,
"name":"ALGERIA",
"iso":"DZ",
"printable_name":"Algeria"
}
,
{
"id":4,
"name":"AMERICAN SAMOA",
"iso":"AS",
"printable_name":"American Samoa"
}
,
{
"id":5,
"name":"ANDORRA",
"iso":"AD",
"printable_name":"Andorra"
}
,
{
"id":6,
"name":"ANGOLA",
"iso":"AO",
"printable_name":"Angola"
}
,
{
"id":7,
"name":"ANGUILLA",
"iso":"AI",
"printable_name":"Anguilla"
}
,
{
"id":8,
"name":"ANTARCTICA",
"iso":"AQ",
"printable_name":"Antarctica"
}
,
{
"id":9,
"name":"ANTIGUA AND BARBUDA",
"iso":"AG",
"printable_name":"Antigua and Barbuda"
}
,
{
"id":10,
"name":"ARGENTINA",
"iso":"AR",
"printable_name":"Argentina"
}
,
{
"id":11,
"name":"ARMENIA",
"iso":"AM",
"printable_name":"Armenia"
}
,
{
"id":12,
"name":"ARUBA",
"iso":"AW",
"printable_name":"Aruba"
}
,
{
"id":13,
"name":"AUSTRALIA",
"iso":"AU",
"printable_name":"Australia"
}
,
{
"id":14,
"name":"AUSTRIA",
"iso":"AT",
"printable_name":"Austria"
}
,
{
"id":15,
"name":"AZERBAIJAN",
"iso":"AZ",
"printable_name":"Azerbaijan"
}
,
{
"id":16,
"name":"BAHAMAS",
"iso":"BS",
"printable_name":"Bahamas"
}
,
{
"id":17,
"name":"BAHRAIN",
"iso":"BH",
"printable_name":"Bahrain"
}
,
{
"id":18,
"name":"BANGLADESH",
"iso":"BD",
"printable_name":"Bangladesh"
}
,
{
"id":19,
"name":"BARBADOS",
"iso":"BB",
"printable_name":"Barbados"
}
,
{
"id":20,
"name":"BELARUS",
"iso":"BY",
"printable_name":"Belarus"
}
,
{
"id":21,
"name":"BELGIUM",
"iso":"BE",
"printable_name":"Belgium"
}
,
{
"id":22,
"name":"BELIZE",
"iso":"BZ",
"printable_name":"Belize"
}
,
{
"id":23,
"name":"BENIN",
"iso":"BJ",
"printable_name":"Benin"
}
,
{
"id":24,
"name":"BERMUDA",
"iso":"BM",
"printable_name":"Bermuda"
}
,
{
"id":25,
"name":"BHUTAN",
"iso":"BT",
"printable_name":"Bhutan"
}
,
{
"id":26,
"name":"BOLIVIA",
"iso":"BO",
"printable_name":"Bolivia"
}
,
{
"id":27,
"name":"BOSNIA AND HERZEGOVINA",
"iso":"BA",
"printable_name":"Bosnia and Herzegovina"
}
,
{
"id":28,
"name":"BOTSWANA",
"iso":"BW",
"printable_name":"Botswana"
}
,
{
"id":29,
"name":"BOUVET ISLAND",
"iso":"BV",
"printable_name":"Bouvet Island"
}
,
{
"id":30,
"name":"BRAZIL",
"iso":"BR",
"printable_name":"Brazil"
}
,
{
"id":31,
"name":"BRITISH INDIAN OCEAN TERRITORY",
"iso":"IO",
"printable_name":"British Indian Ocean Territory"
}
,
{
"id":32,
"name":"BRUNEI DARUSSALAM",
"iso":"BN",
"printable_name":"Brunei Darussalam"
}
,
{
"id":33,
"name":"BULGARIA",
"iso":"BG",
"printable_name":"Bulgaria"
}
,
{
"id":34,
"name":"BURKINA FASO",
"iso":"BF",
"printable_name":"Burkina Faso"
}
,
{
"id":35,
"name":"BURUNDI",
"iso":"BI",
"printable_name":"Burundi"
}
,
{
"id":36,
"name":"CAMBODIA",
"iso":"KH",
"printable_name":"Cambodia"
}
,
{
"id":37,
"name":"CAMEROON",
"iso":"CM",
"printable_name":"Cameroon"
}
,
{
"id":38,
"name":"CANADA",
"iso":"CA",
"printable_name":"Canada"
}
,
{
"id":39,
"name":"CAPE VERDE",
"iso":"CV",
"printable_name":"Cape Verde"
}
,
{
"id":40,
"name":"CAYMAN ISLANDS",
"iso":"KY",
"printable_name":"Cayman Islands"
}
,
{
"id":41,
"name":"CENTRAL AFRICAN REPUBLIC",
"iso":"CF",
"printable_name":"Central African Republic"
}
,
{
"id":42,
"name":"CHAD",
"iso":"TD",
"printable_name":"Chad"
}
,
{
"id":43,
"name":"CHILE",
"iso":"CL",
"printable_name":"Chile"
}
,
{
"id":44,
"name":"CHINA",
"iso":"CN",
"printable_name":"China"
}
,
{
"id":45,
"name":"CHRISTMAS ISLAND",
"iso":"CX",
"printable_name":"Christmas Island"
}
,
{
"id":46,
"name":"COCOS (KEELING) ISLANDS",
"iso":"CC",
"printable_name":"Cocos (Keeling) Islands"
}
,
{
"id":47,
"name":"COLOMBIA",
"iso":"CO",
"printable_name":"Colombia"
}
,
{
"id":48,
"name":"COMOROS",
"iso":"KM",
"printable_name":"Comoros"
}
,
{
"id":49,
"name":"CONGO",
"iso":"CG",
"printable_name":"Congo"
}
,
{
"id":50,
"name":"CONGO, THE DEMOCRATIC REPUBLIC OF THE",
"iso":"CD",
"printable_name":"Congo, the Democratic Republic of the"
}
,
{
"id":51,
"name":"COOK ISLANDS",
"iso":"CK",
"printable_name":"Cook Islands"
}
,
{
"id":52,
"name":"COSTA RICA",
"iso":"CR",
"printable_name":"Costa Rica"
}
,
{
"id":53,
"name":"COTE D'IVOIRE",
"iso":"CI",
"printable_name":"Cote D'Ivoire"
}
,
{
"id":54,
"name":"CROATIA",
"iso":"HR",
"printable_name":"Croatia"
}
,
{
"id":55,
"name":"CUBA",
"iso":"CU",
"printable_name":"Cuba"
}
,
{
"id":56,
"name":"CYPRUS",
"iso":"CY",
"printable_name":"Cyprus"
}
,
{
"id":57,
"name":"CZECH REPUBLIC",
"iso":"CZ",
"printable_name":"Czech Republic"
}
,
{
"id":58,
"name":"DENMARK",
"iso":"DK",
"printable_name":"Denmark"
}
,
{
"id":59,
"name":"DJIBOUTI",
"iso":"DJ",
"printable_name":"Djibouti"
}
,
{
"id":60,
"name":"DOMINICA",
"iso":"DM",
"printable_name":"Dominica"
}
,
{
"id":61,
"name":"DOMINICAN REPUBLIC",
"iso":"DO",
"printable_name":"Dominican Republic"
}
,
{
"id":62,
"name":"ECUADOR",
"iso":"EC",
"printable_name":"Ecuador"
}
,
{
"id":63,
"name":"EGYPT",
"iso":"EG",
"printable_name":"Egypt"
}
,
{
"id":64,
"name":"EL SALVADOR",
"iso":"SV",
"printable_name":"El Salvador"
}
,
{
"id":65,
"name":"EQUATORIAL GUINEA",
"iso":"GQ",
"printable_name":"Equatorial Guinea"
}
,
{
"id":66,
"name":"ERITREA",
"iso":"ER",
"printable_name":"Eritrea"
}
,
{
"id":67,
"name":"ESTONIA",
"iso":"EE",
"printable_name":"Estonia"
}
,
{
"id":68,
"name":"ETHIOPIA",
"iso":"ET",
"printable_name":"Ethiopia"
}
,
{
"id":69,
"name":"FALKLAND ISLANDS (MALVINAS)",
"iso":"FK",
"printable_name":"Falkland Islands (Malvinas)"
}
,
{
"id":70,
"name":"FAROE ISLANDS",
"iso":"FO",
"printable_name":"Faroe Islands"
}
,
{
"id":71,
"name":"FIJI",
"iso":"FJ",
"printable_name":"Fiji"
}
,
{
"id":72,
"name":"FINLAND",
"iso":"FI",
"printable_name":"Finland"
}
,
{
"id":73,
"name":"FRANCE",
"iso":"FR",
"printable_name":"France"
}
,
{
"id":74,
"name":"FRENCH GUIANA",
"iso":"GF",
"printable_name":"French Guiana"
}
,
{
"id":75,
"name":"FRENCH POLYNESIA",
"iso":"PF",
"printable_name":"French Polynesia"
}
,
{
"id":76,
"name":"FRENCH SOUTHERN TERRITORIES",
"iso":"TF",
"printable_name":"French Southern Territories"
}
,
{
"id":77,
"name":"GABON",
"iso":"GA",
"printable_name":"Gabon"
}
,
{
"id":78,
"name":"GAMBIA",
"iso":"GM",
"printable_name":"Gambia"
}
,
{
"id":79,
"name":"GEORGIA",
"iso":"GE",
"printable_name":"Georgia"
}
,
{
"id":80,
"name":"GERMANY",
"iso":"DE",
"printable_name":"Germany"
}
,
{
"id":81,
"name":"GHANA",
"iso":"GH",
"printable_name":"Ghana"
}
,
{
"id":82,
"name":"GIBRALTAR",
"iso":"GI",
"printable_name":"Gibraltar"
}
,
{
"id":83,
"name":"GREECE",
"iso":"GR",
"printable_name":"Greece"
}
,
{
"id":84,
"name":"GREENLAND",
"iso":"GL",
"printable_name":"Greenland"
}
,
{
"id":85,
"name":"GRENADA",
"iso":"GD",
"printable_name":"Grenada"
}
,
{
"id":86,
"name":"GUADELOUPE",
"iso":"GP",
"printable_name":"Guadeloupe"
}
,
{
"id":87,
"name":"GUAM",
"iso":"GU",
"printable_name":"Guam"
}
,
{
"id":88,
"name":"GUATEMALA",
"iso":"GT",
"printable_name":"Guatemala"
}
,
{
"id":89,
"name":"GUINEA",
"iso":"GN",
"printable_name":"Guinea"
}
,
{
"id":90,
"name":"GUINEA-BISSAU",
"iso":"GW",
"printable_name":"Guinea-Bissau"
}
,
{
"id":91,
"name":"GUYANA",
"iso":"GY",
"printable_name":"Guyana"
}
,
{
"id":92,
"name":"HAITI",
"iso":"HT",
"printable_name":"Haiti"
}
,
{
"id":93,
"name":"HEARD ISLAND AND MCDONALD ISLANDS",
"iso":"HM",
"printable_name":"Heard Island and Mcdonald Islands"
}
,
{
"id":94,
"name":"HOLY SEE (VATICAN CITY STATE)",
"iso":"VA",
"printable_name":"Holy See (Vatican City State)"
}
,
{
"id":95,
"name":"HONDURAS",
"iso":"HN",
"printable_name":"Honduras"
}
,
{
"id":96,
"name":"HONG KONG",
"iso":"HK",
"printable_name":"Hong Kong"
}
,
{
"id":97,
"name":"HUNGARY",
"iso":"HU",
"printable_name":"Hungary"
}
,
{
"id":98,
"name":"ICELAND",
"iso":"IS",
"printable_name":"Iceland"
}
,
{
"id":99,
"name":"INDIA",
"iso":"IN",
"printable_name":"India"
}
,
{
"id":100,
"name":"INDONESIA",
"iso":"ID",
"printable_name":"Indonesia"
}
,
{
"id":101,
"name":"IRAN, ISLAMIC REPUBLIC OF",
"iso":"IR",
"printable_name":"Iran, Islamic Republic of"
}
,
{
"id":102,
"name":"IRAQ",
"iso":"IQ",
"printable_name":"Iraq"
}
,
{
"id":103,
"name":"IRELAND",
"iso":"IE",
"printable_name":"Ireland"
}
,
{
"id":104,
"name":"ISRAEL",
"iso":"IL",
"printable_name":"Israel"
}
,
{
"id":105,
"name":"ITALY",
"iso":"IT",
"printable_name":"Italy"
}
,
{
"id":106,
"name":"JAMAICA",
"iso":"JM",
"printable_name":"Jamaica"
}
,
{
"id":107,
"name":"JAPAN",
"iso":"JP",
"printable_name":"Japan"
}
,
{
"id":108,
"name":"JORDAN",
"iso":"JO",
"printable_name":"Jordan"
}
,
{
"id":109,
"name":"KAZAKHSTAN",
"iso":"KZ",
"printable_name":"Kazakhstan"
}
,
{
"id":110,
"name":"KENYA",
"iso":"KE",
"printable_name":"Kenya"
}
,
{
"id":111,
"name":"KIRIBATI",
"iso":"KI",
"printable_name":"Kiribati"
}
,
{
"id":112,
"name":"KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF",
"iso":"KP",
"printable_name":"Korea, Democratic People's Republic of"
}
,
{
"id":113,
"name":"KOREA, REPUBLIC OF",
"iso":"KR",
"printable_name":"Korea, Republic of"
}
,
{
"id":114,
"name":"KUWAIT",
"iso":"KW",
"printable_name":"Kuwait"
}
,
{
"id":115,
"name":"KYRGYZSTAN",
"iso":"KG",
"printable_name":"Kyrgyzstan"
}
,
{
"id":116,
"name":"LAO PEOPLE'S DEMOCRATIC REPUBLIC",
"iso":"LA",
"printable_name":"Lao People's Democratic Republic"
}
,
{
"id":117,
"name":"LATVIA",
"iso":"LV",
"printable_name":"Latvia"
}
,
{
"id":118,
"name":"LEBANON",
"iso":"LB",
"printable_name":"Lebanon"
}
,
{
"id":119,
"name":"LESOTHO",
"iso":"LS",
"printable_name":"Lesotho"
}
,
{
"id":120,
"name":"LIBERIA",
"iso":"LR",
"printable_name":"Liberia"
}
,
{
"id":121,
"name":"LIBYAN ARAB JAMAHIRIYA",
"iso":"LY",
"printable_name":"Libyan Arab Jamahiriya"
}
,
{
"id":122,
"name":"LIECHTENSTEIN",
"iso":"LI",
"printable_name":"Liechtenstein"
}
,
{
"id":123,
"name":"LITHUANIA",
"iso":"LT",
"printable_name":"Lithuania"
}
,
{
"id":124,
"name":"LUXEMBOURG",
"iso":"LU",
"printable_name":"Luxembourg"
}
,
{
"id":125,
"name":"MACAO",
"iso":"MO",
"printable_name":"Macao"
}
,
{
"id":126,
"name":"MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF",
"iso":"MK",
"printable_name":"Macedonia, the Former Yugoslav Republic of"
}
,
{
"id":127,
"name":"MADAGASCAR",
"iso":"MG",
"printable_name":"Madagascar"
}
,
{
"id":128,
"name":"MALAWI",
"iso":"MW",
"printable_name":"Malawi"
}
,
{
"id":129,
"name":"MALAYSIA",
"iso":"MY",
"printable_name":"Malaysia"
}
,
{
"id":130,
"name":"MALDIVES",
"iso":"MV",
"printable_name":"Maldives"
}
,
{
"id":131,
"name":"MALI",
"iso":"ML",
"printable_name":"Mali"
}
,
{
"id":132,
"name":"MALTA",
"iso":"MT",
"printable_name":"Malta"
}
,
{
"id":133,
"name":"MARSHALL ISLANDS",
"iso":"MH",
"printable_name":"Marshall Islands"
}
,
{
"id":134,
"name":"MARTINIQUE",
"iso":"MQ",
"printable_name":"Martinique"
}
,
{
"id":135,
"name":"MAURITANIA",
"iso":"MR",
"printable_name":"Mauritania"
}
,
{
"id":136,
"name":"MAURITIUS",
"iso":"MU",
"printable_name":"Mauritius"
}
,
{
"id":137,
"name":"MAYOTTE",
"iso":"YT",
"printable_name":"Mayotte"
}
,
{
"id":138,
"name":"MEXICO",
"iso":"MX",
"printable_name":"Mexico"
}
,
{
"id":139,
"name":"MICRONESIA, FEDERATED STATES OF",
"iso":"FM",
"printable_name":"Micronesia, Federated States of"
}
,
{
"id":140,
"name":"MOLDOVA, REPUBLIC OF",
"iso":"MD",
"printable_name":"Moldova, Republic of"
}
,
{
"id":141,
"name":"MONACO",
"iso":"MC",
"printable_name":"Monaco"
}
,
{
"id":142,
"name":"MONGOLIA",
"iso":"MN",
"printable_name":"Mongolia"
}
,
{
"id":143,
"name":"MONTSERRAT",
"iso":"MS",
"printable_name":"Montserrat"
}
,
{
"id":144,
"name":"MOROCCO",
"iso":"MA",
"printable_name":"Morocco"
}
,
{
"id":145,
"name":"MOZAMBIQUE",
"iso":"MZ",
"printable_name":"Mozambique"
}
,
{
"id":146,
"name":"MYANMAR",
"iso":"MM",
"printable_name":"Myanmar"
}
,
{
"id":147,
"name":"NAMIBIA",
"iso":"NA",
"printable_name":"Namibia"
}
,
{
"id":148,
"name":"NAURU",
"iso":"NR",
"printable_name":"Nauru"
}
,
{
"id":149,
"name":"NEPAL",
"iso":"NP",
"printable_name":"Nepal"
}
,
{
"id":150,
"name":"NETHERLANDS",
"iso":"NL",
"printable_name":"Netherlands"
}
,
{
"id":151,
"name":"NETHERLANDS ANTILLES",
"iso":"AN",
"printable_name":"Netherlands Antilles"
}
,
{
"id":152,
"name":"NEW CALEDONIA",
"iso":"NC",
"printable_name":"New Caledonia"
}
,
{
"id":153,
"name":"NEW ZEALAND",
"iso":"NZ",
"printable_name":"New Zealand"
}
,
{
"id":154,
"name":"NICARAGUA",
"iso":"NI",
"printable_name":"Nicaragua"
}
,
{
"id":155,
"name":"NIGER",
"iso":"NE",
"printable_name":"Niger"
}
,
{
"id":156,
"name":"NIGERIA",
"iso":"NG",
"printable_name":"Nigeria"
}
,
{
"id":157,
"name":"NIUE",
"iso":"NU",
"printable_name":"Niue"
}
,
{
"id":158,
"name":"NORFOLK ISLAND",
"iso":"NF",
"printable_name":"Norfolk Island"
}
,
{
"id":159,
"name":"NORTHERN MARIANA ISLANDS",
"iso":"MP",
"printable_name":"Northern Mariana Islands"
}
,
{
"id":160,
"name":"NORWAY",
"iso":"NO",
"printable_name":"Norway"
}
,
{
"id":161,
"name":"OMAN",
"iso":"OM",
"printable_name":"Oman"
}
,
{
"id":162,
"name":"PAKISTAN",
"iso":"PK",
"printable_name":"Pakistan"
}
,
{
"id":163,
"name":"PALAU",
"iso":"PW",
"printable_name":"Palau"
}
,
{
"id":164,
"name":"PALESTINIAN TERRITORY, OCCUPIED",
"iso":"PS",
"printable_name":"Palestinian Territory, Occupied"
}
,
{
"id":165,
"name":"PANAMA",
"iso":"PA",
"printable_name":"Panama"
}
,
{
"id":166,
"name":"PAPUA NEW GUINEA",
"iso":"PG",
"printable_name":"Papua New Guinea"
}
,
{
"id":167,
"name":"PARAGUAY",
"iso":"PY",
"printable_name":"Paraguay"
}
,
{
"id":168,
"name":"PERU",
"iso":"PE",
"printable_name":"Peru"
}
,
{
"id":169,
"name":"PHILIPPINES",
"iso":"PH",
"printable_name":"Philippines"
}
,
{
"id":170,
"name":"PITCAIRN",
"iso":"PN",
"printable_name":"Pitcairn"
}
,
{
"id":171,
"name":"POLAND",
"iso":"PL",
"printable_name":"Poland"
}
,
{
"id":172,
"name":"PORTUGAL",
"iso":"PT",
"printable_name":"Portugal"
}
,
{
"id":173,
"name":"PUERTO RICO",
"iso":"PR",
"printable_name":"Puerto Rico"
}
,
{
"id":174,
"name":"QATAR",
"iso":"QA",
"printable_name":"Qatar"
}
,
{
"id":175,
"name":"REUNION",
"iso":"RE",
"printable_name":"Reunion"
}
,
{
"id":176,
"name":"ROMANIA",
"iso":"RO",
"printable_name":"Romania"
}
,
{
"id":177,
"name":"RUSSIAN FEDERATION",
"iso":"RU",
"printable_name":"Russian Federation"
}
,
{
"id":178,
"name":"RWANDA",
"iso":"RW",
"printable_name":"Rwanda"
}
,
{
"id":179,
"name":"SAINT HELENA",
"iso":"SH",
"printable_name":"Saint Helena"
}
,
{
"id":180,
"name":"SAINT KITTS AND NEVIS",
"iso":"KN",
"printable_name":"Saint Kitts and Nevis"
}
,
{
"id":181,
"name":"SAINT LUCIA",
"iso":"LC",
"printable_name":"Saint Lucia"
}
,
{
"id":182,
"name":"SAINT PIERRE AND MIQUELON",
"iso":"PM",
"printable_name":"Saint Pierre and Miquelon"
}
,
{
"id":183,
"name":"SAINT VINCENT AND THE GRENADINES",
"iso":"VC",
"printable_name":"Saint Vincent and the Grenadines"
}
,
{
"id":184,
"name":"SAMOA",
"iso":"WS",
"printable_name":"Samoa"
}
,
{
"id":185,
"name":"SAN MARINO",
"iso":"SM",
"printable_name":"San Marino"
}
,
{
"id":186,
"name":"SAO TOME AND PRINCIPE",
"iso":"ST",
"printable_name":"Sao Tome and Principe"
}
,
{
"id":187,
"name":"SAUDI ARABIA",
"iso":"SA",
"printable_name":"Saudi Arabia"
}
,
{
"id":188,
"name":"SENEGAL",
"iso":"SN",
"printable_name":"Senegal"
}
,
{
"id":189,
"name":"SERBIA AND MONTENEGRO",
"iso":"CS",
"printable_name":"Serbia and Montenegro"
}
,
{
"id":190,
"name":"SEYCHELLES",
"iso":"SC",
"printable_name":"Seychelles"
}
,
{
"id":191,
"name":"SIERRA LEONE",
"iso":"SL",
"printable_name":"Sierra Leone"
}
,
{
"id":192,
"name":"SINGAPORE",
"iso":"SG",
"printable_name":"Singapore"
}
,
{
"id":193,
"name":"SLOVAKIA",
"iso":"SK",
"printable_name":"Slovakia"
}
,
{
"id":194,
"name":"SLOVENIA",
"iso":"SI",
"printable_name":"Slovenia"
}
,
{
"id":195,
"name":"SOLOMON ISLANDS",
"iso":"SB",
"printable_name":"Solomon Islands"
}
,
{
"id":196,
"name":"SOMALIA",
"iso":"SO",
"printable_name":"Somalia"
}
,
{
"id":197,
"name":"SOUTH AFRICA",
"iso":"ZA",
"printable_name":"South Africa"
}
,
{
"id":198,
"name":"SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS",
"iso":"GS",
"printable_name":"South Georgia and the South Sandwich Islands"
}
,
{
"id":199,
"name":"SPAIN",
"iso":"ES",
"printable_name":"Spain"
}
,
{
"id":200,
"name":"SRI LANKA",
"iso":"LK",
"printable_name":"Sri Lanka"
}
,
{
"id":201,
"name":"SUDAN",
"iso":"SD",
"printable_name":"Sudan"
}
,
{
"id":202,
"name":"SURINAME",
"iso":"SR",
"printable_name":"Suriname"
}
,
{
"id":203,
"name":"SVALBARD AND JAN MAYEN",
"iso":"SJ",
"printable_name":"Svalbard and Jan Mayen"
}
,
{
"id":204,
"name":"SWAZILAND",
"iso":"SZ",
"printable_name":"Swaziland"
}
,
{
"id":205,
"name":"SWEDEN",
"iso":"SE",
"printable_name":"Sweden"
}
,
{
"id":206,
"name":"SWITZERLAND",
"iso":"CH",
"printable_name":"Switzerland"
}
,
{
"id":207,
"name":"SYRIAN ARAB REPUBLIC",
"iso":"SY",
"printable_name":"Syrian Arab Republic"
}
,
{
"id":208,
"name":"TAIWAN, PROVINCE OF CHINA",
"iso":"TW",
"printable_name":"Taiwan, Province of China"
}
,
{
"id":209,
"name":"TAJIKISTAN",
"iso":"TJ",
"printable_name":"Tajikistan"
}
,
{
"id":210,
"name":"TANZANIA, UNITED REPUBLIC OF",
"iso":"TZ",
"printable_name":"Tanzania, United Republic of"
}
,
{
"id":211,
"name":"THAILAND",
"iso":"TH",
"printable_name":"Thailand"
}
,
{
"id":212,
"name":"TIMOR-LESTE",
"iso":"TL",
"printable_name":"Timor-Leste"
}
,
{
"id":213,
"name":"TOGO",
"iso":"TG",
"printable_name":"Togo"
}
,
{
"id":214,
"name":"TOKELAU",
"iso":"TK",
"printable_name":"Tokelau"
}
,
{
"id":215,
"name":"TONGA",
"iso":"TO",
"printable_name":"Tonga"
}
,
{
"id":216,
"name":"TRINIDAD AND TOBAGO",
"iso":"TT",
"printable_name":"Trinidad and Tobago"
}
,
{
"id":217,
"name":"TUNISIA",
"iso":"TN",
"printable_name":"Tunisia"
}
,
{
"id":218,
"name":"TURKEY",
"iso":"TR",
"printable_name":"Turkey"
}
,
{
"id":219,
"name":"TURKMENISTAN",
"iso":"TM",
"printable_name":"Turkmenistan"
}
,
{
"id":220,
"name":"TURKS AND CAICOS ISLANDS",
"iso":"TC",
"printable_name":"Turks and Caicos Islands"
}
,
{
"id":221,
"name":"TUVALU",
"iso":"TV",
"printable_name":"Tuvalu"
}
,
{
"id":222,
"name":"UGANDA",
"iso":"UG",
"printable_name":"Uganda"
}
,
{
"id":223,
"name":"UKRAINE",
"iso":"UA",
"printable_name":"Ukraine"
}
,
{
"id":224,
"name":"UNITED ARAB EMIRATES",
"iso":"AE",
"printable_name":"United Arab Emirates"
}
,
{
"id":225,
"name":"UNITED KINGDOM",
"iso":"GB",
"printable_name":"United Kingdom"
}
,
{
"id":226,
"name":"UNITED STATES",
"iso":"US",
"printable_name":"United States"
}
,
{
"id":227,
"name":"UNITED STATES MINOR OUTLYING ISLANDS",
"iso":"UM",
"printable_name":"United States Minor Outlying Islands"
}
,
{
"id":228,
"name":"URUGUAY",
"iso":"UY",
"printable_name":"Uruguay"
}
,
{
"id":229,
"name":"UZBEKISTAN",
"iso":"UZ",
"printable_name":"Uzbekistan"
}
,
{
"id":230,
"name":"VANUATU",
"iso":"VU",
"printable_name":"Vanuatu"
}
,
{
"id":231,
"name":"VENEZUELA",
"iso":"VE",
"printable_name":"Venezuela"
}
,
{
"id":232,
"name":"VIET NAM",
"iso":"VN",
"printable_name":"Viet Nam"
}
,
{
"id":233,
"name":"VIRGIN ISLANDS, BRITISH",
"iso":"VG",
"printable_name":"Virgin Islands, British"
}
,
{
"id":234,
"name":"VIRGIN ISLANDS, U.S.",
"iso":"VI",
"printable_name":"Virgin Islands, U.s."
}
,
{
"id":235,
"name":"WALLIS AND FUTUNA",
"iso":"WF",
"printable_name":"Wallis and Futuna"
}
,
{
"id":236,
"name":"WESTERN SAHARA",
"iso":"EH",
"printable_name":"Western Sahara"
}
,
{
"id":237,
"name":"YEMEN",
"iso":"YE",
"printable_name":"Yemen"
}
,
{
"id":238,
"name":"ZAMBIA",
"iso":"ZM",
"printable_name":"Zambia"
}
,
{
"id":239,
"name":"ZIMBABWE",
"iso":"ZW",
"printable_name":"Zimbabwe"
}
]
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<get_delivery_countries>
<countries>
<country>
<id>1</id>
<name>AFGHANISTAN</name>
<iso>AF</iso>
<printable_name>Afghanistan</printable_name>
</country>
<country>
<id>2</id>
<name>ALBANIA</name>
<iso>AL</iso>
<printable_name>Albania</printable_name>
</country>
<country>
<id>3</id>
<name>ALGERIA</name>
<iso>DZ</iso>
<printable_name>Algeria</printable_name>
</country>
<country>
<id>4</id>
<name>AMERICAN SAMOA</name>
<iso>AS</iso>
<printable_name>American Samoa</printable_name>
</country>
<country>
<id>5</id>
<name>ANDORRA</name>
<iso>AD</iso>
<printable_name>Andorra</printable_name>
</country>
<country>
<id>6</id>
<name>ANGOLA</name>
<iso>AO</iso>
<printable_name>Angola</printable_name>
</country>
<country>
<id>7</id>
<name>ANGUILLA</name>
<iso>AI</iso>
<printable_name>Anguilla</printable_name>
</country>
<country>
<id>8</id>
<name>ANTARCTICA</name>
<iso>AQ</iso>
<printable_name>Antarctica</printable_name>
</country>
<country>
<id>9</id>
<name>ANTIGUA AND BARBUDA</name>
<iso>AG</iso>
<printable_name>Antigua and Barbuda</printable_name>
</country>
<country>
<id>10</id>
<name>ARGENTINA</name>
<iso>AR</iso>
<printable_name>Argentina</printable_name>
</country>
<country>
<id>11</id>
<name>ARMENIA</name>
<iso>AM</iso>
<printable_name>Armenia</printable_name>
</country>
<country>
<id>12</id>
<name>ARUBA</name>
<iso>AW</iso>
<printable_name>Aruba</printable_name>
</country>
<country>
<id>13</id>
<name>AUSTRALIA</name>
<iso>AU</iso>
<printable_name>Australia</printable_name>
</country>
<country>
<id>14</id>
<name>AUSTRIA</name>
<iso>AT</iso>
<printable_name>Austria</printable_name>
</country>
<country>
<id>15</id>
<name>AZERBAIJAN</name>
<iso>AZ</iso>
<printable_name>Azerbaijan</printable_name>
</country>
<country>
<id>16</id>
<name>BAHAMAS</name>
<iso>BS</iso>
<printable_name>Bahamas</printable_name>
</country>
<country>
<id>17</id>
<name>BAHRAIN</name>
<iso>BH</iso>
<printable_name>Bahrain</printable_name>
</country>
<country>
<id>18</id>
<name>BANGLADESH</name>
<iso>BD</iso>
<printable_name>Bangladesh</printable_name>
</country>
<country>
<id>19</id>
<name>BARBADOS</name>
<iso>BB</iso>
<printable_name>Barbados</printable_name>
</country>
<country>
<id>20</id>
<name>BELARUS</name>
<iso>BY</iso>
<printable_name>Belarus</printable_name>
</country>
<country>
<id>21</id>
<name>BELGIUM</name>
<iso>BE</iso>
<printable_name>Belgium</printable_name>
</country>
<country>
<id>22</id>
<name>BELIZE</name>
<iso>BZ</iso>
<printable_name>Belize</printable_name>
</country>
<country>
<id>23</id>
<name>BENIN</name>
<iso>BJ</iso>
<printable_name>Benin</printable_name>
</country>
<country>
<id>24</id>
<name>BERMUDA</name>
<iso>BM</iso>
<printable_name>Bermuda</printable_name>
</country>
<country>
<id>25</id>
<name>BHUTAN</name>
<iso>BT</iso>
<printable_name>Bhutan</printable_name>
</country>
<country>
<id>26</id>
<name>BOLIVIA</name>
<iso>BO</iso>
<printable_name>Bolivia</printable_name>
</country>
<country>
<id>27</id>
<name>BOSNIA AND HERZEGOVINA</name>
<iso>BA</iso>
<printable_name>Bosnia and Herzegovina</printable_name>
</country>
<country>
<id>28</id>
<name>BOTSWANA</name>
<iso>BW</iso>
<printable_name>Botswana</printable_name>
</country>
<country>
<id>29</id>
<name>BOUVET ISLAND</name>
<iso>BV</iso>
<printable_name>Bouvet Island</printable_name>
</country>
<country>
<id>30</id>
<name>BRAZIL</name>
<iso>BR</iso>
<printable_name>Brazil</printable_name>
</country>
<country>
<id>31</id>
<name>BRITISH INDIAN OCEAN TERRITORY</name>
<iso>IO</iso>
<printable_name>British Indian Ocean Territory</printable_name>
</country>
<country>
<id>32</id>
<name>BRUNEI DARUSSALAM</name>
<iso>BN</iso>
<printable_name>Brunei Darussalam</printable_name>
</country>
<country>
<id>33</id>
<name>BULGARIA</name>
<iso>BG</iso>
<printable_name>Bulgaria</printable_name>
</country>
<country>
<id>34</id>
<name>BURKINA FASO</name>
<iso>BF</iso>
<printable_name>Burkina Faso</printable_name>
</country>
<country>
<id>35</id>
<name>BURUNDI</name>
<iso>BI</iso>
<printable_name>Burundi</printable_name>
</country>
<country>
<id>36</id>
<name>CAMBODIA</name>
<iso>KH</iso>
<printable_name>Cambodia</printable_name>
</country>
<country>
<id>37</id>
<name>CAMEROON</name>
<iso>CM</iso>
<printable_name>Cameroon</printable_name>
</country>
<country>
<id>38</id>
<name>CANADA</name>
<iso>CA</iso>
<printable_name>Canada</printable_name>
</country>
<country>
<id>39</id>
<name>CAPE VERDE</name>
<iso>CV</iso>
<printable_name>Cape Verde</printable_name>
</country>
<country>
<id>40</id>
<name>CAYMAN ISLANDS</name>
<iso>KY</iso>
<printable_name>Cayman Islands</printable_name>
</country>
<country>
<id>41</id>
<name>CENTRAL AFRICAN REPUBLIC</name>
<iso>CF</iso>
<printable_name>Central African Republic</printable_name>
</country>
<country>
<id>42</id>
<name>CHAD</name>
<iso>TD</iso>
<printable_name>Chad</printable_name>
</country>
<country>
<id>43</id>
<name>CHILE</name>
<iso>CL</iso>
<printable_name>Chile</printable_name>
</country>
<country>
<id>44</id>
<name>CHINA</name>
<iso>CN</iso>
<printable_name>China</printable_name>
</country>
<country>
<id>45</id>
<name>CHRISTMAS ISLAND</name>
<iso>CX</iso>
<printable_name>Christmas Island</printable_name>
</country>
<country>
<id>46</id>
<name>COCOS (KEELING) ISLANDS</name>
<iso>CC</iso>
<printable_name>Cocos (Keeling) Islands</printable_name>
</country>
<country>
<id>47</id>
<name>COLOMBIA</name>
<iso>CO</iso>
<printable_name>Colombia</printable_name>
</country>
<country>
<id>48</id>
<name>COMOROS</name>
<iso>KM</iso>
<printable_name>Comoros</printable_name>
</country>
<country>
<id>49</id>
<name>CONGO</name>
<iso>CG</iso>
<printable_name>Congo</printable_name>
</country>
<country>
<id>50</id>
<name>CONGO, THE DEMOCRATIC REPUBLIC OF THE</name>
<iso>CD</iso>
<printable_name>Congo, the Democratic Republic of the</printable_name>
</country>
<country>
<id>51</id>
<name>COOK ISLANDS</name>
<iso>CK</iso>
<printable_name>Cook Islands</printable_name>
</country>
<country>
<id>52</id>
<name>COSTA RICA</name>
<iso>CR</iso>
<printable_name>Costa Rica</printable_name>
</country>
<country>
<id>53</id>
<name>COTE D'IVOIRE</name>
<iso>CI</iso>
<printable_name>Cote D'Ivoire</printable_name>
</country>
<country>
<id>54</id>
<name>CROATIA</name>
<iso>HR</iso>
<printable_name>Croatia</printable_name>
</country>
<country>
<id>55</id>
<name>CUBA</name>
<iso>CU</iso>
<printable_name>Cuba</printable_name>
</country>
<country>
<id>56</id>
<name>CYPRUS</name>
<iso>CY</iso>
<printable_name>Cyprus</printable_name>
</country>
<country>
<id>57</id>
<name>CZECH REPUBLIC</name>
<iso>CZ</iso>
<printable_name>Czech Republic</printable_name>
</country>
<country>
<id>58</id>
<name>DENMARK</name>
<iso>DK</iso>
<printable_name>Denmark</printable_name>
</country>
<country>
<id>59</id>
<name>DJIBOUTI</name>
<iso>DJ</iso>
<printable_name>Djibouti</printable_name>
</country>
<country>
<id>60</id>
<name>DOMINICA</name>
<iso>DM</iso>
<printable_name>Dominica</printable_name>
</country>
<country>
<id>61</id>
<name>DOMINICAN REPUBLIC</name>
<iso>DO</iso>
<printable_name>Dominican Republic</printable_name>
</country>
<country>
<id>62</id>
<name>ECUADOR</name>
<iso>EC</iso>
<printable_name>Ecuador</printable_name>
</country>
<country>
<id>63</id>
<name>EGYPT</name>
<iso>EG</iso>
<printable_name>Egypt</printable_name>
</country>
<country>
<id>64</id>
<name>EL SALVADOR</name>
<iso>SV</iso>
<printable_name>El Salvador</printable_name>
</country>
<country>
<id>65</id>
<name>EQUATORIAL GUINEA</name>
<iso>GQ</iso>
<printable_name>Equatorial Guinea</printable_name>
</country>
<country>
<id>66</id>
<name>ERITREA</name>
<iso>ER</iso>
<printable_name>Eritrea</printable_name>
</country>
<country>
<id>67</id>
<name>ESTONIA</name>
<iso>EE</iso>
<printable_name>Estonia</printable_name>
</country>
<country>
<id>68</id>
<name>ETHIOPIA</name>
<iso>ET</iso>
<printable_name>Ethiopia</printable_name>
</country>
<country>
<id>69</id>
<name>FALKLAND ISLANDS (MALVINAS)</name>
<iso>FK</iso>
<printable_name>Falkland Islands (Malvinas)</printable_name>
</country>
<country>
<id>70</id>
<name>FAROE ISLANDS</name>
<iso>FO</iso>
<printable_name>Faroe Islands</printable_name>
</country>
<country>
<id>71</id>
<name>FIJI</name>
<iso>FJ</iso>
<printable_name>Fiji</printable_name>
</country>
<country>
<id>72</id>
<name>FINLAND</name>
<iso>FI</iso>
<printable_name>Finland</printable_name>
</country>
<country>
<id>73</id>
<name>FRANCE</name>
<iso>FR</iso>
<printable_name>France</printable_name>
</country>
<country>
<id>74</id>
<name>FRENCH GUIANA</name>
<iso>GF</iso>
<printable_name>French Guiana</printable_name>
</country>
<country>
<id>75</id>
<name>FRENCH POLYNESIA</name>
<iso>PF</iso>
<printable_name>French Polynesia</printable_name>
</country>
<country>
<id>76</id>
<name>FRENCH SOUTHERN TERRITORIES</name>
<iso>TF</iso>
<printable_name>French Southern Territories</printable_name>
</country>
<country>
<id>77</id>
<name>GABON</name>
<iso>GA</iso>
<printable_name>Gabon</printable_name>
</country>
<country>
<id>78</id>
<name>GAMBIA</name>
<iso>GM</iso>
<printable_name>Gambia</printable_name>
</country>
<country>
<id>79</id>
<name>GEORGIA</name>
<iso>GE</iso>
<printable_name>Georgia</printable_name>
</country>
<country>
<id>80</id>
<name>GERMANY</name>
<iso>DE</iso>
<printable_name>Germany</printable_name>
</country>
<country>
<id>81</id>
<name>GHANA</name>
<iso>GH</iso>
<printable_name>Ghana</printable_name>
</country>
<country>
<id>82</id>
<name>GIBRALTAR</name>
<iso>GI</iso>
<printable_name>Gibraltar</printable_name>
</country>
<country>
<id>83</id>
<name>GREECE</name>
<iso>GR</iso>
<printable_name>Greece</printable_name>
</country>
<country>
<id>84</id>
<name>GREENLAND</name>
<iso>GL</iso>
<printable_name>Greenland</printable_name>
</country>
<country>
<id>85</id>
<name>GRENADA</name>
<iso>GD</iso>
<printable_name>Grenada</printable_name>
</country>
<country>
<id>86</id>
<name>GUADELOUPE</name>
<iso>GP</iso>
<printable_name>Guadeloupe</printable_name>
</country>
<country>
<id>87</id>
<name>GUAM</name>
<iso>GU</iso>
<printable_name>Guam</printable_name>
</country>
<country>
<id>88</id>
<name>GUATEMALA</name>
<iso>GT</iso>
<printable_name>Guatemala</printable_name>
</country>
<country>
<id>89</id>
<name>GUINEA</name>
<iso>GN</iso>
<printable_name>Guinea</printable_name>
</country>
<country>
<id>90</id>
<name>GUINEA-BISSAU</name>
<iso>GW</iso>
<printable_name>Guinea-Bissau</printable_name>
</country>
<country>
<id>91</id>
<name>GUYANA</name>
<iso>GY</iso>
<printable_name>Guyana</printable_name>
</country>
<country>
<id>92</id>
<name>HAITI</name>
<iso>HT</iso>
<printable_name>Haiti</printable_name>
</country>
<country>
<id>93</id>
<name>HEARD ISLAND AND MCDONALD ISLANDS</name>
<iso>HM</iso>
<printable_name>Heard Island and Mcdonald Islands</printable_name>
</country>
<country>
<id>94</id>
<name>HOLY SEE (VATICAN CITY STATE)</name>
<iso>VA</iso>
<printable_name>Holy See (Vatican City State)</printable_name>
</country>
<country>
<id>95</id>
<name>HONDURAS</name>
<iso>HN</iso>
<printable_name>Honduras</printable_name>
</country>
<country>
<id>96</id>
<name>HONG KONG</name>
<iso>HK</iso>
<printable_name>Hong Kong</printable_name>
</country>
<country>
<id>97</id>
<name>HUNGARY</name>
<iso>HU</iso>
<printable_name>Hungary</printable_name>
</country>
<country>
<id>98</id>
<name>ICELAND</name>
<iso>IS</iso>
<printable_name>Iceland</printable_name>
</country>
<country>
<id>99</id>
<name>INDIA</name>
<iso>IN</iso>
<printable_name>India</printable_name>
</country>
<country>
<id>100</id>
<name>INDONESIA</name>
<iso>ID</iso>
<printable_name>Indonesia</printable_name>
</country>
<country>
<id>101</id>
<name>IRAN, ISLAMIC REPUBLIC OF</name>
<iso>IR</iso>
<printable_name>Iran, Islamic Republic of</printable_name>
</country>
<country>
<id>102</id>
<name>IRAQ</name>
<iso>IQ</iso>
<printable_name>Iraq</printable_name>
</country>
<country>
<id>103</id>
<name>IRELAND</name>
<iso>IE</iso>
<printable_name>Ireland</printable_name>
</country>
<country>
<id>104</id>
<name>ISRAEL</name>
<iso>IL</iso>
<printable_name>Israel</printable_name>
</country>
<country>
<id>105</id>
<name>ITALY</name>
<iso>IT</iso>
<printable_name>Italy</printable_name>
</country>
<country>
<id>106</id>
<name>JAMAICA</name>
<iso>JM</iso>
<printable_name>Jamaica</printable_name>
</country>
<country>
<id>107</id>
<name>JAPAN</name>
<iso>JP</iso>
<printable_name>Japan</printable_name>
</country>
<country>
<id>108</id>
<name>JORDAN</name>
<iso>JO</iso>
<printable_name>Jordan</printable_name>
</country>
<country>
<id>109</id>
<name>KAZAKHSTAN</name>
<iso>KZ</iso>
<printable_name>Kazakhstan</printable_name>
</country>
<country>
<id>110</id>
<name>KENYA</name>
<iso>KE</iso>
<printable_name>Kenya</printable_name>
</country>
<country>
<id>111</id>
<name>KIRIBATI</name>
<iso>KI</iso>
<printable_name>Kiribati</printable_name>
</country>
<country>
<id>112</id>
<name>KOREA, DEMOCRATIC PEOPLE'S REPUBLIC OF</name>
<iso>KP</iso>
<printable_name>Korea, Democratic People's Republic of</printable_name>
</country>
<country>
<id>113</id>
<name>KOREA, REPUBLIC OF</name>
<iso>KR</iso>
<printable_name>Korea, Republic of</printable_name>
</country>
<country>
<id>114</id>
<name>KUWAIT</name>
<iso>KW</iso>
<printable_name>Kuwait</printable_name>
</country>
<country>
<id>115</id>
<name>KYRGYZSTAN</name>
<iso>KG</iso>
<printable_name>Kyrgyzstan</printable_name>
</country>
<country>
<id>116</id>
<name>LAO PEOPLE'S DEMOCRATIC REPUBLIC</name>
<iso>LA</iso>
<printable_name>Lao People's Democratic Republic</printable_name>
</country>
<country>
<id>117</id>
<name>LATVIA</name>
<iso>LV</iso>
<printable_name>Latvia</printable_name>
</country>
<country>
<id>118</id>
<name>LEBANON</name>
<iso>LB</iso>
<printable_name>Lebanon</printable_name>
</country>
<country>
<id>119</id>
<name>LESOTHO</name>
<iso>LS</iso>
<printable_name>Lesotho</printable_name>
</country>
<country>
<id>120</id>
<name>LIBERIA</name>
<iso>LR</iso>
<printable_name>Liberia</printable_name>
</country>
<country>
<id>121</id>
<name>LIBYAN ARAB JAMAHIRIYA</name>
<iso>LY</iso>
<printable_name>Libyan Arab Jamahiriya</printable_name>
</country>
<country>
<id>122</id>
<name>LIECHTENSTEIN</name>
<iso>LI</iso>
<printable_name>Liechtenstein</printable_name>
</country>
<country>
<id>123</id>
<name>LITHUANIA</name>
<iso>LT</iso>
<printable_name>Lithuania</printable_name>
</country>
<country>
<id>124</id>
<name>LUXEMBOURG</name>
<iso>LU</iso>
<printable_name>Luxembourg</printable_name>
</country>
<country>
<id>125</id>
<name>MACAO</name>
<iso>MO</iso>
<printable_name>Macao</printable_name>
</country>
<country>
<id>126</id>
<name>MACEDONIA, THE FORMER YUGOSLAV REPUBLIC OF</name>
<iso>MK</iso>
<printable_name>Macedonia, the Former Yugoslav Republic of</printable_name>
</country>
<country>
<id>127</id>
<name>MADAGASCAR</name>
<iso>MG</iso>
<printable_name>Madagascar</printable_name>
</country>
<country>
<id>128</id>
<name>MALAWI</name>
<iso>MW</iso>
<printable_name>Malawi</printable_name>
</country>
<country>
<id>129</id>
<name>MALAYSIA</name>
<iso>MY</iso>
<printable_name>Malaysia</printable_name>
</country>
<country>
<id>130</id>
<name>MALDIVES</name>
<iso>MV</iso>
<printable_name>Maldives</printable_name>
</country>
<country>
<id>131</id>
<name>MALI</name>
<iso>ML</iso>
<printable_name>Mali</printable_name>
</country>
<country>
<id>132</id>
<name>MALTA</name>
<iso>MT</iso>
<printable_name>Malta</printable_name>
</country>
<country>
<id>133</id>
<name>MARSHALL ISLANDS</name>
<iso>MH</iso>
<printable_name>Marshall Islands</printable_name>
</country>
<country>
<id>134</id>
<name>MARTINIQUE</name>
<iso>MQ</iso>
<printable_name>Martinique</printable_name>
</country>
<country>
<id>135</id>
<name>MAURITANIA</name>
<iso>MR</iso>
<printable_name>Mauritania</printable_name>
</country>
<country>
<id>136</id>
<name>MAURITIUS</name>
<iso>MU</iso>
<printable_name>Mauritius</printable_name>
</country>
<country>
<id>137</id>
<name>MAYOTTE</name>
<iso>YT</iso>
<printable_name>Mayotte</printable_name>
</country>
<country>
<id>138</id>
<name>MEXICO</name>
<iso>MX</iso>
<printable_name>Mexico</printable_name>
</country>
<country>
<id>139</id>
<name>MICRONESIA, FEDERATED STATES OF</name>
<iso>FM</iso>
<printable_name>Micronesia, Federated States of</printable_name>
</country>
<country>
<id>140</id>
<name>MOLDOVA, REPUBLIC OF</name>
<iso>MD</iso>
<printable_name>Moldova, Republic of</printable_name>
</country>
<country>
<id>141</id>
<name>MONACO</name>
<iso>MC</iso>
<printable_name>Monaco</printable_name>
</country>
<country>
<id>142</id>
<name>MONGOLIA</name>
<iso>MN</iso>
<printable_name>Mongolia</printable_name>
</country>
<country>
<id>143</id>
<name>MONTSERRAT</name>
<iso>MS</iso>
<printable_name>Montserrat</printable_name>
</country>
<country>
<id>144</id>
<name>MOROCCO</name>
<iso>MA</iso>
<printable_name>Morocco</printable_name>
</country>
<country>
<id>145</id>
<name>MOZAMBIQUE</name>
<iso>MZ</iso>
<printable_name>Mozambique</printable_name>
</country>
<country>
<id>146</id>
<name>MYANMAR</name>
<iso>MM</iso>
<printable_name>Myanmar</printable_name>
</country>
<country>
<id>147</id>
<name>NAMIBIA</name>
<iso>NA</iso>
<printable_name>Namibia</printable_name>
</country>
<country>
<id>148</id>
<name>NAURU</name>
<iso>NR</iso>
<printable_name>Nauru</printable_name>
</country>
<country>
<id>149</id>
<name>NEPAL</name>
<iso>NP</iso>
<printable_name>Nepal</printable_name>
</country>
<country>
<id>150</id>
<name>NETHERLANDS</name>
<iso>NL</iso>
<printable_name>Netherlands</printable_name>
</country>
<country>
<id>151</id>
<name>NETHERLANDS ANTILLES</name>
<iso>AN</iso>
<printable_name>Netherlands Antilles</printable_name>
</country>
<country>
<id>152</id>
<name>NEW CALEDONIA</name>
<iso>NC</iso>
<printable_name>New Caledonia</printable_name>
</country>
<country>
<id>153</id>
<name>NEW ZEALAND</name>
<iso>NZ</iso>
<printable_name>New Zealand</printable_name>
</country>
<country>
<id>154</id>
<name>NICARAGUA</name>
<iso>NI</iso>
<printable_name>Nicaragua</printable_name>
</country>
<country>
<id>155</id>
<name>NIGER</name>
<iso>NE</iso>
<printable_name>Niger</printable_name>
</country>
<country>
<id>156</id>
<name>NIGERIA</name>
<iso>NG</iso>
<printable_name>Nigeria</printable_name>
</country>
<country>
<id>157</id>
<name>NIUE</name>
<iso>NU</iso>
<printable_name>Niue</printable_name>
</country>
<country>
<id>158</id>
<name>NORFOLK ISLAND</name>
<iso>NF</iso>
<printable_name>Norfolk Island</printable_name>
</country>
<country>
<id>159</id>
<name>NORTHERN MARIANA ISLANDS</name>
<iso>MP</iso>
<printable_name>Northern Mariana Islands</printable_name>
</country>
<country>
<id>160</id>
<name>NORWAY</name>
<iso>NO</iso>
<printable_name>Norway</printable_name>
</country>
<country>
<id>161</id>
<name>OMAN</name>
<iso>OM</iso>
<printable_name>Oman</printable_name>
</country>
<country>
<id>162</id>
<name>PAKISTAN</name>
<iso>PK</iso>
<printable_name>Pakistan</printable_name>
</country>
<country>
<id>163</id>
<name>PALAU</name>
<iso>PW</iso>
<printable_name>Palau</printable_name>
</country>
<country>
<id>164</id>
<name>PALESTINIAN TERRITORY, OCCUPIED</name>
<iso>PS</iso>
<printable_name>Palestinian Territory, Occupied</printable_name>
</country>
<country>
<id>165</id>
<name>PANAMA</name>
<iso>PA</iso>
<printable_name>Panama</printable_name>
</country>
<country>
<id>166</id>
<name>PAPUA NEW GUINEA</name>
<iso>PG</iso>
<printable_name>Papua New Guinea</printable_name>
</country>
<country>
<id>167</id>
<name>PARAGUAY</name>
<iso>PY</iso>
<printable_name>Paraguay</printable_name>
</country>
<country>
<id>168</id>
<name>PERU</name>
<iso>PE</iso>
<printable_name>Peru</printable_name>
</country>
<country>
<id>169</id>
<name>PHILIPPINES</name>
<iso>PH</iso>
<printable_name>Philippines</printable_name>
</country>
<country>
<id>170</id>
<name>PITCAIRN</name>
<iso>PN</iso>
<printable_name>Pitcairn</printable_name>
</country>
<country>
<id>171</id>
<name>POLAND</name>
<iso>PL</iso>
<printable_name>Poland</printable_name>
</country>
<country>
<id>172</id>
<name>PORTUGAL</name>
<iso>PT</iso>
<printable_name>Portugal</printable_name>
</country>
<country>
<id>173</id>
<name>PUERTO RICO</name>
<iso>PR</iso>
<printable_name>Puerto Rico</printable_name>
</country>
<country>
<id>174</id>
<name>QATAR</name>
<iso>QA</iso>
<printable_name>Qatar</printable_name>
</country>
<country>
<id>175</id>
<name>REUNION</name>
<iso>RE</iso>
<printable_name>Reunion</printable_name>
</country>
<country>
<id>176</id>
<name>ROMANIA</name>
<iso>RO</iso>
<printable_name>Romania</printable_name>
</country>
<country>
<id>177</id>
<name>RUSSIAN FEDERATION</name>
<iso>RU</iso>
<printable_name>Russian Federation</printable_name>
</country>
<country>
<id>178</id>
<name>RWANDA</name>
<iso>RW</iso>
<printable_name>Rwanda</printable_name>
</country>
<country>
<id>179</id>
<name>SAINT HELENA</name>
<iso>SH</iso>
<printable_name>Saint Helena</printable_name>
</country>
<country>
<id>180</id>
<name>SAINT KITTS AND NEVIS</name>
<iso>KN</iso>
<printable_name>Saint Kitts and Nevis</printable_name>
</country>
<country>
<id>181</id>
<name>SAINT LUCIA</name>
<iso>LC</iso>
<printable_name>Saint Lucia</printable_name>
</country>
<country>
<id>182</id>
<name>SAINT PIERRE AND MIQUELON</name>
<iso>PM</iso>
<printable_name>Saint Pierre and Miquelon</printable_name>
</country>
<country>
<id>183</id>
<name>SAINT VINCENT AND THE GRENADINES</name>
<iso>VC</iso>
<printable_name>Saint Vincent and the Grenadines</printable_name>
</country>
<country>
<id>184</id>
<name>SAMOA</name>
<iso>WS</iso>
<printable_name>Samoa</printable_name>
</country>
<country>
<id>185</id>
<name>SAN MARINO</name>
<iso>SM</iso>
<printable_name>San Marino</printable_name>
</country>
<country>
<id>186</id>
<name>SAO TOME AND PRINCIPE</name>
<iso>ST</iso>
<printable_name>Sao Tome and Principe</printable_name>
</country>
<country>
<id>187</id>
<name>SAUDI ARABIA</name>
<iso>SA</iso>
<printable_name>Saudi Arabia</printable_name>
</country>
<country>
<id>188</id>
<name>SENEGAL</name>
<iso>SN</iso>
<printable_name>Senegal</printable_name>
</country>
<country>
<id>189</id>
<name>SERBIA AND MONTENEGRO</name>
<iso>CS</iso>
<printable_name>Serbia and Montenegro</printable_name>
</country>
<country>
<id>190</id>
<name>SEYCHELLES</name>
<iso>SC</iso>
<printable_name>Seychelles</printable_name>
</country>
<country>
<id>191</id>
<name>SIERRA LEONE</name>
<iso>SL</iso>
<printable_name>Sierra Leone</printable_name>
</country>
<country>
<id>192</id>
<name>SINGAPORE</name>
<iso>SG</iso>
<printable_name>Singapore</printable_name>
</country>
<country>
<id>193</id>
<name>SLOVAKIA</name>
<iso>SK</iso>
<printable_name>Slovakia</printable_name>
</country>
<country>
<id>194</id>
<name>SLOVENIA</name>
<iso>SI</iso>
<printable_name>Slovenia</printable_name>
</country>
<country>
<id>195</id>
<name>SOLOMON ISLANDS</name>
<iso>SB</iso>
<printable_name>Solomon Islands</printable_name>
</country>
<country>
<id>196</id>
<name>SOMALIA</name>
<iso>SO</iso>
<printable_name>Somalia</printable_name>
</country>
<country>
<id>197</id>
<name>SOUTH AFRICA</name>
<iso>ZA</iso>
<printable_name>South Africa</printable_name>
</country>
<country>
<id>198</id>
<name>SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS</name>
<iso>GS</iso>
<printable_name>South Georgia and the South Sandwich Islands</printable_name>
</country>
<country>
<id>199</id>
<name>SPAIN</name>
<iso>ES</iso>
<printable_name>Spain</printable_name>
</country>
<country>
<id>200</id>
<name>SRI LANKA</name>
<iso>LK</iso>
<printable_name>Sri Lanka</printable_name>
</country>
<country>
<id>201</id>
<name>SUDAN</name>
<iso>SD</iso>
<printable_name>Sudan</printable_name>
</country>
<country>
<id>202</id>
<name>SURINAME</name>
<iso>SR</iso>
<printable_name>Suriname</printable_name>
</country>
<country>
<id>203</id>
<name>SVALBARD AND JAN MAYEN</name>
<iso>SJ</iso>
<printable_name>Svalbard and Jan Mayen</printable_name>
</country>
<country>
<id>204</id>
<name>SWAZILAND</name>
<iso>SZ</iso>
<printable_name>Swaziland</printable_name>
</country>
<country>
<id>205</id>
<name>SWEDEN</name>
<iso>SE</iso>
<printable_name>Sweden</printable_name>
</country>
<country>
<id>206</id>
<name>SWITZERLAND</name>
<iso>CH</iso>
<printable_name>Switzerland</printable_name>
</country>
<country>
<id>207</id>
<name>SYRIAN ARAB REPUBLIC</name>
<iso>SY</iso>
<printable_name>Syrian Arab Republic</printable_name>
</country>
<country>
<id>208</id>
<name>TAIWAN, PROVINCE OF CHINA</name>
<iso>TW</iso>
<printable_name>Taiwan, Province of China</printable_name>
</country>
<country>
<id>209</id>
<name>TAJIKISTAN</name>
<iso>TJ</iso>
<printable_name>Tajikistan</printable_name>
</country>
<country>
<id>210</id>
<name>TANZANIA, UNITED REPUBLIC OF</name>
<iso>TZ</iso>
<printable_name>Tanzania, United Republic of</printable_name>
</country>
<country>
<id>211</id>
<name>THAILAND</name>
<iso>TH</iso>
<printable_name>Thailand</printable_name>
</country>
<country>
<id>212</id>
<name>TIMOR-LESTE</name>
<iso>TL</iso>
<printable_name>Timor-Leste</printable_name>
</country>
<country>
<id>213</id>
<name>TOGO</name>
<iso>TG</iso>
<printable_name>Togo</printable_name>
</country>
<country>
<id>214</id>
<name>TOKELAU</name>
<iso>TK</iso>
<printable_name>Tokelau</printable_name>
</country>
<country>
<id>215</id>
<name>TONGA</name>
<iso>TO</iso>
<printable_name>Tonga</printable_name>
</country>
<country>
<id>216</id>
<name>TRINIDAD AND TOBAGO</name>
<iso>TT</iso>
<printable_name>Trinidad and Tobago</printable_name>
</country>
<country>
<id>217</id>
<name>TUNISIA</name>
<iso>TN</iso>
<printable_name>Tunisia</printable_name>
</country>
<country>
<id>218</id>
<name>TURKEY</name>
<iso>TR</iso>
<printable_name>Turkey</printable_name>
</country>
<country>
<id>219</id>
<name>TURKMENISTAN</name>
<iso>TM</iso>
<printable_name>Turkmenistan</printable_name>
</country>
<country>
<id>220</id>
<name>TURKS AND CAICOS ISLANDS</name>
<iso>TC</iso>
<printable_name>Turks and Caicos Islands</printable_name>
</country>
<country>
<id>221</id>
<name>TUVALU</name>
<iso>TV</iso>
<printable_name>Tuvalu</printable_name>
</country>
<country>
<id>222</id>
<name>UGANDA</name>
<iso>UG</iso>
<printable_name>Uganda</printable_name>
</country>
<country>
<id>223</id>
<name>UKRAINE</name>
<iso>UA</iso>
<printable_name>Ukraine</printable_name>
</country>
<country>
<id>224</id>
<name>UNITED ARAB EMIRATES</name>
<iso>AE</iso>
<printable_name>United Arab Emirates</printable_name>
</country>
<country>
<id>225</id>
<name>UNITED KINGDOM</name>
<iso>GB</iso>
<printable_name>United Kingdom</printable_name>
</country>
<country>
<id>226</id>
<name>UNITED STATES</name>
<iso>US</iso>
<printable_name>United States</printable_name>
</country>
<country>
<id>227</id>
<name>UNITED STATES MINOR OUTLYING ISLANDS</name>
<iso>UM</iso>
<printable_name>United States Minor Outlying Islands</printable_name>
</country>
<country>
<id>228</id>
<name>URUGUAY</name>
<iso>UY</iso>
<printable_name>Uruguay</printable_name>
</country>
<country>
<id>229</id>
<name>UZBEKISTAN</name>
<iso>UZ</iso>
<printable_name>Uzbekistan</printable_name>
</country>
<country>
<id>230</id>
<name>VANUATU</name>
<iso>VU</iso>
<printable_name>Vanuatu</printable_name>
</country>
<country>
<id>231</id>
<name>VENEZUELA</name>
<iso>VE</iso>
<printable_name>Venezuela</printable_name>
</country>
<country>
<id>232</id>
<name>VIET NAM</name>
<iso>VN</iso>
<printable_name>Viet Nam</printable_name>
</country>
<country>
<id>233</id>
<name>VIRGIN ISLANDS, BRITISH</name>
<iso>VG</iso>
<printable_name>Virgin Islands, British</printable_name>
</country>
<country>
<id>234</id>
<name>VIRGIN ISLANDS, U.S.</name>
<iso>VI</iso>
<printable_name>Virgin Islands, U.s.</printable_name>
</country>
<country>
<id>235</id>
<name>WALLIS AND FUTUNA</name>
<iso>WF</iso>
<printable_name>Wallis and Futuna</printable_name>
</country>
<country>
<id>236</id>
<name>WESTERN SAHARA</name>
<iso>EH</iso>
<printable_name>Western Sahara</printable_name>
</country>
<country>
<id>237</id>
<name>YEMEN</name>
<iso>YE</iso>
<printable_name>Yemen</printable_name>
</country>
<country>
<id>238</id>
<name>ZAMBIA</name>
<iso>ZM</iso>
<printable_name>Zambia</printable_name>
</country>
<country>
<id>239</id>
<name>ZIMBABWE</name>
<iso>ZW</iso>
<printable_name>Zimbabwe</printable_name>
</country>
</countries>
</get_delivery_countries>
update_order_details
Setting the order specific attributes for a given order determined by its id. If the order is already closed an error will be returned.
Arguments
-
id_order (int)
The id of the order you want to update.
-
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.id_delivery_method (int)
order_state (string)
A valid order_state. Valid values: OPEN, PROCESSING, CLOSED and CANCELED
-
order_payment_state (string)
Here you can set the payment_state. Valid values: PAYMENT_NOT_RECEIVED or PAYMENT_RECEIVED.
-
order_delivery_state (string)
Here you can set the delivery_state. Valid values: PROCESSING or CLOSED.
-
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.
-
licence_secret_key (string)
Your licence - secret - key.
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='' \
-d request='update_order_details' \
-d id_order=1 \
-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.
Response
{
"object":"update_order_details",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<update_order_details>
<status>success</status>
</update_order_details>
get_order_details
Delivers the order - details of a specific session.
Arguments
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-section | Infos about the user belonging to this order. If a user is logged in this section will contain the user after checkout. |
|---|---|
| order_payment_method-section | Section containing informations about the payment-method you set. |
| order_delivery_method-section | Section containing informations about the delivery-method you set. |
| order_payment_state-section | Section containing informations about the payment-state of the order. |
| order_delivery_state-section | Section containing informations about the delivery-state of the order. |
| order_state-section | Section containing informations about the order-state. |
| order_type-section | Section containing informations about the order-type. |
| main order data fields | Here you get the whole order-detail - fields. |
| attributes-section | The additional attributes you set. |
get_order_by_id
Delivers the order - details of a specific order determined by its id.
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='get_order_by_id' \
-d id_order=1 \
-d language='de_DE'
Response
{
"object":"order",
"id":142,
"order_number":10247,
"creation_date":"2022-09-18 19:41:54",
"username":"guest",
"order_delivery_companyname":"",
"order_delivery_department":"",
"order_delivery_salutation":"mr",
"order_delivery_firstname":"k",
"order_delivery_lastname":"r",
"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_delivery_country_code":"DE",
"order_invoice_companyname":"",
"order_invoice_department":"",
"order_invoice_salutation":"MR",
"order_invoice_firstname":"k",
"order_invoice_lastname":"r",
"order_invoice_street":"max-brauer-allee",
"order_invoice_number":"218",
"order_invoice_zip":"22769",
"order_invoice_state":"",
"order_invoice_city":"hamburg",
"order_invoice_country":"Germany",
"order_invoice_country_code":"DE",
"order_email":"test123@test123.com",
"order_phone":"",
"order_note":"",
"payment_method":"PayPal",
"payment_state":
{
"name":"PAYMENT_NOT_RECEIVED",
"label":"Payment not received"
},
"delivery_method":"Shipping",
"delivery_state":{
"name":"PROCESSING",
"label":"Processing"
},
"order_state":"OPEN",
"attributes":{
"sys_success_url":
{
"name":"sys_success_url",
"value":"here-we-go.com"
}
,
"sys_cancel_url":
{
"name":"sys_cancel_url",
"value":"error-page.com"
}
},
"cart":
{
"creation_date":"2022-09-18 19:41:34",
"sum":123,
"contents":[
{
"type":"PRODUCT",
"id":465,
"id_product":537,
"element_number":"117.1",
"quantity":1,
"price":123,
"sum_price":123,
"tax":19.6387,
"sum_tax":19.6387,
"name":"tew",
"description":"asd",
"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":""
}
}
}
],
"coupons":{
"sum":0,
"positions":[
]
},
"delivery_costs":{
"sum":0,
"positions":[
]
}
},
"parcels":
[
]
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<order>
<id>142</id>
<order_number>10247</order_number>
<creation_date>2022-09-18 19:41:54</creation_date>
<order_delivery_companyname></order_delivery_companyname>
<order_delivery_department></order_delivery_department>
<order_delivery_salutation>mr</order_delivery_salutation>
<order_delivery_firstname>k</order_delivery_firstname>
<order_delivery_lastname>r</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_delivery_country_code>DE</order_delivery_country_code>
<order_invoice_companyname></order_invoice_companyname>
<order_invoice_department></order_invoice_department>
<order_invoice_salutation>MR</order_invoice_salutation>
<order_invoice_firstname>k</order_invoice_firstname>
<order_invoice_lastname>r</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></order_invoice_state>
<order_invoice_city>hamburg</order_invoice_city>
<order_invoice_country>Germany</order_invoice_country>
<order_invoice_country_code>DE</order_invoice_country_code>
<order_email>testmail@test.com</order_email>
<order_phone></order_phone>
<order_note></order_note>
<payment_method>PayPal</payment_method>
<payment_state><name>PAYMENT_NOT_RECEIVED</name><label>Payment not received</label></payment_state>
<delivery_method>Shipping</delivery_method>
<delivery_state><name>PROCESSING</name><label>Processing</label></delivery_state>
<order_state>OPEN</order_state>
<attributes><attribute name="sys_success_url">https://www.test123.com</attribute><attribute name="sys_cancel_url">https://www.testcancel.com?id_order=123</attribute></attributes>
<cart>
<creation_date>2022-09-18 19:41:34</creation_date>
<sum>123</sum>
<contents>
<element type="PRODUCT">
<id>465</id>
<id_product>537</id_product>
<element_number>117.1</element_number>
<quantity>1</quantity>
<price>123</price>
<sum_price>123</sum_price>
<tax>19.6387</tax>
<sum_tax>19.6387</sum_tax>
<name>tew</name>
<description>asd</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>
<coupons>
<sum></sum>
<positions>
</positions>
</coupons>
<delivery_costs>
<sum></sum>
<positions>
</positions>
</delivery_costs>
</cart>
<parcels>
</parcels>
</order>
Explanation
| user-section | Infos about the user belonging to this order. If a user is logged in this section will contain the user after checkout. |
|---|---|
| order_payment_method-section | Section containing informations about the payment-method you set. |
| order_delivery_method-section | Section containing informations about the delivery-method you set. |
| order_payment_state-section | Section containing informations about the payment-state of the order. |
| order_delivery_state-section | Section containing informations about the delivery-state of the order. |
| order_state-section | Section containing informations about the order-state. |
| order_type-section | Section containing informations about the order-type. |
| main order data fields | Here you get the whole order-detail - fields. |
| attributes-section | The additional attributes you set. |
| cart-section | The cart of the order. |
| parcels-section | The parcels that are available. |
checkout
Checks out a session - order. Makes the order permament.
Arguments
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
| status | The status showing wether the process was successful or not. |
|---|---|
| id_order | The unique ID of the order you just created. |
| session | A 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. |
| message | A message telling you something about the status. |
| param | Parameters belonging to the message. |
get_invoice
Delivers the invoice for a specified order using the defined invoice - form. The form will be delivered base64 encoded. So you have to decode at the frontend - side.
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='get_invoice' \
-d id_order=10
Response
{
"object":"invoice",
"invoice":"PCFET0NUWVBFIGh0bWw+CjxodG1sPgoJPGhlYWQ+CgkJPHRpdGxlPlJHPC90aXRsZT4KCQk8c3R5bGU+CgkJCgkJYm9keXsKCQlmb250LWZhbWlseTogVmVyZGFuYSwgJ0x1Y2lkYSBTYW5zIFVuaWNvZGUnLCBzYW5zLXNlcmlmOwoJCWZvbnQtc2l6ZToxM3B4OwoJCX0KCQkgCgkJIC5sb2dvewoJCSAgcG9zaXRpb246YWJzb2x1dGU7CgkJICBsZWZ0OjEuNWNtOwoJCSAgdG9wOjEuMGNtOwoJCSB9CgkJCgkJLmFkZHlfZmllbGR7CgkJICBwb3NpdGlvbjphYnNvbHV0ZTsKCQkgIHRvcDo0LjhjbTsKCQkgIGxlZnQ6MS41Y207CgkJICB3aWR0aDo4LjBjbTsKCQkgIGhlaWdodDozLjVjbTsKCQkgIGJhY2tncm91bmQtY29sb3I6I2Y0ZjRmNDsKCQkgfQogICAgICAgICAKCQkuYWRkeV9maWVsZCAuZmlybV9hZGR5ewogICAgICAgICAgICBwYWRkaW5nOiAxMHB4OwogICAgCQlmb250LXNpemU6IDlweDsKCQl9CgkJCgkJLmFkZHlfZmllbGQgLmN1c3RvbWVyX2FkZHkKCQl7CgkJIHBvc2l0aW9uOiBhYnNvbHV0ZTsKCQkgbWFyZ2luLXRvcDogMC4yNWNtOwogICAgICAgICBwYWRkaW5nOiAxMHB4OwoJCSBmb250LXNpemU6IDEycHg7CgkJfQoJCQoJCS5pbmZvX2ZpZWxkewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCWxlZnQ6MTEuNWNtOwoJCXRvcDo0LjhjbTsKCQl3aWR0aDo3LjBjbTsKCQloZWlnaHQ6MS4wY207CiAgICAgICAgICAgICAgIGZvbnQtc2l6ZToxMXB4OwoJCX0KCQkKCQkKCQkub3JkZXJfY29udGVudHsKCQlwb3NpdGlvbjphYnNvbHV0ZTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoxMC41Y207CiAgICAgICAgd2lkdGg6IDYwMHB4OwoJCX0KCQkKCQkKCQkuZm9vdGVyewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCXdpZHRoOjE3LjBjbTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoyMy4wY207CgkJaGVpZ2h0OjIuMGNtOwpmb250LXNpemU6IDExcHg7CgkJfQoJCQoJCUBtZWRpYSBwcmludHsKCgkJCgkJfQoJCQoJCTwvc3R5bGU+Cgk8L2hlYWQ+CgoJPGJvZHk+CgkJPGRpdiBjbGFzcz0ibG9nbyI+PGltZyBzcmM9Imh0dHA6Ly9uaWljZS1zd2VhdHNoaXJ0LmNvbS9pbWcvbG9nby5wbmciPjwvZGl2PgoJCTxkaXYgY2xhc3M9ImFkZHlfZmllbGQiPgoJCTxkaXYgY2xhc3M9ImZpcm1fYWRkeSI+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPGJyPkVwcGVuZG9yZmVyIFdlZyA2NiwgMjAyNTkgSGFtYnVyZzwvZGl2PgoJCTxkaXYgY2xhc3M9ImN1c3RvbWVyX2FkZHkiPnNsZWVrY29tbWVyY2UgVUc8YnI+SGVyciBrYXZlaCByYWppPGJyPk1heC1CcmF1ZXItQWxsZWUgMjE4PGJyPjIyNzY5IEhhbWJ1cmcgR2VybWFueTwvZGl2PgoJCTwvZGl2PgoJCTxkaXYgY2xhc3M9ImluZm9fZmllbGQiPgoJCTxzdHJvbmc+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPC9zdHJvbmc+PGJyPgogICAgICAgICAgICAgICBFcHBlbmRvcmZlciBXZWcgNjY8YnI+CiAgICAgICAgICAgICAgIDIwMjU5IEhhbWJ1cmc8YnI+CiAgICAgICAgICAgICAgRS1NYWlsOiBuaWljZTJ3ZWFyQGdtYWlsLmNvbTxicj48YnI+CiAgICAgICAgICAgICAgVXN0LUlEOiBERTMwNTc4NDk0NDxicj48YnI+CjxzdHJvbmc+QmFua3ZlcmJpbmR1bmc8L3N0cm9uZz48YnI+Ck5hbWUgZGVyIEJhbms6IEhhbWJ1cmdlciBTcGFya2Fzc2U8YnI+CklCQU46IERFMTYgMjAwNSAwNTUwIDEyMDUgMTQ2MCA3Nzxicj4KQklDOiBIQVNQREVISFhYWDxicj4KS29udG9pbmhhYmVyOiBSdXRoIEtvYmJlIFNhYnJpbmEgTGVuegoJCTwvZGl2PgoJCQoJCTxkaXYgY2xhc3M9Im9yZGVyX2NvbnRlbnQiPgoJCTxoMT5BYnJlY2hudW5nPC9oMT4KUmVjaG51bmdzbnVtbWVyOiAxMDxicj4KCQlEYXR1bTogMjAxNy0wMy0yMSAxNzoxNzozNzxicj48YnI+CgkJU2VociBnZWVocnRlIERhbWVuIHVuZCBIZXJyZW4sIDxicj4KCQl3aXIgYmVkYW5rZW4gdW5zIGbDvHIgSWhyZW4gQXVmdHJhZyB1bmQgZXJsYXViZW4gdW5zIHdpZSBmb2xndCB6dSBiZXJlY2huZW46PGJyPjxicj4KICAgICAgICA8dGFibGUgd2lkdGg9IjEwMCUiPgogICAgICAgICAgICA8dHI+CiAgICAgICAgICAgICAgICA8dGg+PC90aD4KICAgICAgICAgICAgICAgIDx0aCBhbGlnbj0ibGVmdCI+QmV6ZWljaG51bmc8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+TWVuZ2U8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+RWluemVscHJlaXM8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+U3VtbWU8L3RoPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICAKICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkPjE8L3RkPgogICAgICAgICAgICAgICAgPHRkIGFsaWduPSJsZWZ0Ij4gU2NobmVlaHV0IHNjaHdhcnoKICAgICAgICAgICAgICAgICAgICA8YnI+U3VwZXJmbGF1c2NoaWdlciBTY2huZWVodXQgaW4gc2Nod2FyeiAtIE9uZVNpemUKICAgICAgICAgICAgICAgIDwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjE4LjkwIEVVUjwvdGQ+CiAgICAgICAgICA"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<invoice>
PCFET0NUWVBFIGh0bWw+CjxodG1sPgoJPGhlYWQ+CgkJPHRpdGxlPlJHPC90aXRsZT4KCQk8c3R5bGU+CgkJCgkJYm9keXsKCQlmb250LWZhbWlseTogVmVyZGFuYSwgJ0x1Y2lkYSBTYW5zIFVuaWNvZGUnLCBzYW5zLXNlcmlmOwoJCWZvbnQtc2l6ZToxM3B4OwoJCX0KCQkgCgkJIC5sb2dvewoJCSAgcG9zaXRpb246YWJzb2x1dGU7CgkJICBsZWZ0OjEuNWNtOwoJCSAgdG9wOjEuMGNtOwoJCSB9CgkJCgkJLmFkZHlfZmllbGR7CgkJICBwb3NpdGlvbjphYnNvbHV0ZTsKCQkgIHRvcDo0LjhjbTsKCQkgIGxlZnQ6MS41Y207CgkJICB3aWR0aDo4LjBjbTsKCQkgIGhlaWdodDozLjVjbTsKCQkgIGJhY2tncm91bmQtY29sb3I6I2Y0ZjRmNDsKCQkgfQogICAgICAgICAKCQkuYWRkeV9maWVsZCAuZmlybV9hZGR5ewogICAgICAgICAgICBwYWRkaW5nOiAxMHB4OwogICAgCQlmb250LXNpemU6IDlweDsKCQl9CgkJCgkJLmFkZHlfZmllbGQgLmN1c3RvbWVyX2FkZHkKCQl7CgkJIHBvc2l0aW9uOiBhYnNvbHV0ZTsKCQkgbWFyZ2luLXRvcDogMC4yNWNtOwogICAgICAgICBwYWRkaW5nOiAxMHB4OwoJCSBmb250LXNpemU6IDEycHg7CgkJfQoJCQoJCS5pbmZvX2ZpZWxkewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCWxlZnQ6MTEuNWNtOwoJCXRvcDo0LjhjbTsKCQl3aWR0aDo3LjBjbTsKCQloZWlnaHQ6MS4wY207CiAgICAgICAgICAgICAgIGZvbnQtc2l6ZToxMXB4OwoJCX0KCQkKCQkKCQkub3JkZXJfY29udGVudHsKCQlwb3NpdGlvbjphYnNvbHV0ZTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoxMC41Y207CiAgICAgICAgd2lkdGg6IDYwMHB4OwoJCX0KCQkKCQkKCQkuZm9vdGVyewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCXdpZHRoOjE3LjBjbTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoyMy4wY207CgkJaGVpZ2h0OjIuMGNtOwpmb250LXNpemU6IDExcHg7CgkJfQoJCQoJCUBtZWRpYSBwcmludHsKCgkJCgkJfQoJCQoJCTwvc3R5bGU+Cgk8L2hlYWQ+CgoJPGJvZHk+CgkJPGRpdiBjbGFzcz0ibG9nbyI+PGltZyBzcmM9Imh0dHA6Ly9uaWljZS1zd2VhdHNoaXJ0LmNvbS9pbWcvbG9nby5wbmciPjwvZGl2PgoJCTxkaXYgY2xhc3M9ImFkZHlfZmllbGQiPgoJCTxkaXYgY2xhc3M9ImZpcm1fYWRkeSI+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPGJyPkVwcGVuZG9yZmVyIFdlZyA2NiwgMjAyNTkgSGFtYnVyZzwvZGl2PgoJCTxkaXYgY2xhc3M9ImN1c3RvbWVyX2FkZHkiPnNsZWVrY29tbWVyY2UgVUc8YnI+SGVyciBrYXZlaCByYWppPGJyPk1heC1CcmF1ZXItQWxsZWUgMjE4PGJyPjIyNzY5IEhhbWJ1cmcgR2VybWFueTwvZGl2PgoJCTwvZGl2PgoJCTxkaXYgY2xhc3M9ImluZm9fZmllbGQiPgoJCTxzdHJvbmc+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPC9zdHJvbmc+PGJyPgogICAgICAgICAgICAgICBFcHBlbmRvcmZlciBXZWcgNjY8YnI+CiAgICAgICAgICAgICAgIDIwMjU5IEhhbWJ1cmc8YnI+CiAgICAgICAgICAgICAgRS1NYWlsOiBuaWljZTJ3ZWFyQGdtYWlsLmNvbTxicj48YnI+CiAgICAgICAgICAgICAgVXN0LUlEOiBERTMwNTc4NDk0NDxicj48YnI+CjxzdHJvbmc+QmFua3ZlcmJpbmR1bmc8L3N0cm9uZz48YnI+Ck5hbWUgZGVyIEJhbms6IEhhbWJ1cmdlciBTcGFya2Fzc2U8YnI+CklCQU46IERFMTYgMjAwNSAwNTUwIDEyMDUgMTQ2MCA3Nzxicj4KQklDOiBIQVNQREVISFhYWDxicj4KS29udG9pbmhhYmVyOiBSdXRoIEtvYmJlIFNhYnJpbmEgTGVuegoJCTwvZGl2PgoJCQoJCTxkaXYgY2xhc3M9Im9yZGVyX2NvbnRlbnQiPgoJCTxoMT5BYnJlY2hudW5nPC9oMT4KUmVjaG51bmdzbnVtbWVyOiAxMDxicj4KCQlEYXR1bTogMjAxNy0wMy0yMSAxNzoxNzozNzxicj48YnI+CgkJU2VociBnZWVocnRlIERhbWVuIHVuZCBIZXJyZW4sIDxicj4KCQl3aXIgYmVkYW5rZW4gdW5zIGbDvHIgSWhyZW4gQXVmdHJhZyB1bmQgZXJsYXViZW4gdW5zIHdpZSBmb2xndCB6dSBiZXJlY2huZW46PGJyPjxicj4KICAgICAgICA8dGFibGUgd2lkdGg9IjEwMCUiPgogICAgICAgICAgICA8dHI+CiAgICAgICAgICAgICAgICA8dGg+PC90aD4KICAgICAgICAgICAgICAgIDx0aCBhbGlnbj0ibGVmdCI+QmV6ZWljaG51bmc8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+TWVuZ2U8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+RWluemVscHJlaXM8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+U3VtbWU8L3RoPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICAKICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkPjE8L3RkPgogICAgICAgICAgICAgICAgPHRkIGFsaWduPSJsZWZ0Ij4gU2NobmVlaHV0IHNjaHdhcnoKICAgICAgICAgICAgICAgICAgICA8YnI+U3VwZXJmbGF1c2NoaWdlciBTY2huZWVodXQgaW4gc2Nod2FyeiAtIE9uZVNpemUKICAgICAgICAgICAgICAgIDwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjE4LjkwIEVVUjwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xOC45MCBFVVI8L3RkPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICAKICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkPjI8L3RkPgogICAgICAgICAgICAgICAgPHRkIGFsaWduPSJsZWZ0Ij5WZXJzYW5ka29zdGVuCiAgICAgICAgICAgICAgICAgICAgPGJyPiAKICAgICAgICAgICAgICAgIDwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjAuMDAgRVVSPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjAuMDAgRVVSPC90ZD4KICAgICAgICAgICAgPC90cj4KICAgICAgICAgICAgCiAgICAgICAgICAgIDx0cj4KICAgICAgICAgICAgICAgIDx0ZCBjb2xzcGFuPSIaWdodDogMXB4OyBib3JkZXI6IDA7IGJvcmRlci1ib3R0b206IDFweCBzb2xpZCAjY2NjY2NjIj48L3RkPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICA8dHI+CiAgICAgICAgICAgICAgICA8dGQgY29scC90ZD4KICAgICAgICAgICAgPC90cj4KICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkIGNvbHNwYW49IjQiIGFsaWduPSJyaWdodCI+PHN0cm9uZz5TdW1tZTwvc3Ryb25nPjwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij48c3Ryb25nPjE4LjkwIEVVUjwvc3Ryb25nPjwvdGQ+CiAgICAgICAgICAgIDwvdHI+CiAgICAgICAgPC90YWJsZT4KCQk8L2Rpdj4KCQkKCQkKCQk8ZGl2IGNsYXNzPSJmb290ZXIiPgoJCgkJPC9kaXY+CgkJCgkJCgk8L2JvZHk+CjwvaHRtbD4=
</invoice>
Explanation
| invoice | The base64 encoded invoice form which is generated using the invoice-form the user defined in the backend. |
|---|
get_order_confirmation
Delivers the order confirmation for a specified order using the defined order confirmation - form. The form will be delivered base64 encoded. So you have to decode at the frontend - side.
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='get_order_confirmation' \
-d id_order=10 \
-d args='{"invoice_link":"www.your-link"}'
Response
{
"object":"order_confirmation",
"order_confirmation":"PCFET0NUWVBFIGh0bWw+CjxodG1sPgoJPGhlYWQ+CgkJPHRpdGxlPlJHPC90aXRsZT4KCQk8c3R5bGU+CgkJCgkJYm9keXsKCQlmb250LWZhbWlseTogVmVyZGFuYSwgJ0x1Y2lkYSBTYW5zIFVuaWNvZGUnLCBzYW5zLXNlcmlmOwoJCWZvbnQtc2l6ZToxM3B4OwoJCX0KCQkgCgkJIC5sb2dvewoJCSAgcG9zaXRpb246YWJzb2x1dGU7CgkJICBsZWZ0OjEuNWNtOwoJCSAgdG9wOjEuMGNtOwoJCSB9CgkJCgkJLmFkZHlfZmllbGR7CgkJICBwb3NpdGlvbjphYnNvbHV0ZTsKCQkgIHRvcDo0LjhjbTsKCQkgIGxlZnQ6MS41Y207CgkJICB3aWR0aDo4LjBjbTsKCQkgIGhlaWdodDozLjVjbTsKCQkgIGJhY2tncm91bmQtY29sb3I6I2Y0ZjRmNDsKCQkgfQogICAgICAgICAKCQkuYWRkeV9maWVsZCAuZmlybV9hZGR5ewogICAgICAgICAgICBwYWRkaW5nOiAxMHB4OwogICAgCQlmb250LXNpemU6IDlweDsKCQl9CgkJCgkJLmFkZHlfZmllbGQgLmN1c3RvbWVyX2FkZHkKCQl7CgkJIHBvc2l0aW9uOiBhYnNvbHV0ZTsKCQkgbWFyZ2luLXRvcDogMC4yNWNtOwogICAgICAgICBwYWRkaW5nOiAxMHB4OwoJCSBmb250LXNpemU6IDEycHg7CgkJfQoJCQoJCS5pbmZvX2ZpZWxkewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCWxlZnQ6MTEuNWNtOwoJCXRvcDo0LjhjbTsKCQl3aWR0aDo3LjBjbTsKCQloZWlnaHQ6MS4wY207CiAgICAgICAgICAgICAgIGZvbnQtc2l6ZToxMXB4OwoJCX0KCQkKCQkKCQkub3JkZXJfY29udGVudHsKCQlwb3NpdGlvbjphYnNvbHV0ZTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoxMC41Y207CiAgICAgICAgd2lkdGg6IDYwMHB4OwoJCX0KCQkKCQkKCQkuZm9vdGVyewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCXdpZHRoOjE3LjBjbTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoyMy4wY207CgkJaGVpZ2h0OjIuMGNtOwpmb250LXNpemU6IDExcHg7CgkJfQoJCQoJCUBtZWRpYSBwcmludHsKCgkJCgkJfQoJCQoJCTwvc3R5bGU+Cgk8L2hlYWQ+CgoJPGJvZHk+CgkJPGRpdiBjbGFzcz0ibG9nbyI+PGltZyBzcmM9Imh0dHA6Ly9uaWljZS1zd2VhdHNoaXJ0LmNvbS9pbWcvbG9nby5wbmciPjwvZGl2PgoJCTxkaXYgY2xhc3M9ImFkZHlfZmllbGQiPgoJCTxkaXYgY2xhc3M9ImZpcm1fYWRkeSI+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPGJyPkVwcGVuZG9yZmVyIFdlZyA2NiwgMjAyNTkgSGFtYnVyZzwvZGl2PgoJCTxkaXYgY2xhc3M9ImN1c3RvbWVyX2FkZHkiPnNsZWVrY29tbWVyY2UgVUc8YnI+SGVyciBrYXZlaCByYWppPGJyPk1heC1CcmF1ZXItQWxsZWUgMjE4PGJyPjIyNzY5IEhhbWJ1cmcgR2VybWFueTwvZGl2PgoJCTwvZGl2PgoJCTxkaXYgY2xhc3M9ImluZm9fZmllbGQiPgoJCTxzdHJvbmc+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPC9zdHJvbmc+PGJyPgogICAgICAgICAgICAgICBFcHBlbmRvcmZlciBXZWcgNjY8YnI+CiAgICAgICAgICAgICAgIDIwMjU5IEhhbWJ1cmc8YnI+CiAgICAgICAgICAgICAgRS1NYWlsOiBuaWljZTJ3ZWFyQGdtYWlsLmNvbTxicj48YnI+CiAgICAgICAgICAgICAgVXN0LUlEOiBERTMwNTc4NDk0NDxicj48YnI+CjxzdHJvbmc+QmFua3ZlcmJpbmR1bmc8L3N0cm9uZz48YnI+Ck5hbWUgZGVyIEJhbms6IEhhbWJ1cmdlciBTcGFya2Fzc2U8YnI+CklCQU46IERFMTYgMjAwNSAwNTUwIDEyMDUgMTQ2MCA3Nzxicj4KQklDOiBIQVNQREVISFhYWDxicj4KS29udG9pbmhhYmVyOiBSdXRoIEtvYmJlIFNhYnJpbmEgTGVuegoJCTwvZGl2PgoJCQoJCTxkaXYgY2xhc3M9Im9yZGVyX2NvbnRlbnQiPgoJCTxoMT5BYnJlY2hudW5nPC9oMT4KUmVjaG51bmdzbnVtbWVyOiAxMDxicj4KCQlEYXR1bTogMjAxNy0wMy0yMSAxNzoxNzozNzxicj48YnI+CgkJU2VociBnZWVocnRlIERhbWVuIHVuZCBIZXJyZW4sIDxicj4KCQl3aXIgYmVkYW5rZW4gdW5zIGbDvHIgSWhyZW4gQXVmdHJhZyB1bmQgZXJsYXViZW4gdW5zIHdpZSBmb2xndCB6dSBiZXJlY2huZW46PGJyPjxicj4KICAgICAgICA8dGFibGUgd2lkdGg9IjEwMCUiPgogICAgICAgICAgICA8dHI+CiAgICAgICAgICAgICAgICA8dGg+PC90aD4KICAgICAgICAgICAgICAgIDx0aCBhbGlnbj0ibGVmdCI+QmV6ZWljaG51bmc8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+TWVuZ2U8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+RWluemVscHJlaXM8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+U3VtbWU8L3RoPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICAKICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkPjE8L3RkPgogICAgICAgICAgICAgICAgPHRkIGFsaWduPSJsZWZ0Ij4gU2NobmVlaHV0IHNjaHdhcnoKICAgICAgICAgICAgICAgICAgICA8YnI+U3VwZXJmbGF1c2NoaWdlciBTY2huZWVodXQgaW4gc2Nod2FyeiAtIE9uZVNpemUKICAgICAgICAgICAgICAgIDwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjE4LjkwIEVVUjwvdGQ+CiAgICAgICAgICA"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<order_confirmation>
PCFET0NUWVBFIGh0bWw+CjxodG1sPgoJPGhlYWQ+CgkJPHRpdGxlPlJHPC90aXRsZT4KCQk8c3R5bGU+CgkJCgkJYm9keXsKCQlmb250LWZhbWlseTogVmVyZGFuYSwgJ0x1Y2lkYSBTYW5zIFVuaWNvZGUnLCBzYW5zLXNlcmlmOwoJCWZvbnQtc2l6ZToxM3B4OwoJCX0KCQkgCgkJIC5sb2dvewoJCSAgcG9zaXRpb246YWJzb2x1dGU7CgkJICBsZWZ0OjEuNWNtOwoJCSAgdG9wOjEuMGNtOwoJCSB9CgkJCgkJLmFkZHlfZmllbGR7CgkJICBwb3NpdGlvbjphYnNvbHV0ZTsKCQkgIHRvcDo0LjhjbTsKCQkgIGxlZnQ6MS41Y207CgkJICB3aWR0aDo4LjBjbTsKCQkgIGhlaWdodDozLjVjbTsKCQkgIGJhY2tncm91bmQtY29sb3I6I2Y0ZjRmNDsKCQkgfQogICAgICAgICAKCQkuYWRkeV9maWVsZCAuZmlybV9hZGR5ewogICAgICAgICAgICBwYWRkaW5nOiAxMHB4OwogICAgCQlmb250LXNpemU6IDlweDsKCQl9CgkJCgkJLmFkZHlfZmllbGQgLmN1c3RvbWVyX2FkZHkKCQl7CgkJIHBvc2l0aW9uOiBhYnNvbHV0ZTsKCQkgbWFyZ2luLXRvcDogMC4yNWNtOwogICAgICAgICBwYWRkaW5nOiAxMHB4OwoJCSBmb250LXNpemU6IDEycHg7CgkJfQoJCQoJCS5pbmZvX2ZpZWxkewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCWxlZnQ6MTEuNWNtOwoJCXRvcDo0LjhjbTsKCQl3aWR0aDo3LjBjbTsKCQloZWlnaHQ6MS4wY207CiAgICAgICAgICAgICAgIGZvbnQtc2l6ZToxMXB4OwoJCX0KCQkKCQkKCQkub3JkZXJfY29udGVudHsKCQlwb3NpdGlvbjphYnNvbHV0ZTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoxMC41Y207CiAgICAgICAgd2lkdGg6IDYwMHB4OwoJCX0KCQkKCQkKCQkuZm9vdGVyewoJCXBvc2l0aW9uOmFic29sdXRlOwoJCXdpZHRoOjE3LjBjbTsKCQlsZWZ0OjEuNWNtOwoJCXRvcDoyMy4wY207CgkJaGVpZ2h0OjIuMGNtOwpmb250LXNpemU6IDExcHg7CgkJfQoJCQoJCUBtZWRpYSBwcmludHsKCgkJCgkJfQoJCQoJCTwvc3R5bGU+Cgk8L2hlYWQ+CgoJPGJvZHk+CgkJPGRpdiBjbGFzcz0ibG9nbyI+PGltZyBzcmM9Imh0dHA6Ly9uaWljZS1zd2VhdHNoaXJ0LmNvbS9pbWcvbG9nby5wbmciPjwvZGl2PgoJCTxkaXYgY2xhc3M9ImFkZHlfZmllbGQiPgoJCTxkaXYgY2xhc3M9ImZpcm1fYWRkeSI+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPGJyPkVwcGVuZG9yZmVyIFdlZyA2NiwgMjAyNTkgSGFtYnVyZzwvZGl2PgoJCTxkaXYgY2xhc3M9ImN1c3RvbWVyX2FkZHkiPnNsZWVrY29tbWVyY2UgVUc8YnI+SGVyciBrYXZlaCByYWppPGJyPk1heC1CcmF1ZXItQWxsZWUgMjE4PGJyPjIyNzY5IEhhbWJ1cmcgR2VybWFueTwvZGl2PgoJCTwvZGl2PgoJCTxkaXYgY2xhc3M9ImluZm9fZmllbGQiPgoJCTxzdHJvbmc+UnV0aCBLb2JiZSBTYWJyaW5hIExlbnogR2JSPC9zdHJvbmc+PGJyPgogICAgICAgICAgICAgICBFcHBlbmRvcmZlciBXZWcgNjY8YnI+CiAgICAgICAgICAgICAgIDIwMjU5IEhhbWJ1cmc8YnI+CiAgICAgICAgICAgICAgRS1NYWlsOiBuaWljZTJ3ZWFyQGdtYWlsLmNvbTxicj48YnI+CiAgICAgICAgICAgICAgVXN0LUlEOiBERTMwNTc4NDk0NDxicj48YnI+CjxzdHJvbmc+QmFua3ZlcmJpbmR1bmc8L3N0cm9uZz48YnI+Ck5hbWUgZGVyIEJhbms6IEhhbWJ1cmdlciBTcGFya2Fzc2U8YnI+CklCQU46IERFMTYgMjAwNSAwNTUwIDEyMDUgMTQ2MCA3Nzxicj4KQklDOiBIQVNQREVISFhYWDxicj4KS29udG9pbmhhYmVyOiBSdXRoIEtvYmJlIFNhYnJpbmEgTGVuegoJCTwvZGl2PgoJCQoJCTxkaXYgY2xhc3M9Im9yZGVyX2NvbnRlbnQiPgoJCTxoMT5BYnJlY2hudW5nPC9oMT4KUmVjaG51bmdzbnVtbWVyOiAxMDxicj4KCQlEYXR1bTogMjAxNy0wMy0yMSAxNzoxNzozNzxicj48YnI+CgkJU2VociBnZWVocnRlIERhbWVuIHVuZCBIZXJyZW4sIDxicj4KCQl3aXIgYmVkYW5rZW4gdW5zIGbDvHIgSWhyZW4gQXVmdHJhZyB1bmQgZXJsYXViZW4gdW5zIHdpZSBmb2xndCB6dSBiZXJlY2huZW46PGJyPjxicj4KICAgICAgICA8dGFibGUgd2lkdGg9IjEwMCUiPgogICAgICAgICAgICA8dHI+CiAgICAgICAgICAgICAgICA8dGg+PC90aD4KICAgICAgICAgICAgICAgIDx0aCBhbGlnbj0ibGVmdCI+QmV6ZWljaG51bmc8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+TWVuZ2U8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+RWluemVscHJlaXM8L3RoPgogICAgICAgICAgICAgICAgPHRoIGFsaWduPSJyaWdodCI+U3VtbWU8L3RoPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICAKICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkPjE8L3RkPgogICAgICAgICAgICAgICAgPHRkIGFsaWduPSJsZWZ0Ij4gU2NobmVlaHV0IHNjaHdhcnoKICAgICAgICAgICAgICAgICAgICA8YnI+U3VwZXJmbGF1c2NoaWdlciBTY2huZWVodXQgaW4gc2Nod2FyeiAtIE9uZVNpemUKICAgICAgICAgICAgICAgIDwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjE4LjkwIEVVUjwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xOC45MCBFVVI8L3RkPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICAKICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkPjI8L3RkPgogICAgICAgICAgICAgICAgPHRkIGFsaWduPSJsZWZ0Ij5WZXJzYW5ka29zdGVuCiAgICAgICAgICAgICAgICAgICAgPGJyPiAKICAgICAgICAgICAgICAgIDwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij4xPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjAuMDAgRVVSPC90ZD4KICAgICAgICAgICAgICAgIDx0ZCBhbGlnbj0icmlnaHQiPjAuMDAgRVVSPC90ZD4KICAgICAgICAgICAgPC90cj4KICAgICAgICAgICAgCiAgICAgICAgICAgIDx0cj4KICAgICAgICAgICAgICAgIDx0ZCBjb2xzcGFuPSIaWdodDogMXB4OyBib3JkZXI6IDA7IGJvcmRlci1ib3R0b206IDFweCBzb2xpZCAjY2NjY2NjIj48L3RkPgogICAgICAgICAgICA8L3RyPgogICAgICAgICAgICA8dHI+CiAgICAgICAgICAgICAgICA8dGQgY29scC90ZD4KICAgICAgICAgICAgPC90cj4KICAgICAgICAgICAgPHRyPgogICAgICAgICAgICAgICAgPHRkIGNvbHNwYW49IjQiIGFsaWduPSJyaWdodCI+PHN0cm9uZz5TdW1tZTwvc3Ryb25nPjwvdGQ+CiAgICAgICAgICAgICAgICA8dGQgYWxpZ249InJpZ2h0Ij48c3Ryb25nPjE4LjkwIEVVUjwvc3Ryb25nPjwvdGQ+CiAgICAgICAgICAgIDwvdHI+CiAgICAgICAgPC90YWJsZT4KCQk8L2Rpdj4KCQkKCQkKCQk8ZGl2IGNsYXNzPSJmb290ZXIiPgoJCgkJPC9kaXY+CgkJCgkJCgk8L2JvZHk+CjwvaHRtbD4=
</order_confirmation>
Explanation
| order_confirmation | The base64 encoded order confirmation form which is generated using the order confirmation - form the user defined in the backend. |
|---|
get_payment_methods
Delivers all available payment methods that are activated in the backend.
Arguments
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":
{
"public_key":""
}
}
}
<?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>
<attribute name="public_key"></attribute>
</attributes>
</payment_method>
</payment_methods>
Explanation
You receive a list of all available payment methods. Each payment - method contains several fields described below:| id | The id of the payment_method. This id is used to select the payment_method with set_order_details. |
|---|---|
| name | The name of the payment - method. |
| attributes | A 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. You have two special arguments here that can be very useful: success_url and cancel_url where you define how to redirect the user depending on the payment-status. These arguments override the setting in the backend for the corresponding payment_method.
-
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;cmd=_express-checkout&amp;token=EC-255618719P542743Y&amp;cmd=_express-checkout&amp;useraction=commit",
"token":""
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<do_payment>
<method>PayPal</method>
<status>Success</status>
<redirect>https://www.paypal.com/webscr&amp;cmd=_express-checkout&amp;token=EC-46313304JF205524A&amp;cmd=_express-checkout&amp;useraction=commit</redirect>
<token></token>
</do_payment>
Explanation
| method | You see the selected method in the order. |
|---|---|
| status | Determines wether the request was successful or not. |
| redirect | Many 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. |
| token | Some payment - methods require a token which is needed for processing. If the payment_method needs a token you find it here. |
add_delivery_costs
Adds delivery costs to the cart of a valid session.
Arguments
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
| status | A 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
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 "Mu00fctzenLiebe". 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 "SchneeHut"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 "Mu00fctzenLiebe". 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>&lt;p&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&lt;/p&gt;&lt;br&gt;&lt;p&gt;&lt;br&gt;&lt;/p&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;quot;MützenLiebe&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;quot;SchneeHut&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;quot;MützenLiebe&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>
add_coupons
This request adds coupons to the cart if these are valid. Otherwise an errormessage will be returned. These coupons are only attached to the cart and are dynamically calculated. When the checkout request is performed they will be added to the cart permanently.
Arguments
The coupons array is an array like this: [["code1","name1"],["code2","name2"]]
The name you choose will appear in the cart of the order. The name is optional. If you dont specifiy the name, the name of the coupon itself will be used.
All added coupons will appear in the cart - requests.Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='add_coupons' \
-d session=A_VALID_SESSION_CODE \
-d coupons='["code1","name1"]'
Response
{
"object":"add_coupons",
"status":"SUCCESS"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<add_coupons>
<status>SUCCESS</status>
</add_coupons>
create_coupons
This request can be used to create coupons.
Arguments
-
count (int)
The number of coupons you want to create.
-
name (string)
The name of the new coupons.
-
amount (float)
The amount of the corresponding coupons.
-
type (string)
The type of the coupon you want to create. The following values are valid: UNIQUE_NOMINAL, UNIQUE_PERCENTAGE, MULTIPLE_NOMINAL, MULTIPLE_PERCENTAGE.
-
code (string)
The Code you want to be generated. If you dont pass this argument, then a generic code will be generated.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
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_coupons' \
-d count=10 \
-d name='name_new' \
-d amount=10
Response
{
"object": "create_coupons",
"coupons":[
{
"code":"a8wj-roey-2184-8zmh"
}
,
{
"code":"wokg-eq25-t6uj-2w4v"
}
,
{
"code":"3zsw-hh42-e4lt-ax8r"
}
,
{
"code":"58pn-idsm-i7lr-rx52"
}
,
{
"code":"4mc9-8189-vojj-rhhy"
}
,
{
"code":"p7no-qvir-qycm-lt03"
}
,
{
"code":"cqz4-lopt-6hwb-lvae"
}
,
{
"code":"z8t0-tq88-ljiz-6nr6"
}
,
{
"code":"c6b4-jp0b-2kp3-75tb"
}
,
{
"code":"bkup-eg8w-umzr-ivbk"
}
]
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_coupons>
<coupons>
<code>ezxa-ol10-r4xi-ztb4</code>
<code>il85-359j-tk6h-n6so</code>
<code>uwc0-944x-3iv8-33un</code>
<code>ht16-8o7b-ktxb-47es</code>
<code>jaet-r3rt-u0oo-zl3a</code>
<code>d40w-lij1-56rl-aaur</code>
<code>nccc-b0qz-sgeb-6i3u</code>
<code>dq08-cwbe-jvjn-r8ob</code>
<code>73th-rsio-eke9-vnab</code>
<code>sz3p-dkc2-wmlg-ugv1</code>
</coupons>
</create_coupons>
Explanation
| coupons | A section containing the codes just created. |
|---|
get_status
This command will return the status of the server
For simply getting the server - status you can use these command.Arguments
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_status | The status of the server, wether running or stopped. |
|---|---|
| data_status | Indicated wether the data for debiting is complete or not. |
| products_count | Count of products. |
| contents_count | Count of contents. |
create_channel
This command is used to create a new channel.
Arguments
-
name (string)
The name of your channel.
-
description (string)
A description for your channel.
-
shop_active (int)
This value describes wether the channel is active or not. 1 for active and 0 for not active.
-
server_output (string)
Define which server output you want to have for this channel (json or xml).
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='1233321fasd7bmjR4Vmz' \
-d request='create_channel' \
-d name='channel_name' \
-d description='channel description' \
-d shop_active=1 \
-d server_output='json'
Response
{
"object":"create_channel",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_channel>
<status>success</status>
</create_channel>
application_api_call
This request is used to send api-requests to installed applications.
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d request='application_api_call' \
-d application='brevo' \
-d app_request='send_mail' \
-d args='{"sender_mail:"test@test.de'}
You have to make sure that the application has the ability to communicate with sleekshop. Therefore it is necessary that application has implemented the api - endpoint with correct url. The correct url is the installation - base with the /srv/service/ extension. That means that if your installation route is: appdomain.de/install.php
then the endpoint url has to be: appdomain.de/srv/service/
Response
{
"object": "application_api_call",
"status": "success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<application_api_call>
<status>success</status>
</application_api_call>
create_warehouse_entity
This request can be used to create warehouse entities. 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.
-
id_manufacturer (int)
The id of the corresponding manufacturer.
-
attributes (json-array)
A json - array with all attributes you want to set the value.
-
metadata (json-array)
A json - array with all metadata you want to set.
-
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"}}
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
- weight
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_warehouse_entity' \
-d class='wh_entity' \
-d name='name_new' \
-d id_manufacturer=1 \
-d attributes='{"de_DE":{"name":"Test"}}' \
-d metadata='{"element_number":"123321"}'
Response
{
"object":"create_warehouse_entity",
"id":"162"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_warehouse_entity>
<id>161</id>
</create_warehouse_entity>
Explanation
| id | The id of the product just created. |
|---|
update_warehouse_entity
This request can be used to update warehouse entities. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
-
id_warehouse_entity (int)
The id of the warehouse - entity you want to update.
-
name (string)
The name of the new product.
-
id_manufacturer (int)
The id of the corresponding manufacturer.
-
attributes (json-array)
A json - array with all attributes you want to set the value.
-
metadata (json-array)
A json - array with all metadata you want to set.
-
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"}}
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
- weight
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_warehouse_entity' \
-d id_warehouse_entity=123 \
-d name='name_new' \
-d id_manufacturer=1 \
-d attributes='{"de_DE":{"name":"Test"}}' \
-d metadata='{"element_number":"123321"}'
Response
{
"object":"update_warehouse_entity",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<update_warehouse_entity>
<status>success</status>
</update_warehouse_entity>
Explanation
| id | The id of the product just created. |
|---|
delete_warehouse_entity
This request can be used to delete warehouse entities. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
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='delete_warehouse_entity' \
-d id_warehouse_entity=123 \
Response
{
"object":"delete_warehouse_entity",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<delete_warehouse_entity>
<status>success</status>
</delete_warehouse_entity>
Explanation
| status | The status of the operation. |
|---|
inventory_place
This request can be used to place warehouse entities. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
-
storage (string)
The storage name you want to place the entity.
-
element_number (string)
The element number of the entity you want to place.
-
quantity (int)
How many items you want to place?
-
note (string)
A note you want to add to your checkin.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
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='inventory_place' \
-d storage="storage123" \
-d element_number='123asd' \
-d quantity=1 \
-d note='my_note' \
Response
{
"object":"inventory_place",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<inventory_place>
<status>success</status>
</inventory_place>
Explanation
| status | The status of the operation. |
|---|
inventory_take
This request can be used to take warehouse entities. The request will be executed as long as an error occurs. In this case the error will be returned.
Arguments
-
storage (string)
The storage name you want to the the entity from.
-
element_number (string)
The element number of the entity you want to take.
-
quantity (int)
How many items you want to take?
-
note (string)
A note you want to add to your checkout.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
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='inventory_take' \
-d storage="storage123" \
-d element_number='123asd' \
-d quantity=1 \
-d note='my_note' \
Response
{
"object":"inventory_take",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<inventory_take>
<status>success</status>
</inventory_take>
Explanation
| status | The status of the operation. |
|---|
add_binding
Binds a product to a warehouse_entity determined by its element_number.
Arguments
-
id_product (int)
The id of the product you want to add a binding to.
-
element_number (string)
The element number of the entity you want to bind.
-
quantity (int)
How many items you want to bind?
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
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='add_binding' \
-d id_product=10 \
-d element_number='123asd' \
-d quantity=1 \
Response
{
"object":"add_binding",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<add_binding>
<status>success</status>
</add_binding>
Explanation
| status | The status of the operation. |
|---|
delete_binding
Deletes an existing binding.
Arguments
-
id_product (int)
The id of the product you want to add a binding to.
-
element_number (string)
The element number of the entity you want to bind.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
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='delete_binding' \
-d id_product=10 \
-d element_number='123asd' \
Response
{
"object":"delete_binding",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<delete_binding>
<status>success</status>
</delete_binding>
Explanation
| status | The status of the operation. |
|---|
create_webhook
This request is used to create a webhook.
Create one of the following events to create a new webhook:
- ORDER_CREATE
- ORDER_DELIVERY_CHANGE
- SEND_MESSAGE_TO_USER
- SEND_NEW_PASSWD_TO_USER
- WEBHOOK_CONTENT_UPDATE
- WEBHOOK_CATEGORY_UPDATE
- ORDER_PAYMENT_CHANGE
Be aware that you use only uppercase letters, numbers and underscore as valid characters for naming your webhook.
Arguments
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='sdasdasdasdasd' \
-d request='create_webhook' \
-d name='MY_NEW_WEBHOOK' \
-d event='ORDER_CREATE'
Response
{
"object":"create_webhook",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<create_webhook>
<status>success</status>
</create_webhook>
update_webhook
This request is used to update webhook settings like url and parameter.
There are different webhooks available which can be activated and updated via backend. Sometimes it can be very useful to update these webhooks via api.
Arguments
-
name (string)
The name of the webhook you want to update
-
url (string)
The url you want to set.
-
parameter (string)
The parameter you want to set for the webhook.
-
licence_username (string)
Your licence - username.
-
licence_password (string)
Your licence - password.
-
licence_secret_key (string)
Your licence - secret - key.
Request
curl https://demo.sleekshop.net/srv/service/ \
-d licence_username='demo_NBSqhrcrhMci15Ir9UWI' \
-d licence_password='s9vmrbwT23B7bmjR4Vmz' \
-d licence_secret_key='asddsaqweqwewqe' \
-d request='update_webhook' \
-d name='WEBHOOK_CONTENT_UPDATE' \
-d url='https://www.sleekshop.io' \
-d parameter='1'
Response
{
"object":"update_webhook",
"status":"success"
}
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<update_webhook>
<status>success</status>
</update_webhook>