Import parameters

Directory

/data/promotion-offers

Files reference

  • filename : header

  • filename-items : promotion offered items

  • (optional) filename-product-store-displays : product store displays

  • (optional) filename-discounts : promotion discounts

Other parameters

Context (companyCode and establishmentCode)

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

Files content

Data structure

Field Column Data type Required Business rules

Company code

companyCode

String

X

2 characters max

Establishment code

establishmentCode

String

X

2 characters max

Plan code

planCode

String

X

10 characters max

Reference code

referenceCode

String

X

8 characters max

Suffix

suffix

String

X

8 characters max

Promotion offer internal number

nbOffer

Integer

X

Promotion offer label

offerLabel

String

X

50 characters max

Promotion offer state

offerState

String

X

Within (CRE, OFF, CFM, REF, CAN) :

CRE = Not offered
OFF = Offered
CFM = Confirmed
REF = Refused
CAN = Cancelled

Promotion start date

promStartDate

String (ISO-8601)

X

YYYY-MM-DDTHH:MM:SSZ

Promotion end date

promEndDate

String (ISO-8601)

X

YYYY-MM-DDTHH:MM:SSZ

Sales start date

salesStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Sales end date

salesEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Confirmation date

confirmationDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Visit start date

visitStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Visit end date

visitEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Adjustment start date

adjustStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Adjustment end date

adjustEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Customer description

customerDesc

String

50 characters max

Sales person code

salesPersonCode

String

10 characters max

Promotion level

promotionLevel

String

Within (CN, CR, PV, AU) :

CN = National center
CR = Regional center
PV = Sales outlet
AU = None

Comment

comment

String

1000 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

Forecast the promotion offer ?

forecastOffer

Boolean

true if we need to forecast the promotion offer

In promotion duration (minimum number of days between the order date and the shipping date to identify orders under promotional conditions)

inPromotionDuration

Integer

-1 if it’s not necessary to identify orders under promotion

Example

companyCode;establishmentCode;planCode;referenceCode;suffix;nbOffer;offerLabel;offerState;promStartDate;promEndDate;salesStartDate;salesEndDate;confirmationDate;visitStartDate;visitEndDate;adjustStartDate;adjustEndDate;customerDesc;salesPersonCode;promotionLevel;comment;customerGroupCode;customerGroupLevel;customerGroupValueCode;inPromotionDuration
MM;03;PAC1;AUCHAN;2020;1;PROMO 10% GRATUIT;CRE;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;2017-01-17T00:00:00Z;2017-01-27T00:00:00Z4;2017-01-18T00:00:00Z;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;AUCHAN;EDS;CN;-10%;REGFEL;1;AUCHAN;30
02;03;PAC2;CASINO;2019;2;ANNIVERSAIRE;OFF;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;2017-01-17T00:00:00Z;2017-01-27T00:00:00Z4;2017-01-18T00:00:00Z;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;CASINO;;CR;;REGFEL;2;CASINO;

Example 2

companyCode;establishmentCode;planCode;referenceCode;suffix;nbOffer;offerLabel;offerState;promStartDate;promEndDate;salesStartDate;salesEndDate;confirmationDate;visitStartDate;visitEndDate;customerDesc;salesPersonCode;promotionLevel;comment;customerCode;forecastOffer
MM;03;PAC1;AUCHAN;2020;1;PROMO 10% GRATUIT;CRE;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;2017-01-17T00:00:00Z;2017-01-27T00:00:00Z4;2017-01-18T00:00:00Z;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;AUCHAN;EDS;CN;-10%;01254882;true
02;03;PAC2;CASINO;2019;2;ANNIVERSAIRE;OFF;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;2017-01-17T00:00:00Z;2017-01-27T00:00:00Z4;2017-01-18T00:00:00Z;2017-02-17T00:00:00Z;2017-02-27T00:00:00Z;CASINO;;CR;;01245788;false

Promotion offered items

Data structure

Field Column Data type Required Business rules

Company code

companyCode

String

X

2 characters max

Establishment code

establishmentCode

String

X

2 characters max

Plan code

planCode

String

X

10 characters max

Reference code

referenceCode

String

X

