Retrieves the article with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
None.
Response Information
Resource Description :
IHttpActionResult
article| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| code |
The Id/Ref of the back office. Used by Embedded entity |
string |
Max length: 50 |
| _parent_id | globally unique identifier | ||
| _replace_id | globally unique identifier | ||
| article_color_id | globally unique identifier | ||
| article_color_code | string | ||
| article_color_name | string | ||
| barcode |
Barcode of the article (fast search) |
string |
Max length: 50 |
| article_category_id |
Foreign key to article category |
globally unique identifier | |
| article_group_1_id |
Foreign key to article_group_1 |
globally unique identifier | |
| article_group_2_id |
Foreign key to article_group_2 |
globally unique identifier | |
| article_group_3_id |
Foreign key to article_group_3 |
globally unique identifier | |
| article_group_4_id |
Foreign key to article_group_4 |
globally unique identifier | |
| article_group_5_id |
Foreign key to article_group_5 |
globally unique identifier | |
| article_group_6_id |
Foreign key to article_group_6 |
globally unique identifier | |
| name |
Name of the article |
string |
Required Max length: 50 |
| description_short |
Description (if exists, otherwhise name will be used) |
string |
Max length: 100 |
| sys_computed_eco_stock |
value of the last eco stock computed |
integer | |
| entered_price |
Standard article price |
decimal number | |
| min_article_quantity |
For Sales : Minimum amount to be ordered |
integer | |
| article_increment |
For Sales : Increment used to order (by 2, by 4 etc) |
integer | |
| lowest_packing_value | integer | ||
| length | decimal number | ||
| width | decimal number | ||
| height | decimal number | ||
| mass | decimal number | ||
| volume | decimal number | ||
| use_serial |
Use serial |
boolean | |
| archived |
Archives an article (cannot be deleted) |
boolean | |
| no_stock |
For Sales : Disables the stock check |
boolean | |
| is_dummy | boolean | ||
| is_travel_fee | boolean | ||
| is_mileage_fee | boolean | ||
| db_unit_of_measure_id_selling | globally unique identifier | ||
| db_unit_of_measure_id_size |
size article unit |
globally unique identifier | |
| db_unit_of_measure_id_mass |
mass article unit |
globally unique identifier | |
| db_unit_of_measure_id_volume |
volume artice unit |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
{
"id": "b9e77ea3-73df-45e3-9863-6b6e41d4c61b",
"code": "sample string 2",
"_parent_id": "2163c6e2-7173-436c-b2f9-7d97f03cdace",
"_replace_id": "c6c20e29-bd26-405c-a7d8-c6889757f899",
"article_color_id": "5094d124-14fa-4102-bdc6-ccf497f4db3b",
"article_color_code": "sample string 6",
"article_color_name": "sample string 7",
"barcode": "sample string 8",
"article_category_id": "cb5224ae-0fdc-47ce-a1be-d259b4cbfa74",
"article_group_1_id": "c41009e5-bd4a-46f3-8a0a-92437fe36fa1",
"article_group_2_id": "80e7b187-51f9-41ed-b78d-da10cd672f3b",
"article_group_3_id": "e50afec0-18fe-4b90-9a82-6537ccf976be",
"article_group_4_id": "94441d9a-9dcc-48b3-a928-650fb0371df5",
"article_group_5_id": "15dbfdba-617a-4b67-bee7-63009b3de003",
"article_group_6_id": "506dc9e3-531a-43a1-86eb-98127cc2977f",
"name": "sample string 16",
"description_short": "sample string 17",
"sys_computed_eco_stock": 18,
"entered_price": 19.0,
"min_article_quantity": 20,
"article_increment": 21,
"lowest_packing_value": 22,
"length": 23.0,
"width": 24.0,
"height": 25.0,
"mass": 26.0,
"volume": 27.0,
"use_serial": true,
"archived": true,
"no_stock": true,
"is_dummy": true,
"is_travel_fee": true,
"is_mileage_fee": true,
"db_unit_of_measure_id_selling": "e93551e6-a4bb-42ac-9a5d-5e3a8b72206b",
"db_unit_of_measure_id_size": "6421aa2f-288c-4b43-9431-e3451ae85252",
"db_unit_of_measure_id_mass": "ec7d761a-5035-48cc-ab79-52e235bee26e",
"db_unit_of_measure_id_volume": "d4d1f43b-41e5-472b-a5c9-6de0dde421a1",
"modified_dateutc": "2026-01-11T21:03:33.9797592+00:00"
}
application/xml, text/xml
<article xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <_parent_id>2163c6e2-7173-436c-b2f9-7d97f03cdace</_parent_id> <_replace_id>c6c20e29-bd26-405c-a7d8-c6889757f899</_replace_id> <archived>true</archived> <article_category_id>cb5224ae-0fdc-47ce-a1be-d259b4cbfa74</article_category_id> <article_color_code>sample string 6</article_color_code> <article_color_id>5094d124-14fa-4102-bdc6-ccf497f4db3b</article_color_id> <article_color_name>sample string 7</article_color_name> <article_group_1_id>c41009e5-bd4a-46f3-8a0a-92437fe36fa1</article_group_1_id> <article_group_2_id>80e7b187-51f9-41ed-b78d-da10cd672f3b</article_group_2_id> <article_group_3_id>e50afec0-18fe-4b90-9a82-6537ccf976be</article_group_3_id> <article_group_4_id>94441d9a-9dcc-48b3-a928-650fb0371df5</article_group_4_id> <article_group_5_id>15dbfdba-617a-4b67-bee7-63009b3de003</article_group_5_id> <article_group_6_id>506dc9e3-531a-43a1-86eb-98127cc2977f</article_group_6_id> <article_increment>21</article_increment> <barcode>sample string 8</barcode> <code>sample string 2</code> <db_unit_of_measure_id_mass>ec7d761a-5035-48cc-ab79-52e235bee26e</db_unit_of_measure_id_mass> <db_unit_of_measure_id_selling>e93551e6-a4bb-42ac-9a5d-5e3a8b72206b</db_unit_of_measure_id_selling> <db_unit_of_measure_id_size>6421aa2f-288c-4b43-9431-e3451ae85252</db_unit_of_measure_id_size> <db_unit_of_measure_id_volume>d4d1f43b-41e5-472b-a5c9-6de0dde421a1</db_unit_of_measure_id_volume> <description_short>sample string 17</description_short> <entered_price>19</entered_price> <height>25</height> <id>b9e77ea3-73df-45e3-9863-6b6e41d4c61b</id> <is_dummy>true</is_dummy> <is_mileage_fee>true</is_mileage_fee> <is_travel_fee>true</is_travel_fee> <length>23</length> <lowest_packing_value>22</lowest_packing_value> <mass>26</mass> <min_article_quantity>20</min_article_quantity> <modified_dateutc>2026-01-11T21:03:33.979Z</modified_dateutc> <name>sample string 16</name> <no_stock>true</no_stock> <sys_computed_eco_stock>18</sys_computed_eco_stock> <use_serial>true</use_serial> <volume>27</volume> <width>24</width> </article>