Promotion offers

Endpoints

Export entity list

/forecast/companies/{companycode}/establishments/{establishmentcode}/promotion-offers

Parameters

Type Name Description Schema Business rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Query

plans
optional

Promotion plans

list of string

Query

planValidities
optional

Promotion plan validities

list of string

within (OUT_OF_DATE, CURRENT, FUTURE)

Query

budget
optional

True if only budget plans, False if only not budget plans ?

boolean

Query

promotionValidities
optional

Promotion validities

list of string

within (OUT_OF_DATE, CURRENT, FUTURE)

Query

withSold
optional

True if it’s necessary to export sold quantities and amounts ?

boolean

Query

customerHierarchy
optional

Customer hierarchy code

string

Query

customerHierarchyLevel
optional

Customer hierarchy level

integer

Query

customerHierarchyValues
optional

Customer hierarchy values

list of string

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< PromotionOfferExport > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/forecast/companies/{companycode}/establishments/{establishmentcode}/promotion-offers/import

Parameters

Type Name Description Schema Business rules

Path

companyCode
required

Current context company code

string

2 characters max

Path

establishmentCode
required

Current context establishment code

string

2 characters max

Body

body
required

ImportPromotionOfferList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Data structure

PromotionOfferExport

Promotion offer data structure for Get.

Name Description Value Business rules

companyCode
required

Company code

string

2 characters max

establishmentCode
required

Establishment code

string

2 characters max

planCode
required

Plan code

string

10 characters max

referenceCode
required

Reference code

string

8 characters max

suffix
required

Suffix

string

8 characters max

nbOffer
required

Promotion offer internal number

integer

offerLabel
required

Promotion offer label

string

50 characters max

offerState
required

Promotion offer state

string

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

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

promStartDate
required

Promotion start date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

promEndDate
required

Promotion end date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

forecastStartDate
optional

Forecast start date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

forecastEndDate
optional

Forecast end date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

salesStartDate
optional

Sales start date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

salesEndDate
optional

Sales end date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

confirmationDate
optional

Confirmation date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

visitStartDate
optional

Visit start date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

visitEndDate
optional

Visit end date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

customerDesc
optional

Customer description

string

50 characters max

salesPersonCode
optional

Sales person code

string

10 characters max

salesPersonLabel
optional

Sales person label

string

promotionLevel
optional

Promotion level

string

within (CN, CR, PV, AU) :

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

comment
optional

Comment

string

customerGroupCode
optional

Customer group code

string

10 characters max

customerGroupLevel
optional

Customer group level

string

customerGroupValueCode
optional

Customer group value code

string

20 characters max

customerCode
optional

Customer code

string

10 characters max

forecasted
optional

True if promotion offer is forecasted

boolean

processed
optional

True if promotion offer is processed

boolean

offeredDate
optional

Offering date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

confirmedDate
optional

Confirming date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

refusedDate
optional

Refusing date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

closedDate
optional

Closing date

datetime (ISO-8601)

YYYY-MM-DDTHH:MM:SSZ

customerSelection
optional

Customer selection

DeepPyramid

offeredItems
optional

Promotion offered items

OfferedItemExport list

DeepPyramid

Name Description Value Business rules

hierarchyValues
required

Hierarchy values

PyramidValue list

union
required

Union

boolean

PyramidValue

Name Description Value Business rules

hierarchyCode
required

hierarchy code

string

Code $$ if the values are customer codes

level
required

Level

integer

Level 0 if the values are customer codes

values
required

values

list of string

Hierarchy values or customer codes

included
required

Included

boolean

OfferedItemExport

Name Description Value Business rules

itemCode
required

Item code

string

20 characters max

offeredItemState
required

Offered item state

string

within (OFF, REF) :

OFF = Offered REF = Refused

customerQuantity
optional

Customer quantity

double

salesQuantity
optional

Sales quantity

double

confirmedQuantity
optional

