getProducts

Method returns product list

Usage URL: https://magboss.pl/api/getProducts.json?key=YOURAPIKEY

Query params

(put those in your URL, e.g. ?id=123)

id
integer or integer[]
Internal identifier of product.
More than one value can be specified after comma (,) separator.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of product.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
name
string
Name of product. Words separated by space will be treated as separate search terms.
Example: 'cover' will return all products that contain cover in the name.
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of product. Words separated by space will be treated as separate search terms.","example":"'cover' will return all products that contain cover<\/strong> in the name.","required":false,"children":[]}
pid
string
Manufacturer identifier.
Example: 'Z43' will return all products that contain Z43 in the manufacturer identifier
{"name":"pid","propertyName":"pid","type":{"format":null},"description":"Manufacturer identifier.","example":"'Z43' will return all products that contain Z43<\/strong> in the manufacturer identifier","required":false,"children":[]}
ean
string
European Article Number. You can search by part of the EAN.
Example: '5901234567890' will return all products that contain 5901234567890 in the EAN.
{"name":"ean","propertyName":"ean","type":{"format":null},"description":"European Article Number. You can search by part of the EAN.","example":"'5901234567890' will return all products that contain 5901234567890<\/strong> in the EAN.","required":false,"children":[]}
productcategoryid
integer or integer[]
Identifier of category in which the products are.
More than one value can be specified after comma (,) separator.
{"name":"productcategoryid","propertyName":"productCategoryId","type":{"format":null},"description":"Identifier of category in which the products are.\nMore than one value can be specified after comma (,) separator.","example":null,"required":false,"children":[]}
modified
datetime (YYYY-MM-DD HH:MM:SS)
Return all products modified after the modified date. That is highly recommended when you want to update your local database.
{"name":"modified","propertyName":"modified","type":{"format":"YYYY-MM-DD HH:MM:SS"},"description":"Return all products modified after the modified<\/strong> date. That is highly recommended<\/strong> when you want to update your local database.","example":null,"required":false,"children":[]}
currency
string
Currency symbol.
If not set - API will use currency assigned to your account on your website.
We recommend to always set this parameter to avoid situations where currency gets changed on your website, and you are not aware of it.
Example: Three letters format ie: PLN, EUR, USD.
{"name":"currency","propertyName":"currency","type":{"format":null},"description":"Currency symbol.\nIf not set - API will use currency assigned to your account on your website.\nWe recommend to always set this parameter to avoid situations where currency gets changed on your website, and you are not aware of it.<\/b>","example":"Three letters format ie: PLN, EUR, USD.","required":false,"children":[]}
adult
boolean (1 = true, 0 = false)
Returns only products that are recommended for adults only.
Example: If set to true - only adult content will be returned, if set to false - only non-adult content will be returned.
{"name":"adult","propertyName":"adult","type":{"format":"1 = true, 0 = false"},"description":"Returns only products that are recommended for adults only.","example":"If set to true<\/strong> - only adult content will be returned, if set to false<\/strong> - only non-adult content will be returned.","required":false,"children":[]}
leadtime
integer
Filters products to only show those with leadtime <= provided value.
Example: If leadtime = 0 - only those with 0 are returned, if leadtime = 3 - all products with leadtime between 0 and 3 will be returned.
{"name":"leadtime","propertyName":"leadTime","type":{"format":null},"description":"Filters products to only show those with leadtime <= provided value.","example":"If leadtime = 0 - only those with 0 are returned, if leadtime = 3 - all products with leadtime between 0 and 3 will be returned.","required":false,"children":[]}
lang
string
Language of result. ISO 2 Letter Language Codes ie
Example: en, pl, cs
{"name":"lang","propertyName":"lang","type":{"format":null},"description":"Language of result. ISO 2 Letter Language Codes ie","example":"en, pl, cs","required":false,"children":[]}

