Retrieves all the articles

Request Information

URI Parameters :

None.

Body Parameters :

None.

Response Information

Resource Description :

IHttpActionResult

article
NameDescriptionTypeAdditional 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

Sample:
{
  "id": "ec2a4dbc-9725-4ec3-9c31-ff1b5097bfba",
  "article_category_id": "2867e752-b0f4-443d-9551-18599cca8819",
  "article_category": {
    "id": "d063e5fb-4362-41a0-a93c-3877b1709f88",
    "parent_id": "42655666-3606-4d63-b355-c48948ce81f2",
    "parent_code": "sample string 3",
    "code": "sample string 4",
    "name": "sample string 5",
    "modified_dateutc": "2022-12-02T20:47:51.8147237+01:00"
  },
  "article_category_code": "sample string 3",
  "article_group_1_id": "0f9d1a4d-583c-4880-8a87-229a0562979f",
  "article_group_1_code": "sample string 5",
  "article_group_2_id": "ef653755-21d0-48f2-a9c4-835c5bc71f12",
  "article_group_2_code": "sample string 7",
  "article_group_3_id": "df38398d-d6ae-4bc9-bd71-0a3a6a8707f6",
  "article_group_3_code": "sample string 9",
  "article_group_4_id": "a7ec4f38-2daf-4d3e-b6a0-806807f1e034",
  "article_group_4_code": "sample string 11",
  "article_group_5_id": "c29c213e-88d7-46e2-b9f5-4bd166abc191",
  "article_group_5_code": "sample string 13",
  "article_group_6_id": "b6af4a73-eb61-4dc5-9308-29f70b8f399f",
  "article_group_6_code": "sample string 15",
  "physical_stock": 16,
  "back_order_client": 17,
  "back_order_supplier": 18,
  "expected_delivery_date_bo_supplier": "2022-12-02T20:47:51.8147237+01: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": "2022-12-02T20:47:51.8147237+01:00",
  "date_update": "2022-12-02T20:47:51.8147237+01:00",
  "modified_dateutc": "2022-12-02T20:47:51.8147237+01:00",
  "article_color_id": "a180900a-86aa-4a27-8fd1-f7954a525e3f",
  "article_color_code": "sample string 38",
  "article_color": {
    "id": "e3bb6baf-226e-4718-8479-fcd1d53bfbbc",
    "name": "sample string 2",
    "code": "sample string 3",
    "modified_dateutc": "2022-12-02T20:47:51.8147237+01:00"
  },
  "warranty_period_nb_months": 39,
  "use_serial": true,
  "_replace_id": "639021de-d2e0-4b35-a5e6-41055ec7598f",
  "replace_article_code": "sample string 42",
  "db_unit_of_measure_id_selling": "95f48d7a-6d32-4c46-b18b-b5109f2dab61",
  "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"
    }
  ]
}