Articles

Last updated 4 months ago

Add /rest/v1/object/articles into your request to get oxid objects and using oxid functions like save(), update() and delete(). For more infos see Installation.

get
get all articles

https://YOUT_SHOP_URL
/rest/v1/articles
Get all articles.
Request
Response
Query Parameters
limit
optional
number
number of results to return (standard: 100)
order
optional
string
order direction, asc or desc
order_by
optional
string
field to order by, e.g. oxartnum
page
optional
number
page number
filter
optional
string
filter[]=oxactive|=|1&filter[]=oxtitle|like|kite
200: OK
{
"OXID": "05848170643ab0deb9914566391c0c63",
"OXSHOPID": 1,
"OXPARENTID": "",
"OXACTIVE": 1,
"OXHIDDEN": 0,
"OXACTIVEFROM": "0000-00-00 00:00:00",
"OXACTIVETO": "0000-00-00 00:00:00",
"OXARTNUM": "1402",
"OXEAN": "",
"OXDISTEAN": "",
"OXMPN": "",
"OXTITLE": "Trapez ION MADTRIXX",
"OXSHORTDESC": "Neues Freestyle Trapez mit einer schlank geschnittenen Outline",
"OXPRICE": 159,
...
},
{
"OXID": "0584e8b766a4de2177f9ed11d1587f55",
"OXSHOPID": 1,
"OXPARENTID": "",
"OXACTIVE": 1,
"OXHIDDEN": 0,
"OXACTIVEFROM": "0000-00-00 00:00:00",
"OXACTIVETO": "0000-00-00 00:00:00",
"OXARTNUM": "1501",
"OXEAN": "",
"OXDISTEAN": "",
"OXMPN": "",
"OXTITLE": "Klebeband DACRON KITEFIX",
"OXSHORTDESC": "Ideal für kleine Reparaturen am Kite",
"OXPRICE": 7.99,
...
}
404: Not Found
No artcicles found

For more information about filters see Filters.

get
get one article

https://YOUR_SHOP_URL
/rest/v1/articles/{id}
Get one article by id (oxid).
Request
Response
Path Parameters
id
required
string
oxid
200: OK
{
"OXID": "05848170643ab0deb9914566391c0c63",
"OXSHOPID": 1,
"OXPARENTID": "",
"OXACTIVE": 1,
"OXHIDDEN": 0,
"OXACTIVEFROM": "0000-00-00 00:00:00",
"OXACTIVETO": "0000-00-00 00:00:00",
"OXARTNUM": "1402",
"OXEAN": "",
"OXDISTEAN": "",
"OXMPN": "",
"OXTITLE": "Trapez ION MADTRIXX",
"OXSHORTDESC": "Neues Freestyle Trapez mit einer schlank geschnittenen Outline",
"OXPRICE": 159,
...
}
404: Not Found
Article with {id} not found

post
create new article