8 characters max

Suffix

suffix

String

X

8 characters max

Promotion offer internal number

nbOffer

Integer

X

Item code

itemCode

String

X

20 characters max

Offered item state

offeredItemState

String

X

Within (OFF, REF) :

OFF = Offered REF = Refused

Customer quantity

customerQuantity

Double

Sales quantity

salesQuantity

Double

Confirmed quantity

confirmedQuantity

Double

Unit code

unitCode

String

5 characters max

Sales amount

salesAmount

Double

Confirmed amount

confirmedAmount

Double

Currency code

currencyCode

String

3 characters max

Item group code

itemGroupCode

String

20 characters max

Additional

additional

Boolean

Comment

comment

String

1000 characters max

Scenario

scenarioCode

String

15 characters max

With NPT

withNPT

Boolean

NPT percent rate

nptPercentRate

Double

NPT forecast quantity

nptForecastQuantity

Double

NPT unit code

nptUnitCode

String

5 characters max

NPT forecast fix amount

nptForecastFixAmount

Double

NPT currency code

nptCurrencyCode

String

3 characters max

NPT consumer price

nptConsumerPrice

Double

NPT consumer price unit code

nptCpUnitCode

String

5 characters max

NPT consumer price currency code

nptCpCurrencyCode

String

3 characters max

NPT discount percent

nptDiscountPercent

Double

NPT discount price

nptDiscountPrice

Double

NPT comment

nptComment

String

1000 characters max

Example

companyCode;establishmentCode;planCode;referenceCode;suffix;nbOffer;itemCode;offeredItemState;customerQuantity;salesQuantity;confirmedQuantity;unitCode;salesAmount;confirmedAmount;currencyCode;itemGroupCode;additional;comment;scenarioCode;withNPT;nptPercentRate;nptForecastQuantity;nptUnitCode;nptForecastFixAmount;nptCurrencyCode;nptConsumerPrice;nptCpUnitCode;nptCpCurrencyCode;nptDiscountPercent;nptDiscountPrice;nptComment
MM;03;PAC1;AUCHAN;2020;1;015466;OFF;0.0;1000.0;500.0;500.0;COL;200.0;200.0;EUR;015466;true;-10%;SCENAR1;true;10.0;1200.0;COL;200.0;EUR;1.255;COL;EUR;10.0;0.0;;
MM;03;PAC1;AUCHAN;2020;1;015787;OFF;0.0;0.0;0.0;COL;0.0;0.0;EUR;015787;false;;;false;0.0;0.0;;0.0;;0.0;;;0.0;0.0;;

Example 2

companyCode;establishmentCode;planCode;referenceCode;suffix;nbOffer;itemCode;offeredItemState
MM;03;PAC1;AUCHAN;2020;1;015466;OFF
MM;03;PAC1;AUCHAN;2020;1;015787;OFF

Product store displays

Data structure

Field Column Data type Required Business rules

Company code

companyCode

String

X

2 characters max

Establishment code

establishmentCode

String

X

2 characters max

Plan code

planCode

String

X

10 characters max

Reference code

referenceCode

String

X

8 characters max

Suffix

suffix

String

X

8 characters max

Promotion offer internal number

nbOffer

Integer

X

Item code

itemCode

String

X

20 characters max

Product store display code

psdCode

String

X

8 characters max

Example

companyCode;establishmentCode;planCode;referenceCode;suffix;nbOffer;itemCode;psdCode
MM;03;PAC1;AUCHAN;2020;1;015466;CATALOG
MM;03;PAC1;AUCHAN;2020;1;015466;GONDOLE

Promotion discounts

Data structure

Field Column Data type Required Business rules

Company code

companyCode

String

X

2 characters max

Establishment code

establishmentCode

String

X

2 characters max

Plan code

planCode

String

X

10 characters max

Reference code

referenceCode

String

X

8 characters max

Suffix

suffix

String

X

8 characters max

Promotion offer internal number

nbOffer

Integer

X

Item code

itemCode

String

X

20 characters max

Discount nature code

discountNatureCode

String

X

8 characters max

Calculation rule

calculationRule

String

X

Within (PERCENT, UNITPRIC, SPECPRIC) :

