# Articles

{% hint style="success" %}
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](/oxid-rest-api/getting-started/installation.md#installation-within-oxid). 
{% endhint %}

## get all articles

<mark style="color:blue;">`GET`</mark> `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 |

{% tabs %}
{% tab title="200 " %}

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

{% endtab %}

{% tab title="404 " %}

```javascript
No artcicles found
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
For more information about filters see [Filters](/oxid-rest-api/routes-1/filters.md#filter-format).
{% endhint %}

## get one article

<mark style="color:blue;">`GET`</mark> `https://YOUR_SHOP_URL/rest/v1/articles/{id}`

Get one article by id (oxid).

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | string | oxid        |

{% tabs %}
{% tab title="200 " %}

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

{% endtab %}

{% tab title="404 " %}

```javascript
Article with {id} not found
```

{% endtab %}
{% endtabs %}

## create new article

<mark style="color:green;">`POST`</mark> `https://YOUR_SHOP_URL/rest/v1/articles`

Create an new article.

#### Request Body

| Name | Type   | Description  |
| ---- | ------ | ------------ |
|      | string | data as JSON |

{% tabs %}
{% tab title="200 " %}

```
{
    "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
}
```

{% endtab %}
{% endtabs %}

## update article

<mark style="color:orange;">`PUT`</mark> `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 |

{% tabs %}
{% tab title="200 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
}
```

{% endtab %}
{% endtabs %}

## delete article

<mark style="color:red;">`DELETE`</mark> `https://YOUR_SHOP_URL/rest/v1/articles/{id}`

Delete an article by id (oxid).

#### Path Parameters

| Name | Type   | Description |
| ---- | ------ | ----------- |
| id   | string | oxid        |

{% tabs %}
{% tab title="200 " %}

```
Article with id {id} deleted successfully
```

{% endtab %}
{% endtabs %}

{% content-ref url="/pages/-LQuWeHLz8vP3brtd\_my" %}
[Filters](/oxid-rest-api/routes-1/filters.md)
{% endcontent-ref %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.oxid-projects.com/oxid-rest-api/routes-1/routes/articles.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.