Promotion

Endpoints

Get list of promotions

/forecast/companies/{companycode}/establishments/{establishmentcode}/promotions

Description

Returns promotions.

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

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

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Promotion > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Promotion

Promotion data structure for Get.

Name Description Value Business rules

companyCode
optional

Current company code

string

2 characters max

establishmentCode
optional

Current 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

promotionLabel
optional

Promotion label

string

30 characters max

promotionState
optional

Promotion state

string

within (CRE, OFF, CLO, CAN) :

CRE = Not offered
OFF = Offered
CLO = Closed
CAN = Canceled