PERCENT = Percentage
UNITPRIC = Unit price
SPECPRIC = Special price

Calculation value

calculationValue

Double

X

Currency code

currencyCode

String

if calculationRule is UNITPRIC or SPECPRIC

3 characters max

Unit code

unitCode

String

if calculationRule is UNITPRIC or SPECPRIC

5 characters max

Comment

comment

String

1000 characters max

Discount type

discountType

String

X

Within (INV, CP) :

INV = Invoiced
CP = Consumer price (RP)

Example

companyCode;establishmentCode;planCode;referenceCode;suffix;nbOffer;itemCode;discountNatureCode;calculationRule;calculationValue;currencyCode;unitCode;comment;discountType
MM;03;PAC1;AUCHAN;2020;1;015466;PROMO;PERCENT;10.0;;;Sticker promo;INV
MM;03;PAC1;AUCHAN;2020;1;015466;REMFACT;UNITPRIC;1.25;EUR;Kg;;CP

Export parameters

Directory

/data/export/promotion-offers

Files reference

  • filename : header (promotion offers)

  • (optional) filename-plans : promotion plans

  • (optional) filename-promotions : promotions

  • (optional) filename-items : promotion offered items

  • (optional) filename-forecasts : promotion forecasts

  • (optional) filename-product-store-displays : product store displays

  • (optional) filename-discounts : promotion discounts

Other parameters

Context (companyCode and establishmentCode)

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

Optional parameters

  • promotionPlans : list of promotion plans

  • planValidities : list of plan validities within (OUT_OF_DATE, CURRENT, FUTURE)

  • promotionValidities : list of promotion validities within (OUT_OF_DATE, CURRENT, FUTURE)

  • withSold : true if it’s necessary to export sold quantities

  • customerHierarchy : only promotion offers of a customer hierarchy code

  • customerHierarchyLevel : only promotion offers of a customer hierarchy level (for the customer hierarchy code)

  • customerHierarchyValues : only promotion offers of customer hierarchy values (for the customer hierarchy code and the level)

Files content

Header

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Reference code

referenceCode

String

Suffix

suffix

String

Promotion offer internal number

nbOffer

Integer

Promotion offer label

offerLabel

String

Promotion offer state

offerState

String

Within (CRE, OFF, CFM, REF, FOL, CLO, CAN) :

CRE = Not offered
OFF = Offered
CFM = Confirmed
REF = Refused
FOL = Followed up
CLO : Closed
CAN = Cancelled

Forecasted

forecasted

Boolean

true if promotion offer is forecasted

Processed

processed

Boolean

true if promotion offer is processed

Promotion start date

promStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Promotion end date

promEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Forecast start date

forecastStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Forecast end date

forecastEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Sales start date

salesStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Sales end date

salesEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Confirmation date

confirmationDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Visit start date

visitStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Visit end date

visitEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Customer description

customerDesc

String

Customer group code

customerGroupCode

String

only if promotion offer customer selection is a simple hierarchy selection

Customer group level

customerGroupLevel

Integer

only if promotion offer customer selection is a simple hierarchy selection

Customer group value

customerGroupValueCode

String

only if promotion offer customer selection is a simple hierarchy selection

Customer code

customerCode

String

only if promotion offer customer selection is a unique customer code

Sales person code

salesPersonCode

String

Sales person label

salesPersonLabel

String

Comment

comment

String

Promotion level

promotionLevel

String

Within (CN, CR, PV, AU) :

CN = National center
CR = Regional center
PV = Sales outlet
AU = None

Offering date

offeredDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Confirming date

confirmedDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Refusing date

refusedDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Closing date

closedDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Promotion plans

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Plan label

planLabel

String

Plan start date

planStartDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Plan end date

planEndDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Promotions

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Reference code

referenceCode

String

Suffix

suffix

String

Promotion label

promotionLabel

String

Promotion state

promotionState

String

Within (CRE, OFF, CLO, CAN) :

CRE = Not offered
OFF = Offered
CLO : Closed
CAN = Cancelled

Promotion offered items

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Reference code

referenceCode

String

Suffix

suffix

String

Promotion offer internal number

