api/v1/customer/stores/available

GET

/api/v1/customer/stores/available

This API method will grab a list of valid stores available that the current logged in customer is able to sign up for, not including any stores currently registered.

Sample Request body

Nothing required

Sample Response

Parameter

Value / Type

Require

search

string

optional

range

number

optional

tag

string

optional

{
    "status": true,
    "items": [
        {
            "id": "kBL8qYaWmRKzDr5R3PjK",
            "company": "FTX",
            "slug": null,
            "sc_company": null,
            "phone": "5555555555",
            "address": "",
            "city": "",
            "state": "",
            "zip": "",
            "created_at": "2015-07-02 10:23:38",
            "updated_at": "2018-10-30 11:34:25",
            "loyalty_options": {
                "id": "Mo2y1dkXEaZe50YnWLKO",
                "chain_display_name": "FTX",
                "description": "",
                "point_conversion": 1000,
                "team_breakdown": {
                    "level_1": "50",
                    "level_2": "25",
                    "level_3": "15",
                    "level_4": "10",
                    "level_5": "5"
                },
                "chain_active": 1,
                "selected_proof_165_id": null,
                "selected_proof_323_id": null,
                "selected_proof_258_id": null,
                "selected_proof_212_id": null,
                "sign_up_bonus_points": "0.00",
                "referral_bonus_points": "0.00",
              	"interest_bonus": "100",
                "inactivity_months": 4,
                "participate_in_offer": 0,
                "default_cash_tender_multiplier": "1.00",
                "default_non_cash_tender_multiplier": "1.00",
                "default_allow_cash_tender": 1,
                "default_allow_non_cash_tender": 1,
                "campaign_for_points_redemption": "Redemption",
                "chain_logo": "",
              	"chain_background": "#00e35a",
                "campaign_require_register": 1,
                "early_registration_time": "0m",
                "shipping_contact_name": "",
                "shipping_address_line_1": "",
                "shipping_address_line_2": "",
                "shipping_city": "",
                "shipping_state": "",
                "shipping_zip": null,
                "term_contents": "",
                "created_at": "2017-10-31 20:58:50",
                "updated_at": "2017-10-31 20:58:50"
            },
            "disable_notifications": null,
            "show_store_updates": null,
            "allow_see_store": null,
            "show_receipts": null,
            "campaigns_total": 0,
            "campaigns_registered": 0,
            "balance": 0,
            "registered": false,
            "referral_code": "eYuou12",
          	"total_levels": 2,
            "total_members": 32,
        },
        {
            "id": "xy7bXBgZeMdbEN391JoV",
            "company": "FasTrax Support",
            "slug": null,
            "sc_company": null,
            "phone": "",
            "address": "",
            "city": "",
            "state": "",
            "zip": "",
            "created_at": "2015-09-01 11:09:53",
            "updated_at": "2015-12-09 09:06:08",
            "loyalty_options": {
                "id": "n4MXak06zKpENQ3vw8Ob",
                "chain_display_name": "FasTrax Support",
                "description": "",
                "point_conversion": 1000,
                "team_breakdown": {
                    "level_1": "50",
                    "level_2": "25",
                    "level_3": "15",
                    "level_4": "10",
                    "level_5": "5"
                },
                "chain_active": 1,
                "selected_proof_165_id": null,
                "selected_proof_323_id": null,
                "selected_proof_258_id": null,
                "selected_proof_212_id": null,
                "sign_up_bonus_points": "0.00",
                "referral_bonus_points": "0.00",
                "inactivity_months": 4,
                "participate_in_offer": 0,
                "default_cash_tender_multiplier": "1.00",
                "default_non_cash_tender_multiplier": "1.00",
                "default_allow_cash_tender": 1,
                "default_allow_non_cash_tender": 1,
                "campaign_for_points_redemption": "Redemption",
                "chain_logo": "",
              	"chain_background": null,
                "campaign_require_register": 1,
                "early_registration_time": "0m",
                "shipping_contact_name": "",
                "shipping_address_line_1": "",
                "shipping_address_line_2": "",
                "shipping_city": "",
                "shipping_state": "",
                "shipping_zip": null,
                "term_contents": "",
                "created_at": "2017-10-31 20:58:50",
                "updated_at": "2017-10-31 20:58:50"
            },
            "disable_notifications": null,
            "show_store_updates": null,
            "allow_see_store": null,
            "show_receipts": null,
            "campaigns_total": 0,
            "campaigns_registered": 0,
            "balance": 0,
            "registered": false,
            "referral_code": "eYuou11",
          	"total_levels": 2,
            "total_members": 10
        }
    ]
}