id
integer
Internal identifier of product.
{"name":"id","propertyName":"id","type":{"format":null},"description":"Internal identifier of product.","example":null,"required":false,"children":[]}
modified
string
When last modified
{"name":"modified","propertyName":"modified","type":{"format":null},"description":"When last modified","example":null,"required":false,"children":[]}
name
string
Name of product
{"name":"name","propertyName":"name","type":{"format":null},"description":"Name of product","example":null,"required":false,"children":[]}
pid
string
Manufacturer identifier
{"name":"pid","propertyName":"pid","type":{"format":null},"description":"Manufacturer identifier","example":null,"required":false,"children":[]}
ean
string
European Article Number
{"name":"ean","propertyName":"ean","type":{"format":null},"description":"European Article Number","example":null,"required":false,"children":[]}
description
string
Description of product. HTML is possible
{"name":"description","propertyName":"description","type":{"format":null},"description":"Description of product. HTML is possible","example":null,"required":false,"children":[]}
status
integer
0 - published, 1 - suspended, 2 - inactive.
{"name":"status","propertyName":"status","type":{"format":null},"description":"0 - published, 1 - suspended, 2 - inactive.","example":null,"required":false,"children":[]}
allowpriceoffer
integer
0/1 - false/true - shows whether it is possible to place a price offer
{"name":"allowpriceoffer","propertyName":"allowPriceOffer","type":{"format":null},"description":"0\/1 - false\/true - shows whether it is possible to place a price offer","example":null,"required":false,"children":[]}
fkoutletancestor
integer
Only for outlet products - product ID of base, brand new product
{"name":"fkoutletancestor","propertyName":"fkOutletAncestor","type":{"format":null},"description":"Only for outlet products - product ID of base, brand new product","example":null,"required":false,"children":[]}
defect
string
Only for outlet products - reason why product was moved to outlet
{"name":"defect","propertyName":"defect","type":{"format":null},"description":"Only for outlet products - reason why product was moved to outlet","example":null,"required":false,"children":[]}
incomingdays
integer
Estimated number of delivery days - might be negative if some delayed.
{"name":"incomingdays","propertyName":"incomingDays","type":{"format":null},"description":"Estimated<\/b> number of delivery days - might be negative if some delayed.","example":null,"required":false,"children":[]}
userprice
float
Customer net price
{"name":"userprice","propertyName":"userPrice","type":{"format":null},"description":"Customer net price","example":null,"required":false,"children":[]}
userpricegross
float
Customer gross price
{"name":"userpricegross","propertyName":"userPriceGross","type":{"format":null},"description":"Customer gross price","example":null,"required":false,"children":[]}
currency
string
Price currency (ISO 3)
Example: EUR, USD, PLN
{"name":"currency","propertyName":"currency","type":{"format":null},"description":"Price currency (ISO 3)","example":"EUR, USD, PLN","required":false,"children":[]}
promotionenabled
boolean (1 = true, 0 = false)
Shows whether product is currently on promotion
{"name":"promotionenabled","propertyName":"promotionEnabled","type":{"format":"1 = true, 0 = false"},"description":"Shows whether product is currently on promotion","example":null,"required":false,"children":[]}
eol
boolean (1 = true, 0 = false)
Shows whether product is end of life
{"name":"eol","propertyName":"eol","type":{"format":"1 = true, 0 = false"},"description":"Shows whether product is end of life","example":null,"required":false,"children":[]}
qty
float
How many pieces of this product we have in local stock
{"name":"qty","propertyName":"qty","type":{"format":null},"description":"How many pieces of this product we have in local stock","example":null,"required":false,"children":[]}
supplyqty
float
How many pieces of this product we have in
{"name":"supplyqty","propertyName":"supplyQty","type":{"format":null},"description":"How many pieces of this product we have in","example":null,"required":false,"children":[]}
vatrate
float
VAT rate of product
{"name":"vatrate","propertyName":"vatRate","type":{"format":null},"description":"VAT rate of product","example":null,"required":false,"children":[]}
categories
integer[]
Identifiers of categories in which the product is. Product can be in multiple categories. This field only contains final category IDs (leaves).
Same as `productcategoryid` field, but returned as array of strings.
{"name":"categories","propertyName":"categories","type":{"format":null},"description":"Identifiers of categories in which the product is. Product can be in multiple categories. This field only contains final category IDs (leaves). Same as `productcategoryid` field, but returned as array of strings.<\/i>","example":null,"required":false,"children":[]}
categories_full
integer[]
Identifiers of categories in which the product is. Product can be in multiple categories. This field contains all category IDs (leaves + parents).
Same as `productcategoryid_full` field, but returned as array of strings.
{"name":"categories_full","propertyName":"categoriesFull","type":{"format":null},"description":"Identifiers of categories in which the product is. Product can be in multiple categories. This field contains all category IDs (leaves + parents). Same as `productcategoryid_full` field, but returned as array of strings.<\/i>","example":null,"required":false,"children":[]}
images
string[]
File names of pictures. Product can have multiple images.
Same as `pictures` field, but returned as array of strings.
{"name":"images","propertyName":"images","type":{"format":null},"description":"File names of pictures. Product can have multiple images. Same as `pictures` field, but returned as array of strings.<\/i>","example":null,"required":false,"children":[]}
leadtime
integer
Processing time in days
{"name":"leadtime","propertyName":"leadTime","type":{"format":null},"description":"Processing time in days","example":null,"required":false,"children":[]}
productconditionid
integer
Internal identifier of product condition
{"name":"productconditionid","propertyName":"productConditionId","type":{"format":null},"description":"Internal identifier of product condition","example":null,"required":false,"children":[]}
productconditionname
string
Name of product condition
{"name":"productconditionname","propertyName":"productConditionName","type":{"format":null},"description":"Name of product condition","example":null,"required":false,"children":[]}
productunitid
integer
Internal identifier of product unit
{"name":"productunitid","propertyName":"productUnitId","type":{"format":null},"description":"Internal identifier of product unit","example":null,"required":false,"children":[]}
productunitname
string
Name of product measure unit
{"name":"productunitname","propertyName":"productUnitName","type":{"format":null},"description":"Name of product measure unit","example":null,"required":false,"children":[]}
productgroupid
integer
Internal identifier of product group
{"name":"productgroupid","propertyName":"productGroupId","type":{"format":null},"description":"Internal identifier of product group","example":null,"required":false,"children":[]}
productgroupname
string
Name of product group
{"name":"productgroupname","propertyName":"productGroupName","type":{"format":null},"description":"Name of product group","example":null,"required":false,"children":[]}
foradults
boolean (1 = true, 0 = false)
Content recommended for adults only
{"name":"foradults","propertyName":"forAdults","type":{"format":"1 = true, 0 = false"},"description":"Content recommended for adults only","example":null,"required":false,"children":[]}
weight
float
Product net weight (in kg)
{"name":"weight","propertyName":"weight","type":{"format":null},"description":"Product net weight (in kg)","example":null,"required":false,"children":[]}
weightgross
float
Product gross weight (in kg)
{"name":"weightgross","propertyName":"weightGross","type":{"format":null},"description":"Product gross weight (in kg)","example":null,"required":false,"children":[]}
size_x
float
One of product's dimensions (in cm)
{"name":"size_x","propertyName":"sizeX","type":{"format":null},"description":"One of product's dimensions (in cm)","example":null,"required":false,"children":[]}
size_y
float
One of product's dimensions (in cm)
{"name":"size_y","propertyName":"sizeY","type":{"format":null},"description":"One of product's dimensions (in cm)","example":null,"required":false,"children":[]}
size_z
float
One of product's dimensions (in cm)
{"name":"size_z","propertyName":"sizeZ","type":{"format":null},"description":"One of product's dimensions (in cm)","example":null,"required":false,"children":[]}

