Articles

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 all articles

GET https://YOUT_SHOP_URL/rest/v1/articles

Get all articles.

Query Parameters

Name
Type
Description

limit

number

number of results to return (standard: 100)

order

string

order direction, asc or desc

order_by

string

field to order by, e.g. oxartnum

page

number

page number

filter

string

filter[]=oxactive|=|1&filter[]=oxtitle|like|kite

{
    "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,
    ...
}

For more information about filters see Filters.

get one article

GET https://YOUR_SHOP_URL/rest/v1/articles/{id}

Get one article by id (oxid).

Path Parameters

Name
Type
Description

id

string

oxid

create new article

POST https://YOUR_SHOP_URL/rest/v1/articles

Create an new article.

Request Body

Name
Type
Description

string

data as JSON

update article

PUT https://YOUR_SHOP_URL/rest/v1/articles/{id}

Update one article by id (oxid).

Path Parameters

Name
Type
Description

id

string

oxid

Request Body

Name
Type
Description

string

data as JSON

delete article

DELETE https://YOUR_SHOP_URL/rest/v1/articles/{id}

Delete an article by id (oxid).

Path Parameters

Name
Type
Description

id

string

oxid

Filters

PreviousRoutesNextFilters

Last updated