api/v1/customer/campaigns/single-campaign

GET

api/v1/customer/campaigns/all-campaigns

This API method will grab a single campaigns/deals for Store Or MFG.

Campaign-Type parameter can have two value "Stores" Or "MFG".

Sample Request body

Parameter

Value / Type

Required

campaign-type

string

false

id

string

false

Sample Response

{
    "status": true,
    "item": [
        {
            "id": "34aQnOG0m9XeMVB7YqyJ",
            "manufacturer_account_id": 1,
            "name": "Mobile testing",
            "campaign_start_date": "2022-06-21",
            "campaign_end_date": "2022-07-21",
            "campaign_value": "1.00",
            "balance_type_id": 1,
            "trigger_type": "None",
            "reward_type": "PercentDollarValue",
            "trigger_amount": "0.00",
            "single_use_only": 0,
            "single_use_type": 0,
            "use_dollar_limit": 0,
            "dollar_limit": "0.00",
            "dollar_limit_type": 0,
            "campaign_description": "sdfsdfewrewrdsfdsvsdvsdvdsv",
            "use_item_categories": 0,
            "campaign_once_per_sale": 0,
            "use_schedule": 0,
            "campaign_image": "http://controlcenter.ftx:81/images/assets/text.png",
            "cash_tender_multiplier": "0.00",
            "non_cash_tender_multiplier": "0.00",
            "allow_cash_tender": 0,
            "allow_non_cash_tender": 0,
            "filter_type": "",
            "filter_items": null,
            "all_items_point_value": "0.00",
            "campaign_alt_type": "None",
            "all_stores": 0,
            "early_registration_time": "0",
            "schedule_hours": null,
            "campaign_require_register": 0,
            "month_duration": 0,
            "status": 1,
            "is_validated": 0,
            "age_range_type": 0,
            "age_value": 0,
            "min_age": 0,
            "max_age": 0,
            "accepted_no_filters": 1,
            "created_at": "2022-06-21 09:24:28",
            "updated_at": "2022-06-21 09:24:28",
            "deleted_at": null,
            "campaign_progress": 0,
            "account": {
                "id": "LZWBJx0PmYkEwjGdr2vO",
                "company": "Bobs Furniture",
                "chain_logo": "http://controlcenter.ftx:81/images/assets/text.png",
                "chain_background": ""
            },
            "campaign_balance": "0.00",
            "per_dollar_value": "",
            "purchaser_multiplier": "",
            "campaign_type": ""
        }
    ]
}
{
    "status": true,
    "item": [
        {
            "id": "34aQnOG0m9XeMVB7YqyJ",
            "account_id": "n4MXak06zKKpzNQ3vw8O",
            "name": "Percent of Dollar Value in Points",
            "campaign_start_date": "2018-02-08",
            "campaign_end_date": "2018-07-31",
            "campaign_description": "Spend some serious $$ for this one.",
            "age_range_type": 0,
            "age_value": null,
            "min_age": null,
            "max_age": null,
            "status": 1,
            "campaign_type": "",
            "trigger_type": "None",
            "reward_type": "PercentDollarValue",
            "campaign_require_register": 0,
            "cash_tender_multiplier": "5.00",
            "non_cash_tender_multiplier": "1.00",
            "allow_cash_tender": 0,
            "allow_non_cash_tender": 1,
            "trigger_amount": "0.00",
            "campaign_value": "10000.00",
            "per_dollar_value": "1.00",
            "purchaser_multiplier": 1,
            "balance_type_id": 38,
            "single_use_only": 1,
            "single_use_type": 0,
            "use_dollar_limit": 0,
            "dollar_limit": "0.00",
            "dollar_limit_type": 0,
            "use_item_categories": 0,
            "campaign_once_per_sale": 1,
            "all_items_point_value": null,
            "campaign_alt_type": "None",
            "all_locations": 1,
            "all_interests": 1,
            "gender_type": 0,
            "early_registration_time": null,
            "schedule_hours": {
                "mon": {
                    "isActive": true,
                    "timeFrom": "9:00 AM",
                    "timeTill": "6:00 PM"
                },
                "tue": {
                    "isActive": true,
                    "timeFrom": "9:00 AM",
                    "timeTill": "6:00 PM"
                },
                "wed": {
                    "isActive": true,
                    "timeFrom": "9:00 AM",
                    "timeTill": "6:00 PM"
                },
                "thu": {
                    "isActive": true,
                    "timeFrom": "9:00 AM",
                    "timeTill": "6:00 PM"
                },
                "fri": {
                    "isActive": true,
                    "timeFrom": "9:00 AM",
                    "timeTill": "6:00 PM"
                },
                "sat": {
                    "isActive": false,
                    "timeFrom": null,
                    "timeTill": null
                },
                "sun": {
                    "isActive": false,
                    "timeFrom": null,
                    "timeTill": null
                }
            },
            "month_duration": null,
            "use_global_breakdown": 0,
            "team_breakdown": "",
            "is_hot": 0,
            "notified_on_create": 1,
            "email_sent": 1,
            "disable_email": 0,
            "stackable": 0,
            "accepted_no_filters": 0,
            "use_schedule": 1,
            "campaign_image": "http://controlcenter.ftx:81/campaigns/34aQnOG0m9XeMVB7YqyJ/image",
            "created_at": "2018-02-08 20:04:57",
            "updated_at": "2019-07-23 18:25:10",
            "deleted_at": null,
            "campaign_balance": "0.00",
            "account": {
                "id": "n4MXak06zKKpzNQ3vw8O",
                "company": "JC Penny",
                "data": null
            }
        }
    ]
}
{
    "status": true,
    "item": []
}