https://YOUR_SHOP_URL
/rest/v1/articles
Create an new article.
Request
Response
Body Parameters
required
string
data as JSON
200: OK
{
"OXID": "3f79989d967f47a41b43ea4a3d0e64c9",
"OXSHOPID": 1,
"OXPARENTID": "0584e8b766a4de2177f9ed11d1587f55",
"OXACTIVE": 1,
"OXHIDDEN": 0,
"OXACTIVEFROM": "2018-11-10 09:28:59",
"OXACTIVETO": "2098-11-10 09:28:59",
"OXARTNUM": "400-01h",
"OXEAN": "",
"OXDISTEAN": "",
"OXMPN": "",
"OXTITLE": "",
"OXSHORTDESC": "",
"OXPRICE": 7.99,
"OXBLFIXEDPRICE": 0,
"OXPRICEA": 0,
"OXPRICEB": 0,
"OXPRICEC": 0,
"OXBPRICE": 0,
"OXTPRICE": 0,
"OXUNITNAME": "",
"OXUNITQUANTITY": 0,
"OXEXTURL": "",
"OXURLDESC": "",
"OXURLIMG": "",
"OXVAT": null,
"OXTHUMB": "",
"OXICON": "",
"OXPIC1": "",
"OXPIC2": "",
"OXPIC3": "",
"OXPIC4": "",
"OXPIC5": "",
"OXPIC6": "",
"OXPIC7": "",
"OXPIC8": "",
"OXPIC9": "",
"OXPIC10": "",
"OXPIC11": "",
"OXPIC12": "",
"OXWEIGHT": 0,
"OXSTOCK": 6,
"OXSTOCKFLAG": 1,
"OXSTOCKTEXT": "",
"OXNOSTOCKTEXT": "",
"OXDELIVERY": "2018-11-10",
"OXINSERT": "2010-12-06 00:00:00",
"OXTIMESTAMP": "2017-12-21 11:27:11",
"OXLENGTH": 0,
"OXWIDTH": 0,
"OXHEIGHT": 0,
"OXFILE": "",
"OXSEARCHKEYS": "",
"OXTEMPLATE": "",
"OXQUESTIONEMAIL": "",
"OXISSEARCH": 0,
"OXISCONFIGURABLE": 0,
"OXVARNAME": "",
"OXVARSTOCK": 0,
"OXVARCOUNT": 0,
"OXVARSELECT": "weiß",
"OXVARMINPRICE": 0,
"OXVARMAXPRICE": 0,
"OXVARNAME_1": "",
"OXVARSELECT_1": "white",
"OXVARNAME_2": "",
"OXVARSELECT_2": "",
"OXVARNAME_3": "",
"OXVARSELECT_3": "",
"OXTITLE_1": "",
"OXSHORTDESC_1": "",
"OXURLDESC_1": "",
"OXSEARCHKEYS_1": "",
"OXTITLE_2": "",
"OXSHORTDESC_2": "",
"OXURLDESC_2": "",
"OXSEARCHKEYS_2": "",
"OXTITLE_3": "",
"OXSHORTDESC_3": "",
"OXURLDESC_3": "",
"OXSEARCHKEYS_3": "",
"OXBUNDLEID": "",
"OXFOLDER": "",
"OXSUBCLASS": "oxarticle",
"OXSTOCKTEXT_1": "",
"OXSTOCKTEXT_2": "",
"OXSTOCKTEXT_3": "",
"OXNOSTOCKTEXT_1": "",
"OXNOSTOCKTEXT_2": "",
"OXNOSTOCKTEXT_3": "",
"OXSORT": 0,
"OXSOLDAMOUNT": 0,
"OXNONMATERIAL": 0,
"OXFREESHIPPING": 0,
"OXREMINDACTIVE": 0,
"OXREMINDAMOUNT": 0,
"OXAMITEMID": "",
"OXAMTASKID": "",
"OXVENDORID": "",
"OXMANUFACTURERID": "",
"OXSKIPDISCOUNTS": 0,
"OXRATING": 0,
"OXRATINGCNT": 0,
"OXMINDELTIME": 1,
"OXMAXDELTIME": 3,
"OXDELTIMEUNIT": "WEEK",
"OXUPDATEPRICE": 0,
"OXUPDATEPRICEA": 0,
"OXUPDATEPRICEB": 0,
"OXUPDATEPRICEC": 0,
"OXUPDATEPRICETIME": "2018-11-10 09:28:59",
"OXISDOWNLOADABLE": 0,
"OXSHOWCUSTOMAGREEMENT": 1
}

put
update article

