Get Store Promotions

GET {{base_url}}/v1/delivery/stores/{{store_id}}/promotions?state=active

Provides a list of all promotions existing on a store filtered on state and time range. Note: the result only contains the promotions created via API, instead of Uber ops tool or self-serve dashboard.

Request Params

KeyDatatypeRequiredDescription
statestringOptional. If it is specified, the result will only contain the promotions with target state.
Enum: "active" "pending" "completed" "revoked" "expired" "deleted"

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
User-Agentstring

RESPONSES

status: OK

{"promotions":[{"promotion_id":"{promotion_id}","store_id":"{store_id}","start_time":"2024-02-03T16:00:00Z","end_time":"2024-02-10T16:00:00Z","created_time":"2024-01-23T22:26:21Z","state":"ACTIVE","external_promotion_id":"test_promo","user_group":"ALL_CUSTOMERS","allow_unlimited_apply":false,"currency_code":"MXN","budget":{"unlimited_budget":true},"promo_type":"FLATOFF","flat_off_discount":{"min_basket_constraint":{"min_spend":{"amount":1000,"currency_code":"MXN"}},"discount_value":{"amount":400,"currency_code":"MXN"}}},{"promotion_id":"{promotion_id}","store_id":"{store_id}","start_time":"2024-02-03T16:00:00Z","end_time":"2024-02-10T16:00:00Z","created_time":"2024-01-23T22:24:55Z","state":"ACTIVE","external_promotion_id":"test_promo","user_group":"ALL_CUSTOMERS","allow_unlimited_apply":false,"currency_code":"MXN","budget":{"unlimited_budget":true},"promo_type":"FLATOFF","flat_off_discount":{"min_basket_constraint":{"min_spend":{"amount":1000,"currency_code":"MXN"}},"discount_value":{"amount":400,"currency_code":"MXN"}}}]}