Import parameters

Directory

/data/forecast-events

Files reference

  • filename : header

Other parameters

Context (companyCode and establishmentCode)

The import is set by a context defined by the company code (companyCode) and the establishment code (establishmentCode)

Optional parameters

  • forecastPlans : list of forecast plans

  • replaceUpdatedEvents : true if it’s necessary to replace the updated events (imported events that were later modified by a user)

Files content

Data structure

Field Column Data type Required Business rules

Start date

startDate

String (ISO-8601)

X

YYYY-MM-DDTHH:MM:SSZ

End date

endDate

String (ISO-8601)

X

YYYY-MM-DDTHH:MM:SSZ

Item group code

itemGroupCode

String

10 characters max

Item group level

itemGroupLevel

Integer

Item group value code

itemGroupValueCode

String

20 characters max

Item code

itemCode

String

20 characters max

Customer group code

customerGroupCode

String

10 characters max

Customer group level

customerGroupLevel

Integer

Customer group value code

customerGroupValueCode

String

20 characters max

Customer code

customerCode

String

10 characters max

Value

value

Double

X

Value type

valueType

String

X

Within (QTY, MUL, PER) :

QTY = Quantity
MUL = Multiplier coefficient
PER = Percent

Unit code

unitCode

String

if valueType = QTY

5 characters max

Pollution type

pollutionType

String

Within (DIV, PRM, SPR, HOL, WEA) :

DIV = Miscellaneous event
PRM = Promotion
SPR = Suggested promotion
HOL = Holiday
WEA = Weather effect

Comment

comment

String

1000 characters max

Rules

  • No item selection is not authorized.

  • Item code and item group code/level/value code are not authorized both.

  • No customer selection is authorized only if MUL ou PER value type.

  • Customer code and customer group code/level/value code are not authorized both.

Example

startDate;endDate;itemCode;customerCode;value;valueType;unitCode
2017-03-01T00:00:00Z;2017-03-31T00:00:00Z;015466;LECLERC;250.0;QTY;COL
2017-03-01T00:00:00Z;2017-03-31T00:00:00Z;015466;AUCHAN;10.0;PER;
2017-03-01T00:00:00Z;2017-03-31T00:00:00Z;015466;ITM;1.1;MUL;

Example 2

startDate;endDate;itemCode;customerGroupCode;customerGroupLevel;customerGroupValueCode;value;valueType;unitCode;pollutionType;comment
2017-03-01T00:00:00Z;2017-03-31T00:00:00Z;015466;HIERCLI;2;ITM;250.0;QTY;COL;HOL;Fête nationale