| Property |
Required |
BEES Force Required |
Comments |
Example |
| id string |
true |
false |
The unique identifier. |
ID_01 |
| promotionId string |
true |
false |
The unique identifier for the promotion. |
ID_01 |
| budget bigDecimal |
true |
false |
The promotion budget. |
0 |
| description string |
false |
false |
The complete description for the promotion, it describes the promotion itself and how the promotion works. |
Buy 10, get 12 - Buy 12, get 16” or discounts "10% off for all beers |
| endDate string |
false |
false |
The promotion end date. It should be in UTC timezone. (Format: yyyy-MM-ddTHH:mm:ssZ). |
2050-03-31T23:59:59.999Z |
| image string |
false |
false |
Image used as a background for the promotion. |
https://www.socioscerveceria.com.do/media/catalog/product//b/a/barcelo_dark_series_350_ml_-_unidad_1_botella_dar_siri_.png
|
| quantityLimit integer |
false |
false |
The promotion quantity limit. |
0 |
| startDate string |
true |
false |
The promotion start date. It should be in UTC timezone. (Format: yyyy-MM-ddTHH:mm:ssZ) |
2020-01-01T00:00:00.000Z |
| title string |
true |
false |
The promotion title. The label displayed on the promotion list. |
Great discount on Becks! |
| type string |
true |
false |
The promotion type.
Can be: DISCOUNT, FREE_GOOD, STEPPED_DISCOUNT, STEPPED_FREE_GOOD, FLEXIBLE_DISCOUNT
|
FLEXIBLE_DISCOUNT |