Loyalty
RetrieveLoyaltyPromotion
Retrieves a loyalty promotion.
get/v2/loyalty/programs/{program_id}/promotions/{promotion_id}
Path parameters
promotion_idstring required
The ID of the loyalty promotion to retrieve.
program_idstring required
The ID of the base loyalty program. To get the program ID, call RetrieveLoyaltyProgram using the main keyword.
Response
Success
Example response
{
"loyalty_promotion": {
"available_time": {
"start_date": "2022-08-16",
"time_periods": [
"BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
]
},
"created_at": "2022-08-16T08:38:54Z",
"id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67",
"incentive": {
"points_multiplier_data": {
"multiplier": "3.000",
"points_multiplier": 3
},
"type": "POINTS_MULTIPLIER"
},
"loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
"minimum_spend_amount_money": {
"amount": 2000,
"currency": "USD"
},
"name": "Tuesday Happy Hour Promo",
"qualifying_item_variation_ids": [
"CJ3RYL56ITAKMD4VRCM7XERS",
"AT3RYLR3TUA9C34VRCB7X5RR"
],
"status": "ACTIVE",
"trigger_limit": {
"interval": "DAY",
"times": 1
},
"updated_at": "2022-08-16T08:38:54Z"
}
}