Confirmed quantity

double

forecastQuantity
optional

Forecast quantity

double

regularSalesQuantity
optional

Regular sales quantity

double

unitCode
optional

Unit code

string

5 characters max

customerQuantityStatUnit1
optional

Customer quantity in statistical unit 1

double

salesQuantityStatUnit1
optional

Sales quantity in statistical unit 1

double

confirmedQuantityStatUnit1
optional

Confirmed quantity in statistical unit 1

double

forecastQuantityStatUnit1
optional

Forecast quantity in statistical unit 1

double

regularSalesQuantityStatUnit1
optional

Regular sales quantity in statistical unit 1

double

statUnitCode1
optional

Statistical unit code 1

string

5 characters max

customerQuantityStatUnit2
optional

Customer quantity in statistical unit 2

double

salesQuantityStatUnit2
optional

Sales quantity in statistical unit 2

double

confirmedQuantityStatUnit2
optional

Confirmed quantity in statistical unit 2

double

forecastQuantityStatUnit2
optional

Forecast quantity in statistical unit 2

double

regularSalesQuantityStatUnit2
optional

Regular sales quantity in statistical unit 2

double

statUnitCode2
optional

Statistical unit code 2

string

5 characters max

customerQuantityStatUnit3
optional

Customer quantity in statistical unit 3

double

salesQuantityStatUnit3
optional

Sales quantity in statistical unit 3

double

confirmedQuantityStatUnit3
optional

Confirmed quantity in statistical unit 3

double

forecastQuantityStatUnit3
optional

Forecast quantity in statistical unit 3

double

regularSalesQuantityStatUnit3
optional

Regular sales quantity in statistical unit 3

double

statUnitCode3
optional

Statistical unit code 3

string

5 characters max

customerQuantityStatUnit4
optional

Customer quantity in statistical unit 4

double

salesQuantityStatUnit4
optional

Sales quantity in statistical unit 4

double

confirmedQuantityStatUnit4
optional

Confirmed quantity in statistical unit 4

double

forecastQuantityStatUnit4
optional

Forecast quantity in statistical unit 4

double

regularSalesQuantityStatUnit4
optional

Regular sales quantity in statistical unit 4

double

statUnitCode4
optional

Statistical unit code 4

string

5 characters max

salesAmount
optional

Sales amount

double

confirmedAmount
optional

Confirmed amount

double

forecastAmount
optional

Forecast amount

double

currencyCode
optional

Currency code

string

3 characters max

itemGroupCode
optional

Item group code

string

20 characters max

additional
optional

Additional

boolean

strictlyPromotionItem
optional

Strictly promotion item

boolean

comment
optional

Comment

string

withNPT
optional

With NPT

boolean

nptPercentRate
optional

NPT percent rate

double

nptForecastQuantity
optional

NPT forecast quantity

double

nptUnitCode
optional

NPT unit code

string

5 characters max

nptForecastFixAmount
optional

NPT forecast fix amount

double

nptCurrencyCode
optional

NPT currency code

string

3 characters max

nptConsumerPrice
optional

NPT consumer price

double

nptCpUnitCode
optional

NPT consumer price unit code

string

5 characters max

nptCpCurrencyCode
optional

NPT consumer price currency code

string

3 characters max

nptDiscountPercent
optional

NPT discount percent

double

nptDiscountPrice
optional

NPT discount price

double

nptComment
optional

NPT comment

string

regularSalesPlan
optional

Regular sales plan

string

10 characters max

regularSalesLineNumber
optional

Regular sales line number

integer

regularSalesInternalLineNumber
optional

Regular sales internal line number

integer

productStoreDisplays
optional

list

discounts
optional

Discounts

Discount list

forecasts
optional

Forecasts

Forecast list

Forecast

Name Description Value Business rules

startDate
required

Start date

datetime (ISO-8601)

endDate
required

End date

datetime (ISO-8601)

