customer list

GET http://{base-url}/v1/clients/customerList

This endpoint allows you to get free cakes.

Headers

Name	Type	Description
x-api-secret	string
x-api-access	string
Content-Type	string
x-client-token	string

Request Body

Name	Type	Description
store_id	number

200 Cake successfully retrieved.

{
    "success": true,
    "msg": "customer list",
    "data": {
        "customers": [
            {
                "customer_id": "744",
                "name": "",
                "phone_no": "7506342015",
                "email": "",
                "category": "gold",
                "number_off_bills": "1",
                "ltv": "9520.00",
                "last_bill_amount": "9520.00",
                "last_bill_date": "2019-12-04T07:28:31.033Z"
            },
            {
                "customer_id": "743",
                "name": "",
                "phone_no": "8898453850",
                "email": "",
                "category": "locked",
                "number_off_bills": "1",
                "ltv": "10.00",
                "last_bill_amount": "10.00",
                "last_bill_date": "2019-12-03T13:34:10.171Z"
            },
            {
                "customer_id": "720",
                "name": "Kiran Satpute",
                "phone_no": "7588296316",
                "email": "",
                "category": "executive",
                "number_off_bills": "5",
                "ltv": "904.00",
                "last_bill_amount": "141.00",
                "last_bill_date": "2020-01-27T06:59:15.332Z"
            },
            {
                "customer_id": "717",
                "name": "umesh",
                "phone_no": "7777016715",
                "email": "",
                "category": "gold",
                "number_off_bills": "2",
                "ltv": "1185.00",
                "last_bill_amount": "525.00",
                "last_bill_date": "2019-10-14T12:44:25.546Z"
            },
            {
                "customer_id": "716",
                "name": "",
                "phone_no": "9967199955",
                "email": "",
                "category": "gold",
                "number_off_bills": "4",
                "ltv": "3885.00",
                "last_bill_amount": "2517.00",
                "last_bill_date": "2019-10-15T06:29:56.348Z"
            },
            {
                "customer_id": "715",
                "name": "Hars",
                "phone_no": "9967234837",
                "email": "",
                "category": "gold",
                "number_off_bills": "4",
                "ltv": "2297.00",
                "last_bill_amount": "344.00",
                "last_bill_date": "2019-10-16T11:50:47.510Z"
            },
            {
                "customer_id": "703",
                "name": "",
                "phone_no": "9594299293",
                "email": "",
                "category": "gold",
                "number_off_bills": "37",
                "ltv": "41970.00",
                "last_bill_amount": "5020.00",
                "last_bill_date": "2019-12-18T12:00:03.678Z"
            },
            {
                "customer_id": "702",
                "name": "",
                "phone_no": "8169661663",
                "email": "",
                "category": "locked",
                "number_off_bills": "1",
                "ltv": "15.00",
                "last_bill_amount": "15.00",
                "last_bill_date": "2019-09-24T13:12:32.861Z"
            },
            {
                "customer_id": "699",
                "name": "demo",
                "phone_no": "9832657414",
                "email": "[e-mail]",
                "category": "gold",
                "number_off_bills": "1",
                "ltv": "1180.00",
                "last_bill_amount": "1180.00",
                "last_bill_date": "2019-09-20T07:42:28.365Z"
            },
            {
                "customer_id": "698",
                "name": "",
                "phone_no": "9830986141",
                "email": "",
                "category": "locked",
                "number_off_bills": "1",
                "ltv": "105.00",
                "last_bill_amount": "105.00",
                "last_bill_date": "2019-09-19T11:05:56.720Z"
            }
        ],
        "meta": {
            "total": 47
        }
    }
}

404 Could not find a cake matching this query.

{
    "success": false,
    "msg": "customer not found",
    "data": {}