Promotion plan

Endpoints

Get list of promotion plans

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

Description

Returns promotion plans.

Parameters

Type Name Description Schema

Path

companyCode
required

Current context company code

string

Path

establishmentCode
required

Current context establishment code

string

Query

planCode
optional

Plan code

string

Query

validities
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

< PromotionPlan > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

PromotionPlan

Promotion plan data structure for Get.

Name Description Value

companyCode
optional

Current company code

string

establishmentCode
optional

Current establishment code

string

planCode
required

Plan code

string

planLabel
optional

Plan label

string

planStartDate
optional

Plan start date

datetime (ISO-8601)

planEndDate
optional

Plan end date

datetime (ISO-8601)

budget
optional

Budget

boolean