Example URL: https://magboss.pl/api/getProducts.json?key=YOURAPIKEY&lang=en&id=45356,31534,47990

[
    {
        "id": 45356,
        "modified": "2018-09-25 11:34:32",
        "name": " Adhesive foil battery cover Samsung SM-G930F Galaxy S7 (original)",
        "pid": "GH81-13702A",
        "ean": "",
        "description": "<font color=\"#FF0000\"><b>Original <\/b><\/font>adhesive foil battery cover Samsung SM-G930F Galaxy S7<br>",
        "status": 0,
        "allowpriceoffer": 0,
        "infiniteqty": 0,
        "askforprice": 0,
        "userprice": 22.93,
        "userpricegross": 28.2039,
        "qty": 95,
        "productcategoryid": "2116",
        "pictures": "https://core.magboss.pl\/image.php?name=e5cfb50dfbff4842983dd5be73fafbf6.png",
        "productconditionid": null,
        "productconditionname": null,
        "productunitid": null,
        "productunitname": null,
        "productgroupid": 34,
        "productgroupname": "Foil",
        "weight": 0.005,
        "weightgross": 0.005,
        "isbundle": 0
    },
    {
        "id": 47990,
        "modified": "2018-09-25 11:36:29",
        "name": "SIM tray Samsung SM-J330F Galaxy J3 (2017) Dual SIM - black (original)",
        "pid": "GH61-12704A",
        "ean": null,
        "description": "<body>\r\n\t<style type=\"text\/css\">\r\n\t\t.cs2654AE3A{text-align:left;text-indent:0pt;margin:0pt 0pt 0pt 0pt}\r\n\t\t.cs276FEF83{color:#F00000;font-weight:bold;}\r\n\t\t.csABF95C6F{color:#000000;}\r\n\t\t.csE77A7635{color:#000000;font-weight:bold;}\r\n\t<\/style>\r\n\t<p class=\"cs2654AE3A\"><span class=\"cs276FEF83\">Original <\/span><span class=\"csABF95C6F\">SIM tray Samsung SM-J330F Galaxy J3 (2017) Dual SIM - <\/span><span class=\"csE77A7635\">black <\/span><\/p><\/body>\r\n",
        "status": 0,
        "allowpriceoffer": 0,
        "infiniteqty": 0,
        "askforprice": 0,
        "userprice": 10.03,
        "userpricegross": 12.3369,
        "qty": 4,
        "productcategoryid": "2860",
        "pictures": "https://core.magboss.pl\/image.php?name=157ee8dd994f408382630f888a76edaa.png,https://core.magboss.pl\/image.php?name=39e1cee691094942bd11cf460c15f402.png",
        "productconditionid": 1,
        "productconditionname": "Original new",
        "productunitid": 1,
        "productunitname": "Piece",
        "productgroupid": 35,
        "productgroupname": "Obudowy bez LCD",
        "weight": 0.001,
        "weightgross": 0.001,
        "isbundle": 0
    }
]