quantity
optional

Quantity

double

computedQuantity
optional

Computed quantity

double

regularSalesQuantity
optional

Regular sales quantity

double

closingRegularSalesQuantity
optional

Closing regular sales quantity

double

standardItemForecastQuantity
optional

Standard item forecast quantity

double

standardItemSoldQuantity
optional

Standard item sold quantity

double

cannibalizationQuantity
optional

Cannibalization quantity

double

unitCode
optional

Unit code

string

5 characters max

quantityStatUnit1
optional

Quantity in statistical unit 1

double

computedQuantityStatUnit1
optional

Computed quantity in statistical unit 1

double

regularSalesQuantityStatUnit1
optional

Regular sales quantity in statistical unit 1

double

closingRegularSalesQuantityStatUnit1
optional

Closing regular sales quantity in statistical unit 1

double

standardItemForecastQuantityStatUnit1
optional

Standard item forecast quantity in statistical unit 1

double

standardItemSoldQuantityStatUnit1
optional

Standard item sold quantity in statistical unit 1

double

cannibalizationQuantityStatUnit1
optional

Cannibalization quantity in statistical unit 1

double

statUnitCode1
optional

Statistical unit code 1

string

5 characters max

quantityStatUnit2
optional

Quantity in statistical unit 2

double

computedQuantityStatUnit2
optional

Computed quantity in statistical unit 2

double

regularSalesQuantityStatUnit2
optional

Regular sales quantity in statistical unit 2

double

closingRegularSalesQuantityStatUnit2
optional

Closing regular sales quantity in statistical unit 2

double

standardItemForecastQuantityStatUnit2
optional

Standard item forecast quantity in statistical unit 2

double

standardItemSoldQuantityStatUnit2
optional

Standard item sold quantity in statistical unit 2

double

cannibalizationQuantityStatUnit2
optional

Cannibalization quantity in statistical unit 2

double

statUnitCode2
optional

Statistical unit code 2

string

5 characters max

quantityStatUnit3
optional

Quantity in statistical unit 3

double

computedQuantityStatUnit3
optional

Computed quantity in statistical unit 3

double

regularSalesQuantityStatUnit3
optional

Regular sales quantity in statistical unit 3

double

closingRegularSalesQuantityStatUnit3
optional

Closing regular sales quantity in statistical unit 3

double

standardItemForecastQuantityStatUnit3
optional

Standard item forecast quantity in statistical unit 3

double

standardItemSoldQuantityStatUnit3
optional

Standard item sold quantity in statistical unit 3

double

cannibalizationQuantityStatUnit3
optional

Cannibalization quantity in statistical unit 3

double

statUnitCode3
optional

Statistical unit code 3

string

5 characters max

quantityStatUnit4
optional

Quantity in statistical unit 4

double

computedQuantityStatUnit4
optional

Computed quantity in statistical unit 4

double

regularSalesQuantityStatUnit4
optional

Regular sales quantity in statistical unit 4

double

closingRegularSalesQuantityStatUnit4
optional

Closing regular sales quantity in statistical unit 4

double

standardItemForecastQuantityStatUnit4
optional

Standard item forecast quantity in statistical unit 4

double

standardItemSoldQuantityStatUnit4
optional

Standard item sold quantity in statistical unit 4

double

cannibalizationQuantityStatUnit4
optional

Cannibalization quantity in statistical unit 4

double

statUnitCode4
optional

Statistical unit code 4

string

5 characters max

amount
optional

Amount

double

currencyCode
optional

Currency code

string

3 characters max

ImportPromotionOfferList

Name Value

callback
optional

string

data
optional

PromotionOffer list

PromotionOffer

Promotion Offer data structure.

Name Description Value Business rules

companyCode
required

Company code

string

2 characters max

establishmentCode
required

Establishment code

string

2 characters max

planCode
required

Plan code

string

10 characters max

referenceCode
required

