Import parameters

Directory

/data/item-groups

Files reference

  • filename : header

  • filename-levels : group levels

  • filename-values : group values

Other parameters

Import mode

Imports can be done with "full" or "update" mode.

  • Full mode : All entities in the file but not in the target application are created. All entities present in the target application but not in the file are deleted. The others are updated.

  • Update mode : same as "full" mode except that the entities present in the target application but not in the file are not deleted.

Result specification

When the import is done, a file named itemgrouplinks will be created to the import item folder. This file is required for CSV import of items.

Files content

Data structure

Field Column Data type Required Business rules

Code

code

String

X

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

Company code

companyCode

String

X

2 characters max

Establishment code

establishmentCode

String

2 characters max

Label

label

String

X

50 characters max

Description

description

String

500 characters max

Validity end date

validityEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ Set a passed date to make the entity inactive.

If an item group is reserved at an establishment, it is not possible to change this after, even to change the establishment.

Example

code;companyCode;establishmentCode;label;validityEndDate
01;01;;Summer;
02;01;;Winter;2020-05-28T12:00:00Z

Levels

Data structure

Field Column Data type Required Business rules

Code

groupCode

String

X

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

Company code

companyCode

String

X

2 characters max

Label

label

String

X

50 characters max

Level

level

Integer

X

Example

groupCode;companyCode;label;level
01;01;Items;0
01;01;Food type;1
01;01;Food type;2
02;01;Items;0
02;01;Food type;1
02;01;Food type;2

Values

Data structure

Field Column Data type Required Business rules

Code

groupCode

String

X

10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

Company code

companyCode

String

X

2 characters max

Label

label

String

X

50 characters max

Level

level

Integer

X

Value

value

String

X

20 characters max, if level is "0" then the value is a item code

Parent

upperLevelValue

String

20 characters max

French label

labelFr

String

50 characters max

English label

labelEn

String

50 characters max

Spanish label

labelEs

String

50 characters max

Portuguese label

labelPt

String

50 characters max

Example

groupCode;companyCode;label;level;value;upperLevelValue;labelFr;labelEn;labelEs;labelPt
01;01;Item 1;0;VAL0;POTATOES;Article;Item;Item;Item
01;01;Item 2;0;VAL1;APPLES;Article;Item;Item;Item
01;01;Item 3;0;VAL2;TOMATOES;Article;Item;Item;Item
01;01;Item 4;0;VAL3;PEARS;Article;Item;Item;Item
01;01;Potatoes;1;POTATOES;VEGETABLES;Patates;Potatoes;Potatoes;Potatoes
01;01;Tomatoes;1;TOMATOES;VEGETABLES;Tomates;Tomatoes;Tomatoes;Tomatoes
01;01;Apples;1;APPLES;FRUITS;Pommes;Apples;Manzanas;Manzanas
01;01;Pears;1;PEARS;FRUITS;Poires;Pears;Pera;Pera
01;01;Vegetables;2;VEGETABLES;;Légumes;Vegetables;;
01;01;Fruits;2;FRUITS;;Fruits;Fruits;;
02;01;Item 1;0;VAL0;POTATOES;Article;Item;;
02;01;Item 2;0;VAL1;APPLES;Article;Item;;
02;01;Item 3;0;VAL2;TOMATOES;Article;Item;;
02;01;Item 4;0;VAL3;PEARS;Article;Item;;
02;01;Potatoes;1;POTATOES;VEGETABLES;;;;
02;01;Tomatoes;1;TOMATOES;VEGETABLES;;;;
02;01;Apples;1;APPLES;FRUITS;;;;
02;01;Pears;1;PEARS;FRUITS;;;;
02;01;Vegetables;2;VEGETABLES;;;;;
02;01;Fruits;2;FRUITS;;;;;