GET/POST
/api/v1/customer/stores/{id}/campaigns
This API method will grab a list of Campaigns registered at this store.
Sample Request body
Parameter | Value / Type | Required |
|---|---|---|
search | STRING | false |
sortBy | STRING(ending_soon, new) | false |
tagIds | Array | false |
Sample Response
{
"status": true,
"items": [
{
"id": "nK8oWGj0zxqELP1A53ak",
"name": "Test",
"campaign_type": null,
"campaign_start_date": "2018-02-21",
"campaign_end_date": "2018-03-21",
"campaign_value": "0.00",
"balance_type_id": "jq7w3P59EGvzKvBO80ok",
"trigger_type": "None",
"reward_type": "PercentDollarValue",
"trigger_amount": "0.00",
"single_use_only": 0,
"campaign_description": "test",
"use_item_categories": 0,
"campaign_once_per_sale": 0,
"use_schedule": 0,
"cash_tender_multiplier": "1.00",
"non_cash_tender_multiplier": "1.00",
"allow_cash_tender": 1,
"allow_non_cash_tender": 0,
"all_items_point_value": null,
"campaign_alt_type": "Exclude",
"all_locations": 1,
"early_registration_time": null,
"schedule_hours": null,
"campaign_require_register": 0,
"month_duration": null,
"status": 1,
"created_at": "2018-02-21 11:51:43",
"updated_at": "2018-03-07 08:53:30",
"account": {
"id": "l6yYk1WOeo7e2b78dD4j",
"company": "SC Choice Management",
"chain_logo": "http://controlcenter.dev/stores/l6yYk1WOeo7e2b78dD4j/chain-logo"
},
"campaign_balance": "0.00",
"campaign_progress": 0,
"registered_users": 0
}
]
}{
"status": true,
"item": {
"children": [],
"parent": null
}
}