Reference code

string

8 characters max

suffix
required

Suffix

string

8 characters max

nbOffer
required

Promotion offer internal number

integer

offerLabel
required

Promotion offer label

string

50 characters max

offerState
required

Promotion offer state

string

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

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

promStartDate
required

Promotion start date

datetime (ISO-8601)

promEndDate
required

Promotion end date

datetime (ISO-8601)

salesStartDate
optional

Sales start date

datetime (ISO-8601)

salesEndDate
optional

Sales end date

datetime (ISO-8601)

confirmationDate
optional

Confirmation date

datetime (ISO-8601)

visitStartDate
optional

Visit start date

datetime (ISO-8601)

visitEndDate
optional

Visit end date

datetime (ISO-8601)

adjustStartDate
optional

Adjustment start date

datetime (ISO-8601)

adjustEndDate
optional

Adjustment end date

datetime (ISO-8601)

customerDesc
optional

Customer description

string

50 characters max

salesPersonCode
optional

Sales person code

string

10 characters max

promotionLevel
optional

Promotion level

string

within (CN, CR, PV, AU) :

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

comment
optional

Comment

string

1000 characters max

customerGroupCode
optional

Customer group code

string

10 characters max

customerGroupLevel
optional

Customer group level

integer

customerGroupValueCode
optional

Customer group value code

string

20 characters max

customerCode
optional

Customer code

string

10 characters max

forecastOffer
optional

Forecast the promotion offer ?

boolean

inPromotionDuration
optional

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

integer

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

offeredItems
optional

Promotion offered items

OfferedItem list

OfferedItem

Name Description Value Business rules

itemCode
required

Item code

string

20 characters max

offeredItemState
required

Offered item state

string

within (OFF, REF) :

OFF = Offered
REF = Refused

customerQuantity
optional

Customer quantity

double

salesQuantity
optional

Sales quantity

double

confirmedQuantity
optional

Confirmed quantity

double

unitCode
optional

Unit code

string

5 characters max

salesAmount
optional

Sales amount

double

confirmedAmount
optional

Confirmed amount

double

currencyCode
optional

Currency code

string

3 characters max

itemGroupCode
optional

Item group code

string

20 characters max

additional
optional

Additional

boolean

comment
optional

Comment

string

1000 characters max

scenarioCode
optional

Scenario

string

15 characters max

withNPT
optional

With NPT

boolean

nptPercentRate
optional

NPT percent rate

double

nptForecastQuantity
optional

NPT forecast quantity

double

nptUnitCode
optional

NPT unit code

string

5 characters max

nptForecastFixAmount
optional

NPT forecast fix amount

double

nptCurrencyCode
optional

NPT currency code

string

3 characters max

nptConsumerPrice
optional

NPT consumer price

double

nptCpUnitCode
optional

NPT consumer price unit code

string

5 characters max

nptCpCurrencyCode
optional

NPT consumer price currency code

string

3 characters max

nptDiscountPercent
optional

NPT discount percent

double

nptDiscountPrice
optional

NPT discount price

double

nptComment
optional

NPT comment

string

1000 characters max

productStoreDisplays
optional

list

discounts
optional

Discounts

Discount list

Discount

Name Description Value Business rules

discountNatureCode
required

Discount nature code

string

8 characters max

calculationRule
required

Calculation rule

string

within (PERCENT, UNITPRIC, SPECPRIC) :

PERCENT = Percentage
UNITPRIC = Unit price
SPECPRIC = Special price

calculationValue
required

Calculation value

double

currencyCode
required if calculationRule is UNITPRIC or SPECPRIC

Currency code

string

3 characters max

unitCode
required if calculationRule is UNITPRIC or SPECPRIC

Unit code

string

5 characters max

comment
optional

Comment

string

1000 characters max

discountType
required

Discount type

string

within (INV, CP) :

INV = Invoiced
CP = Consumer price (RP)