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 |
| article_category_id |
Foreign key to article category |
globally unique identifier | |
| article_category |
Embedded entity "article_category" when adding/updating article |
article_category | |
| article_category_code |
Embedded entity "article_category" using ERP PK when adding/updating article |
string | |
| article_group_1_id |
Foreign key to article_group_1 |
globally unique identifier | |
| article_group_1_code |
Embedded entity "article_group_1" using ERP PK when adding/updating article |
string | |
| article_group_1 |
Embedded entity "article_group_1" using ERP PK when adding/updating article |
article_group_1 | |
| article_group_2_id |
Foreign key to article_group_2 |
globally unique identifier | |
| article_group_2_code |
Embedded entity "article_group_2" using ERP PK when adding/updating article |
string | |
| article_group_2 |
Embedded entity "article_group_2" using ERP PK when adding/updating article |
article_group_2 | |
| article_group_3_id |
Foreign key to article_group_3 |
globally unique identifier | |
| article_group_3_code |
Embedded entity "article_group_3" using ERP PK when adding/updating article |
string | |
| article_group_3 |
Embedded entity "article_group_3" using ERP PK when adding/updating article |
article_group_3 | |
| article_group_4_id |
Foreign key to article_group_4 |
globally unique identifier | |
| article_group_4_code |
Embedded entity "article_group_4" using ERP PK when adding/updating article |
string | |
| article_group_4 |
Embedded entity "article_group_4" using ERP PK when adding/updating article |
article_group_4 | |
| article_group_5_id |
Foreign key to article_group_5 |
globally unique identifier | |
| article_group_5_code |
Embedded entity "article_group_5" using ERP PK when adding/updating article |
string | |
| article_group_5 |
Embedded entity "article_group_5" using ERP PK when adding/updating article |
article_group_5 | |
| article_group_6_id |
Foreign key to article_group_6 |
globally unique identifier | |
| article_group_6_code |
Embedded entity "article_group_6" using ERP PK when adding/updating article |
string | |
| article_group_6 |
Embedded entity "article_group_6" using ERP PK when adding/updating article |
article_group_6 | |
| physical_stock |
Physical stock from the ERP (used for Eco Stock) |
integer | |
| back_order_client |
Number of pieces reserved for clients (used for Eco Stock) |
integer | |
| back_order_supplier |
Number of pieces that should arrive from the supplier (used for Eco stock if expected delivery is in the past) |
integer | |
| expected_delivery_date_bo_supplier |
Date when the delivery from the supplier should arrive (used for Eco stock) |
date | |
| article_increment |
For Sales : Increment used to order (by 2, by 4 etc) |
integer | |
| min_article_quantity |
For Sales : Minimum amount to be ordered |
integer | |
| entered_price |
Standard article price |
decimal number | |
| cost_price | decimal number | ||
| no_stock |
For Sales : Disables the stock check |
boolean | |
| archived |
Archives an article (cannot be deleted) |
boolean | |
| is_travel_fee |
Indicate that this article will be used to compute the fee based on the car travel time |
boolean | |
| is_mileage_fee |
Indicate that this article will be used to compute the fee based on the distance. |
boolean | |
| code |
The Id/Ref of the back office. Used by Embedded entity |
string |
Max length: 50 |
| name |
Name of the article |
string |
Required Max length: 50 |
| description_short |
Description (if exists, otherwhise name will be used) |
string |
Max length: 100 |
| description_long |
Long description |
string | |
| barcode |
Barcode of the article (fast search) |
string |
Max length: 50 |
| notes |
Notes (remark, details) |
string |
Max length: 255 |
| date_create |
Creation date, auto filled by Now if no value received |
date | |
| date_update |
Update date, auto filled by Now if no value received |
date | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date | |
| article_color_id |
Foreign key to article_color |
globally unique identifier | |
| article_color_code |
Embedded entity "article_color" using ERP PK when adding/updating article |
string | |
| article_color |
Embedded entity "article_color" when adding/updating article |
article_color | |
| warranty_period_nb_months |
warranty_period_nb_months |
integer | |
| use_serial |
use_serial |
boolean | |
| _replace_id |
Foreign key to article that replace the current article |
globally unique identifier | |
| replace_article |
Embedded entity "article" of replace, when adding/updating article |
article | |
| replace_article_code |
Embedded code "article" of replace, when adding/updating article |
string | |
| db_unit_of_measure_id_selling |
Applicable db_unit_of_measure |
globally unique identifier | |
| db_unit_of_measure_code_selling |
Applicable db_unit_of_measure |
string | |
| translations |
List of translation of specific field name |
Collection of translation |
Response Formats
application/json, text/json
{
"id": "7cd59502-355f-47ea-9a2c-3c5812d50d8e",
"article_category_id": "477a438b-b780-45c8-a958-4241e838b767",
"article_category": {
"id": "170e0541-74ad-457b-9da5-0228b0d633e6",
"parent_id": "38ac1539-02ae-47ef-9f06-66b17453c677",
"parent_code": "sample string 3",
"code": "sample string 4",
"name": "sample string 5",
"modified_dateutc": "2023-03-26T03:36:54.0545537+00:00"
},
"article_category_code": "sample string 3",
"article_group_1_id": "c7b19cfe-d839-4a92-8858-2ea93cccc8eb",
"article_group_1_code": "sample string 5",
"article_group_2_id": "1641769f-2a98-4789-b457-cd89b4735c42",
"article_group_2_code": "sample string 7",
"article_group_3_id": "fe128589-8a3e-4945-8fe0-9ba892b608be",
"article_group_3_code": "sample string 9",
"article_group_4_id": "dbf6e04a-85ab-402e-908d-25851a41ab05",
"article_group_4_code": "sample string 11",
"article_group_5_id": "fb51917a-e8da-4998-80ba-3db6b4ebc6a4",
"article_group_5_code": "sample string 13",
"article_group_6_id": "8c4e1ebf-40df-41a9-b67a-44513a402be2",
"article_group_6_code": "sample string 15",
"physical_stock": 16,
"back_order_client": 17,
"back_order_supplier": 18,
"expected_delivery_date_bo_supplier": "2023-03-26T03:36:54.0545537+00:00",
"article_increment": 20,
"min_article_quantity": 21,
"entered_price": 22.0,
"cost_price": 23.1,
"no_stock": true,
"archived": true,
"is_travel_fee": true,
"is_mileage_fee": true,
"code": "sample string 28",
"name": "sample string 29",
"description_short": "sample string 30",
"description_long": "sample string 31",
"barcode": "sample string 32",
"notes": "sample string 33",
"date_create": "2023-03-26T03:36:54.0545537+00:00",
"date_update": "2023-03-26T03:36:54.0545537+00:00",
"modified_dateutc": "2023-03-26T03:36:54.0545537+00:00",
"article_color_id": "f520b0f7-73e5-4d42-bffc-8350a230f242",
"article_color_code": "sample string 38",
"article_color": {
"id": "1b8d0573-47d3-4f04-ad1a-d048c2ac851b",
"name": "sample string 2",
"code": "sample string 3",
"modified_dateutc": "2023-03-26T03:36:54.0545537+00:00"
},
"warranty_period_nb_months": 39,
"use_serial": true,
"_replace_id": "05d69705-f41d-4fc4-b082-8650df508648",
"replace_article_code": "sample string 42",
"db_unit_of_measure_id_selling": "b0b6d7e6-ce91-47a5-a7da-1c13baa82339",
"db_unit_of_measure_code_selling": "sample string 44",
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
]
}