Creates a new article

Request Information

URI Parameters :

None.

Body Parameters :

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

Request Formats :

application/json, text/json

Sample:
{
  "id": "f5e2f270-1a02-40eb-80e9-f9f7fba536ec",
  "article_category_id": "64cbd28c-c95c-460b-a901-8173b49738bb",
  "article_category": {
    "id": "05f9832a-ff96-493a-8234-251eed38b5a4",
    "parent_id": "b6b7e0b2-1414-475d-8983-e8d0d71b182a",
    "parent_code": "sample string 3",
    "code": "sample string 4",
    "name": "sample string 5",
    "modified_dateutc": "2022-12-06T05:14:48.4509215+01:00"
  },
  "article_category_code": "sample string 3",
  "article_group_1_id": "080995f8-d01f-42e0-b1e3-a89330a5bec2",
  "article_group_1_code": "sample string 5",
  "article_group_2_id": "f843b19f-c6d5-453f-8a56-11a82e3c351e",
  "article_group_2_code": "sample string 7",
  "article_group_3_id": "e2acd76b-1895-4c9c-8fc0-9157746b8a69",
  "article_group_3_code": "sample string 9",
  "article_group_4_id": "7caf080d-8126-4f20-89f9-0a09edf87bf4",
  "article_group_4_code": "sample string 11",
  "article_group_5_id": "3c15c219-9331-42b6-8c70-56c09a64ba25",
  "article_group_5_code": "sample string 13",
  "article_group_6_id": "ac31d5ae-d013-4906-8b90-0b80bb9d48c6",
  "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-06T05:14:48.468402+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-06T05:14:48.468402+01:00",
  "date_update": "2022-12-06T05:14:48.468402+01:00",
  "modified_dateutc": "2022-12-06T05:14:48.468402+01:00",
  "article_color_id": "43ee5835-e925-4c71-94df-7ccaa60ddf4e",
  "article_color_code": "sample string 38",
  "article_color": {
    "id": "0329b934-570e-411a-abed-fbb59475494e",
    "name": "sample string 2",
    "code": "sample string 3",
    "modified_dateutc": "2022-12-06T05:14:48.468402+01:00"
  },
  "warranty_period_nb_months": 39,
  "use_serial": true,
  "_replace_id": "0d1a381c-1203-43ad-9237-19a10aa1a9f0",
  "replace_article_code": "sample string 42",
  "db_unit_of_measure_id_selling": "2aee1374-7aa1-4a6a-94e5-98b6782346d3",
  "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"
    }
  ]
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.