GET
/api/v1/customer/campaigns/{id}
This API will provide details of a specific campaign. Note: This does not mean that the customer accessing campaign actually is registered.
Sample Request body
Nothing required
Sample Response
{
"status": true,
"item": {
"id": "Ol2GJkRbElpEA53xM8B1",
"name": "TesT Campaign",
"campaign_type": null,
"campaign_start_date": "2018-10-10",
"campaign_end_date": "2018-11-10",
"campaign_value": "1.00",
"balance_type_id": "jq7w3P59EGvzKvBO80ok",
"trigger_type": "None",
"reward_type": "PercentDollarValue",
"trigger_amount": "0.00",
"single_use_only": 0,
"campaign_description": "TesT Campaign TesT Campaign",
"use_item_categories": 0,
"campaign_once_per_sale": 0,
"use_schedule": 0,
"campaign_image": "http:\/\/controlcenter.ftx\/campaigns\/G2D3wn94m41zrAOKPvM6\/image",
"cash_tender_multiplier": "5.00",
"non_cash_tender_multiplier": "7.00",
"allow_cash_tender": 1,
"allow_non_cash_tender": 0,
"all_items_point_value": "0.00",
"campaign_alt_type": "None",
"all_locations": 0,
"early_registration_time": null,
"schedule_hours": null,
"campaign_require_register": 0,
"month_duration": null,
"use_global_breakdown": 0,
"team_breakdown": "{\"level_1\":\"50\",\"level_2\":\"25\",\"level_3\":\"15\",\"level_4\":\"10\",\"level_5\":\"5\"}",
"status": 1,
"created_at": "2018-10-10 10:59:23",
"updated_at": "2018-10-10 10:59:23",
"account": {
"id": "l6yYk1WOeo7e2b78dD4j",
"company": "SC Choice Management",
"chain_logo": "http://controlcenter.local/stores/l6yYk1WOeo7e2b78dD4j/chain-logo"
},
"campaign_progress": 0,
"manufacturer_logo": "http://controlcenter.local/manufacturers/LZWBJx0PmYkEwjGdr2vO/logo",
"manufacturer_background": null,
"registered_users": 1,
"registered": true,
"store_image": "",
"valid_locations": [
{
"id":"ORwdvb48EQZeJXLBq7nQ",
"name":"Corporate",
"address":"195 Lake Louise Marie Road",
"city":"Rock Hill",
"state":"NY",
"zip":"12775",
"latitude":"41.45120000",
"longitude":"-74.47010000"
},
{
"id":"LZWBJx0PmYkEwjGdr2vO",
"name":"Middletown 2",
"address":"400 Rt 211 East Wallkill Plaza #20",
"city":"Middletown",
"state":"NY",
"zip":"10940",
"latitude":"41.45120000",
"longitude":"-74.47010000"
},
{
"id":"bZ6xBGP2mdPm3R8VX17L",
"name":"Catskill",
"address":"18 Boulevard Avenue",
"city":"Catskill",
"state":"NY",
"zip":"12414",
"latitude":"41.45120000",
"longitude":"-74.47010000"
},
{
"id":"nK8oWGj0zxqELP1A53ak",
"name":"Monticello I",
"address":"4370 Rt 42",
"city":"Monticello",
"state":"NY",
"zip":"12701",
"latitude":"41.45120000",
"longitude":"-74.47010000"
},
{
"id":"G2D3wn94m41zrAOKPvM6",
"name":"Saugerties DELETE ME",
"address":"1 Ulster Avenue",
"city":"Saugerties",
"state":"NY",
"zip":"12477",
"latitude":"41.45120000",
"longitude":"-74.47010000"
},
{
"id":"KBRQqA81ep1mdWnwlOXY",
"name":"Latham 27",
"address":"671 New Loudon Rd",
"city":"Latham",
"state":"NY",
"zip":"12110",
"latitude":"41.45120000",
"longitude":"-74.47010000"
}
]
}
}