Create Store Promotion - FREEITEM_MINIBASKET
POST {{base_url}}/v1/delivery/stores/{{store_id}}/promotion
Creates a Free item promotion for the given store with a minimum basket spend. The free_item_id
corresponds to the External Item ID in the menu.
If you run this request succesfully, the promotion_id
in the response body will be saved in the corresponding environment variable.
Note: You need to replace the free_item_id
with an existing External Item ID in your menu.
Request Body
{"start_time"=>"2024-02-03T10:00:00-06:00", "end_time"=>"2024-02-10T10:00:00-06:00", "user_group"=>"ALL_CUSTOMERS", "budget"=>{"unlimited_budget"=>true}, "external_promotion_id"=>"test_promo", "allow_unlimited_apply"=>true, "promo_type"=>"FREEITEM_MINBASKET", "free_item_discount"=>{"min_basket_constraint"=>{"min_spend"=>{"amount"=>1000}}, "free_items"=>[{"free_item_id"=>"Coffee"}]}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
User-Agent | string |
RESPONSES
status: OK
{"promotion_id":"{promotion_id}"}