GET
/api/v1/customer/campaigns/customer/{id}
This API method will grab a list of valid Campaigns available of that passed customer.
Sample Request body
Nothing required
Sample Response
{
"status":true,
"items":[
{
"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":"Bobs Management",
"chain_logo":"http://controlcenter.local/stores/l6yYk1WOeo7e2b78dD4j/chain-logo",
"chain_background": ""
},
"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":"127 Fox Road",
"city":"Corporate City",
"state":"NY",
"zip":"11111",
"latitude":"41.45120000",
"longitude":"-74.47010000"
}
]
},
{
"id":"R7AMWPvlzbLeyGNLYBdb",
"name":"Trial Two 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":"Trial Two Campaign",
"use_item_categories":0,
"campaign_once_per_sale":0,
"use_schedule":0,
"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":1,
"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 12:47:45",
"updated_at":"2018-10-10 12:47:45",
"account":{
"id":"l6yYk1WOeo7e2b78dD4j",
"company":"Bobs Management",
"chain_logo":"http://controlcenter.local/stores/l6yYk1WOeo7e2b78dD4j/chain-logo",
"chain_background": "#CCEEDD"
},
"campaign_progress":0,
"manufacturer_logo": "http://controlcenter.local/manufacturers/LZWBJx0PmYkEwjGdr2vO/logo",
"manufacturer_background": null,
"registered_users":0,
"registered":true,
"store_image":"",
"valid_locations":[
"This is valid at all store locations"
]
}
]
}