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 |
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 |
Last updated