POST
/api/v1/customer/full-search
This API method will allow you to get run a full search on stores and customers.
Request Parameters
Parameter | Value / Type | Required |
|---|---|---|
query | STRING (min: 3) | true |
filter | STRING | false |
Sample Response
{
"status": true,
"items": {
"stores": [],
"customers": [],
"campaigns": [
{
"id": "132",
"account_id": 34,
"name": "GD - Campaign Test 01",
"campaign_start_date": "2022-06-06",
"campaign_end_date": "2022-07-06",
"campaign_description": "",
"age_range_type": 0,
"age_value": 0,
"min_age": 0,
"max_age": 0,
"status": 1,
"campaign_type": null,
"trigger_type": "None",
"reward_type": "PercentDollarValue",
"campaign_require_register": 0,
"cash_tender_multiplier": "2.00",
"non_cash_tender_multiplier": "0.50",
"allow_cash_tender": 1,
"allow_non_cash_tender": 1,
"trigger_amount": "0.00",
"account": {
"id": "34",
"parent_id": null,
"company": "SC Choice Management",
"company_code": "34236",
"domain_name": "",
"tenancy_initialization": 0,
"db_name": null,
"bucket_name": null,
"identity_tenant_identifier": "",
"slug": "sc-choice-management",
"cw_company": "19299",
"sc_company": 0,
"cw_primary_contact": "1365",
"account_package_id": 4,
"can_own_accounts": 1,
"agreement_type": 1,
"protected": 0,
"phone": "607-777-6666",
"address": "195 Lake Louise Marie Road",
"country_id": 167,
"state_id": 61,
"city_id": 10,
"city": "Rock Hill",
"state": "AL",
"zip": "12775",
"type": 0,
"altria_code": "",
"altria_notify": "",
"include_child_buydowns": 0,
"data": null,
"created_at": "2015-05-14 23:14:07",
"updated_at": "2022-03-03 16:52:27",
"deleted_at": null,
"applicable_tier": 0
}
},
{
"id": "131",
"account_id": 34,
"name": "Campaign Test 01",
"campaign_start_date": "2022-06-03",
"campaign_end_date": "2022-07-03",
"campaign_description": "",
"age_range_type": 0,
"age_value": 0,
"min_age": 0,
"max_age": 0,
"status": 1,
"campaign_type": null,
"trigger_type": "None",
"reward_type": "PercentDollarValue",
"campaign_require_register": 0,
"cash_tender_multiplier": "2.00",
"non_cash_tender_multiplier": "0.50",
"allow_cash_tender": 1,
"allow_non_cash_tender": 1,
"trigger_amount": "0.00",
"account": {
"id": "34",
"parent_id": null,
"company": "SC Choice Management",
"company_code": "34236",
"domain_name": "",
"tenancy_initialization": 0,
"db_name": null,
"bucket_name": null,
"identity_tenant_identifier": "",
"slug": "sc-choice-management",
"cw_company": "19299",
"sc_company": 0,
"cw_primary_contact": "1365",
"account_package_id": 4,
"can_own_accounts": 1,
"agreement_type": 1,
"protected": 0,
"phone": "607-777-6666",
"address": "195 Lake Louise Marie Road",
"country_id": 167,
"state_id": 61,
"city_id": 10,
"city": "Rock Hill",
"state": "AL",
"zip": "12775",
"type": 0,
"altria_code": "",
"altria_notify": "",
"include_child_buydowns": 0,
"data": null,
"created_at": "2015-05-14 23:14:07",
"updated_at": "2022-03-03 16:52:27",
"deleted_at": null,
"applicable_tier": 0
}
},
{
"id": "78",
"account_id": 34,
"name": "*Earn 10% on all food up to $100 (Munchie Club)",
"campaign_start_date": "2022-06-03",
"campaign_end_date": "2022-08-17",
"campaign_description": "For a limited time, enjoy 20% Off Catskill Hemp Co CBDa + Immune Support Orange Fruit Chews! A recent study stated that CBDa could hinder the SARS-CoV-2 virus from entering cells and causing infection by binding to the virus's spike protein.<br \\/>\\\\r\\\\n\\\\r\\<br />\\n\\\\r\\<br \\\\/>\\n \\\\r\\\\n<br /><br/><br/ ><br / >< br/>These tasty little powerhouses contain 750mg of CBDa as well as Quercetin, Zinc, Vitamin C and Vitamin D3 making them beneficial for fighting off infection and boosting your immune system.\\\\r\\\\nPlus, our AWESOME Loyal-n-Save members will earn 5x the reward tokens. This offer is available in Stores Only from 5/13/22-5/26/22.",
"age_range_type": 0,
"age_value": 0,
"min_age": 0,
"max_age": 0,
"status": 1,
"campaign_type": null,
"trigger_type": "None",
"reward_type": "PercentDollarValue",
"campaign_require_register": 1,
"cash_tender_multiplier": "1.00",
"non_cash_tender_multiplier": "0.50",
"allow_cash_tender": 1,
"allow_non_cash_tender": 1,
"trigger_amount": "0.00",
"account": {
"id": "34",
"parent_id": null,
"company": "SC Choice Management",
"company_code": "34236",
"domain_name": "",
"tenancy_initialization": 0,
"db_name": null,
"bucket_name": null,
"identity_tenant_identifier": "",
"slug": "sc-choice-management",
"cw_company": "19299",
"sc_company": 0,
"cw_primary_contact": "1365",
"account_package_id": 4,
"can_own_accounts": 1,
"agreement_type": 1,
"protected": 0,
"phone": "607-777-6666",
"address": "195 Lake Louise Marie Road",
"country_id": 167,
"state_id": 61,
"city_id": 10,
"city": "Rock Hill",
"state": "AL",
"zip": "12775",
"type": 0,
"altria_code": "",
"altria_notify": "",
"include_child_buydowns": 0,
"data": null,
"created_at": "2015-05-14 23:14:07",
"updated_at": "2022-03-03 16:52:27",
"deleted_at": null,
"applicable_tier": 0
}
}
]
}
}{
"status": true,
"stores": [],
"customers": [
{
"id": "bZ6xBGP2mdPm3R8VX17L",
"scan_id": "LNS12345678900",
"first_name": "Steve",
"last_name": "Brioch",
"date_of_birth": "2017-12-18",
"address_line_1": "-",
"address_line_2": "-",
"city": "-",
"state": "",
"zip": "12345",
"customer_description": "Customer Description",
"stores_count": 1,
"friend_status": 0,
"balance": 880,
"avatar": "http://controlcenter.fastraxpos.com/customer/images/default-avatars/QD59AxOJm2MenXb14Pw7?v=1513667463",
"campaigns_total": 6,
"campaigns_registered": 6
}
]
}{
"status": false,
"errorCode": "VALIDATION_EXCEPTION",
"messages": {"query": ["Search value 'query' must be at least 3 characters"]}
}