https://YOUR_SHOP_URL
/rest/v1/articles/{id}
Update one article by id (oxid).
Request
Response
Path Parameters
id
required
string
oxid
Body Parameters
required
string
data as JSON
200: OK
Returns the changed article data
{
"OXID": "04c147a4494fcf5766a4074958ab633b",
"OXSHOPID": 1,
"OXPARENTID": "0584e8b766a4de2177f9ed11d1587f55",
"OXACTIVE": 0,
"OXHIDDEN": 1,
"OXACTIVEFROM": "2018-11-10 09:28:59",
"OXACTIVETO": "2098-11-10 09:28:59",
"OXARTNUM": "400-01f",
"OXEAN": "",
"OXDISTEAN": "",
"OXMPN": "",
"OXTITLE": "",
"OXSHORTDESC": "",
"OXPRICE": 7.99,
"OXBLFIXEDPRICE": 0,
"OXPRICEA": 0,
"OXPRICEB": 0,
"OXPRICEC": 0,
"OXBPRICE": 0,
"OXTPRICE": 0,
"OXUNITNAME": "",
"OXUNITQUANTITY": 0,
"OXEXTURL": "",
"OXURLDESC": "",
"OXURLIMG": "",
"OXVAT": null,
"OXTHUMB": "",
"OXICON": "",
"OXPIC1": "",
"OXPIC2": "",
"OXPIC3": "",
"OXPIC4": "",
"OXPIC5": "",
"OXPIC6": "",
"OXPIC7": "",
"OXPIC8": "",
"OXPIC9": "",
"OXPIC10": "",
"OXPIC11": "",
"OXPIC12": "",
"OXWEIGHT": 0,
"OXSTOCK": 6,
"OXSTOCKFLAG": 1,
"OXSTOCKTEXT": "",
"OXNOSTOCKTEXT": "",
"OXDELIVERY": "2018-11-10",
"OXINSERT": "2010-12-06 00:00:00",
"OXTIMESTAMP": "2017-12-21 11:27:11",
"OXLENGTH": 0,
"OXWIDTH": 0,
"OXHEIGHT": 0,
"OXFILE": "",
"OXSEARCHKEYS": "",
"OXTEMPLATE": "",
"OXQUESTIONEMAIL": "",
"OXISSEARCH": 0,
"OXISCONFIGURABLE": 0,
"OXVARNAME": "",
"OXVARSTOCK": 0,
"OXVARCOUNT": 0,
"OXVARSELECT": "weiß",
"OXVARMINPRICE": 0,
"OXVARMAXPRICE": 0,
"OXVARNAME_1": "",
"OXVARSELECT_1": "white",
"OXVARNAME_2": "",
"OXVARSELECT_2": "",
"OXVARNAME_3": "",
"OXVARSELECT_3": "",
"OXTITLE_1": "",
"OXSHORTDESC_1": "",
"OXURLDESC_1": "",
"OXSEARCHKEYS_1": "",
"OXTITLE_2": "",
"OXSHORTDESC_2": "",
"OXURLDESC_2": "",
"OXSEARCHKEYS_2": "",
"OXTITLE_3": "",
"OXSHORTDESC_3": "",
"OXURLDESC_3": "",
"OXSEARCHKEYS_3": "",
"OXBUNDLEID": "",
"OXFOLDER": "",
"OXSUBCLASS": "oxarticle",
"OXSTOCKTEXT_1": "",
"OXSTOCKTEXT_2": "",
"OXSTOCKTEXT_3": "",
"OXNOSTOCKTEXT_1": "",
"OXNOSTOCKTEXT_2": "",
"OXNOSTOCKTEXT_3": "",
"OXSORT": 0,
"OXSOLDAMOUNT": 0,
"OXNONMATERIAL": 0,
"OXFREESHIPPING": 0,
"OXREMINDACTIVE": 0,
"OXREMINDAMOUNT": 0,
"OXAMITEMID": "",
"OXAMTASKID": "",
"OXVENDORID": "",
"OXMANUFACTURERID": "",
"OXSKIPDISCOUNTS": 0,
"OXRATING": 0,
"OXRATINGCNT": 0,
"OXMINDELTIME": 1,
"OXMAXDELTIME": 3,
"OXDELTIMEUNIT": "WEEK",
"OXUPDATEPRICE": 0,
"OXUPDATEPRICEA": 0,
"OXUPDATEPRICEB": 0,
"OXUPDATEPRICEC": 0,
"OXUPDATEPRICETIME": "2018-11-10 09:28:59",
"OXISDOWNLOADABLE": 0,
"OXSHOWCUSTOMAGREEMENT": 1
}

delete
delete article

https://YOUR_SHOP_URL
/rest/v1/articles/{id}
Delete an article by id (oxid).
Request
Response
Path Parameters
id
required
string
oxid
200: OK
Article with id {id} deleted successfully