nbOffer

Integer

Item code

itemCode

String

Offered item state

offeredItemState

String

Within (OFF, REF) :

OFF = Offered
REF = Refused

Customer quantity

customerQuantity

Double

Sales quantity

salesQuantity

Double

Confirmed quantity

confirmedQuantity

Double

Forecast quantity

forecastQuantity

Double

Regular sales quantity

regularSalesQuantity

Double

Unit code

unitCode

String

Customer quantity in statistical unit 1

customerQuantityStatUnit1

Double

Sales quantity in statistical unit 1

salesQuantityStatUnit1

Double

Confirmed quantity in statistical unit 1

confirmedQuantityStatUnit1

Double

Forecast quantity in statistical unit 1

forecastQuantityStatUnit1

Double

Regular sales quantity in statistical unit 1

regularSalesQuantityStatUnit1

Double

Statistical unit code 1

statUnitCode1

String

Customer quantity in statistical unit 2

customerQuantityStatUnit2

Double

Sales quantity in statistical unit 2

salesQuantityStatUnit2

Double

Confirmed quantity in statistical unit 2

confirmedQuantityStatUnit2

Double

Forecast quantity in statistical unit 2

forecastQuantityStatUnit2

Double

Regular sales quantity in statistical unit 2

regularSalesQuantityStatUnit2

Double

Statistical unit code 2

statUnitCode2

String

Customer quantity in statistical unit 3

customerQuantityStatUnit3

Double

Sales quantity in statistical unit 3

salesQuantityStatUnit3

Double

Confirmed quantity in statistical unit 3

confirmedQuantityStatUnit3

Double

Forecast quantity in statistical unit 3

forecastQuantityStatUnit3

Double

Regular sales quantity in statistical unit 3

regularSalesQuantityStatUnit3

Double

Statistical unit code 3

statUnitCode3

String

Customer quantity in statistical unit 4

customerQuantityStatUnit4

Double

Sales quantity in statistical unit 4

salesQuantityStatUnit4

Double

Confirmed quantity in statistical unit 4

confirmedQuantityStatUnit4

Double

Forecast quantity in statistical unit 4

forecastQuantityStatUnit4

Double

Regular sales quantity in statistical unit 4

regularSalesQuantityStatUnit4

Double

Statistical unit code 4

statUnitCode4

String

Sales amount

salesAmount

Double

Confirmed amount

confirmedAmount

Double

Forecast amount

forecastAmount

Double

Currency code

currencyCode

String

Item group code

itemGroupCode

String

Additional

additional

Boolean

Strictly promotion item

strictlyPromotionItem

Boolean

true if item is sold only in promotion and cannibalize a standard item

Comment

comment

String

With NPT

withNPT

Boolean

NPT percent rate

nptPercentRate

Double

NPT forecast quantity

nptForecastQuantity

Double

NPT forecast fix amount

nptForecastFixAmount

Double

NPT consumer price

nptConsumerPrice

Double

NPT discount percent

nptDiscountPercent

Double

NPT discount price

nptDiscountPrice

Double

NPT comment

nptComment

String

Promotion offer forecasts

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Reference code

referenceCode

String

Suffix

suffix

String

Promotion offer internal number

nbOffer

Integer

Item code

itemCode

String

Forecast period start date

startDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Forecast period end date

endDate

