customer

The customer object provides access to customer details stored in the system. Customer information is automatically stored in the system when a new booking is made.

To retrieve information on a specific customer, you should ideally use the customer ID in a GET call to customer/[customer_id]. In this case, the customer information will be returned as “customer” in the JSON response.

If you do not have the customer ID stored, you can also look up customers based on indexed fields, including email address, name, and phone number. These must be an exact match, but can return multiple results on non-unique fields such as the customer name. The results will be stored in the “customers” object in the JSON response.

GET /api/3.0/customer

Retrieve a list of customers.

Query Parameters:
 
  • customer_id (string) – The unique customer code identifying a customer in the system.
  • customer_email (string) – A unique customer e-mail address to search.
  • customer_name (string) – The full name of the customer to search.
  • customer_phone (string) – The (exact) customer phone number to search.
GET /api/3.0/customer/{customer_id}

Retrieve contact details for a customer.

Parameters:
  • customer_id (string) – The unique customer code identifying a customer in the system.
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
    "version": "3.0",
    "account_id": 1,
    "host_id": "your-company.checkfront.com",
    "name": "Your Company",
    "locale": {
	"id": "en_CA",
	"lang": "en",
	"currency": "CAD"
    },
    "request": {
        "status": ""
    },
    "customer": {
        "customer_id": 25,
        "meta_id": null,
        "code": "NQ2-039-421",
	"status_id": "ACTIVE",
	"last_booking_date": null,
	"customer_name": "John Smith",
	"customer_email": "support@checkfront.com",
	"customer_email_optin": null,
	"customer_region": "BC",
	"customer_city": "Victoria",
	"customer_address": "386 Mews St",
	"customer_country": "0",
	"customer_postal_zip": "12345",
	"customer_phone": "0",
	"customer_crm_id": null,
	"notes": null,
        "meta": {
            "source": false,
            "diet": false,
            "diet_allergies": false
        },
        "referer": null,
        "bookings": {
            "LZTM-290317": {
                "created_date": "2017-03-29T23:54:18-07:00"
            },
            "XJZQ-020417": {
                "created_date": "2017-04-02T23:19:29-07:00"
            }
        }
    }
}