← API Index


BonusCampaign (v2)

A bonus campaign defining rules for point collection and rewards

# Field Type Description
0 id int bonus campaign id
1 name string campaign name
2 description string campaign description (marketing text)
3 point_price double turnover needed to earn one point
4 mov double minimum order value to qualify for points on a single order
5 per_position bool if true, points are awarded per order position (regio use case)
6 customer_must_apply bool if true, the customer must actively opt-in to participate
7 ddate_from date campaign start date (delivery date based), empty if immediate
8 ddate_until date campaign end date (delivery date based), empty if open-ended
9 item_regio bool true if campaign targets regional items only
10 item_group int item group filter (0 = all groups)
11 item_subgroup int item subgroup filter (0 = all subgroups)
12 item_rubric int item rubric filter (0 = all rubrics)
13 infourl string link to further information about the campaign (absolute http(s) URL, opened in a new tab), empty if there is none

Used in endpoints

Referenced in skills

Other versions