String (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

Quantity

quantity

Double

Computed quantity

computedQuantity

Double

Regular sales quantity

regularSalesQuantity

Double

Closing regular sales quantity

closingRegularSalesQuantity

Double

Standard item forecast quantity

standardItemForecastQuantity

Double

Standard item sold quantity

standardItemSoldQuantity

Double

only if withSold = true

Sold quantity

soldQuantity

Double

only if withSold = true

Sold under promotion quantity

soldUnderPromotionQuantity

Double

only if withSold = true

Unit code

unitCode

String

Quantity in statistical unit 1

quantityStatUnit1

Double

Computed quantity in statistical unit 1

computedQuantityStatUnit1

Double

Regular sales quantity in statistical unit 1

regularSalesQuantityStatUnit1

Double

Closing regular sales quantity in statistical unit 1

closingRegularSalesQuantityStatUnit1

Double

Standard item forecast quantity in statistical unit 1

standardItemForecastQuantityStatUnit1

Double

Standard item sold quantity in statistical unit 1

standardItemSoldQuantityStatUnit1

Double

only if withSold = true

Sold quantity in statistical unit 1

soldQuantityStatUnit1

Double

only if withSold = true

Sold under promotion quantity in statistical unit 1

soldUnderPromotionQuantityStatUnit1

Double

only if withSold = true

Statistical unit code 1

statUnitCode1

String

Quantity in statistical unit 2

quantityStatUnit2

Double

Computed quantity in statistical unit 2

computedQuantityStatUnit2

Double

Regular sales quantity in statistical unit 2

regularSalesQuantityStatUnit2

Double

Closing regular sales quantity in statistical unit 2

closingRegularSalesQuantityStatUnit2

Double

Standard item forecast quantity in statistical unit 2

standardItemForecastQuantityStatUnit2

Double

Standard item sold quantity in statistical unit 2

standardItemSoldQuantityStatUnit2

Double

only if withSold = true

Sold quantity in statistical unit 2

soldQuantityStatUnit2

Double

only if withSold = true

Sold under promotion quantity in statistical unit 2

soldUnderPromotionQuantityStatUnit2

Double

only if withSold = true

Statistical unit code 2

statUnitCode2

String

Quantity in statistical unit 3

quantityStatUnit3

Double

Computed quantity in statistical unit 3

computedQuantityStatUnit3

Double

Regular sales quantity in statistical unit 3

regularSalesQuantityStatUnit3

Double

Closing regular sales quantity in statistical unit 3

closingRegularSalesQuantityStatUnit3

Double

Standard item forecast quantity in statistical unit 3

standardItemForecastQuantityStatUnit3

Double

Standard item sold quantity in statistical unit 3

standardItemSoldQuantityStatUnit3

Double

only if withSold = true

Sold quantity in statistical unit 3

soldQuantityStatUnit3

Double

only if withSold = true

Sold under promotion quantity in statistical unit 3

soldUnderPromotionQuantityStatUnit3

Double

only if withSold = true

Statistical unit code 3

statUnitCode3

String

Quantity in statistical unit 4

quantityStatUnit4

Double

Computed quantity in statistical unit 4

computedQuantityStatUnit4

Double

Regular sales quantity in statistical unit 4

regularSalesQuantityStatUnit4

Double

Closing regular sales quantity in statistical unit 4

closingRegularSalesQuantityStatUnit4

Double

Standard item forecast quantity in statistical unit 4

standardItemForecastQuantityStatUnit4

Double

Standard item sold quantity in statistical unit 4

standardItemSoldQuantityStatUnit4

Double

only if withSold = true

Sold quantity in statistical unit 4

soldQuantityStatUnit4

Double

only if withSold = true

Sold under promotion quantity in statistical unit 4

soldUnderPromotionQuantityStatUnit4

Double

only if withSold = true

Statistical unit code 4

statUnitCode4

String

Amount

amount

Double

Currency code

currencyCode

String

Product store displays

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Reference code

referenceCode

String

Suffix

suffix

String

Promotion offer internal number

nbOffer

Integer

Item code

itemCode

String

Product store display code

psdCode

String

Promotion discounts

Data structure

Field Column Data type Business rules

Company code

companyCode

String

Establishment code

establishmentCode

String

Plan code

planCode

String

Reference code

referenceCode

String

Suffix

suffix

String

Promotion offer internal number

nbOffer

Integer

Item code

itemCode

String

Discount nature code

discountNatureCode

String

Calculation rule

calculationRule

String

Within (PERCENT, UNITPRIC, SPECPRIC) :

PERCENT = Percentage
UNITPRIC = Unit price
SPECPRIC = Special price

Calculation value

calculationValue

Double

Currency code

currencyCode

String

if calculationRule is UNITPRIC or SPECPRIC

Unit code

unitCode

String

if calculationRule is UNITPRIC or SPECPRIC

Comment

comment

String

Discount type

discountType

String

Within (INV, CP) :

INV = Invoiced
CP = Consumer price (RP)