Example URL: https://magboss.pl/api/getProducts.xml?key=YOURAPIKEY&lang=en&id=45356,31534,47990

<?xml version="1.0" encoding="utf-8"?>
<root>
	<item>
		<id>45356</id>
		<modified>2018-09-25 11:34:32</modified>
		<name> Adhesive foil battery cover Samsung SM-G930F Galaxy S7 (original)</name>
		<pid>GH81-13702A</pid>
		<ean></ean>
		<description>&lt;font color=&quot;#FF0000&quot;&gt;&lt;b&gt;Original &lt;/b&gt;&lt;/font&gt;adhesive foil battery cover Samsung SM-G930F Galaxy S7&lt;br&gt;</description>
		<status>0</status>
		<allowpriceoffer>0</allowpriceoffer>
		<infiniteqty>0</infiniteqty>
		<askforprice>0</askforprice>
		<userprice>22.93</userprice>
		<userpricegross>28.2039</userpricegross>
		<qty>93</qty>
		<productcategoryid>2116</productcategoryid>
		<pictures>https://core.magboss.pl/image.php?name=e5cfb50dfbff4842983dd5be73fafbf6.png</pictures>
		<productconditionid></productconditionid>
		<productconditionname></productconditionname>
		<productunitid></productunitid>
		<productunitname></productunitname>
		<productgroupid>34</productgroupid>
		<productgroupname>Foil</productgroupname>
		<weight>0.005</weight>
		<weightgross>0.005</weightgross>
		<isbundle>0</isbundle>
	</item>
	<item>
		<id>47990</id>
		<modified>2018-09-25 11:36:29</modified>
		<name>SIM tray Samsung SM-J330F Galaxy J3 (2017) Dual SIM - black (original)</name>
		<pid>GH61-12704A</pid>
		<ean></ean>
		<description>&lt;body&gt;
	&lt;style type=&quot;text/css&quot;&gt;
		.cs2654AE3A{text-align:left;text-indent:0pt;margin:0pt 0pt 0pt 0pt}
		.cs276FEF83{color:#F00000;font-weight:bold;}
		.csABF95C6F{color:#000000;}
		.csE77A7635{color:#000000;font-weight:bold;}
	&lt;/style&gt;
	&lt;p class=&quot;cs2654AE3A&quot;&gt;&lt;span class=&quot;cs276FEF83&quot;&gt;Original &lt;/span&gt;&lt;span class=&quot;csABF95C6F&quot;&gt;SIM tray Samsung SM-J330F Galaxy J3 (2017) Dual SIM - &lt;/span&gt;&lt;span class=&quot;csE77A7635&quot;&gt;black &lt;/span&gt;&lt;/p&gt;&lt;/body&gt;
</description>
		<status>0</status>
		<allowpriceoffer>0</allowpriceoffer>
		<infiniteqty>0</infiniteqty>
		<askforprice>0</askforprice>
		<userprice>10.03</userprice>
		<userpricegross>12.3369</userpricegross>
		<qty>2</qty>
		<productcategoryid>2860</productcategoryid>
		<pictures>https://core.magboss.pl/image.php?name=157ee8dd994f408382630f888a76edaa.png,https://core.magboss.pl/image.php?name=39e1cee691094942bd11cf460c15f402.png</pictures>
		<productconditionid>1</productconditionid>
		<productconditionname>Original new</productconditionname>
		<productunitid>1</productunitid>
		<productunitname>Piece</productunitname>
		<productgroupid>35</productgroupid>
		<productgroupname>Obudowy bez LCD</productgroupname>
		<weight>0.001</weight>
		<weightgross>0.001</weightgross>
		<isbundle>0</isbundle>
	</item>
</root>