booking/index

GET /api/3.0/booking/index

Retrieve a listing of bookings in the system.

Query timestamps may be Date strings or unix timestamps, and can be prefixed with ‘<’ or ‘>’ to match before or after a date.

Query Parameters:

  • status_id (string) – The current status of a booking.

  • customer_id (integer) – The customer id associated with the booking.

  • customer_email (string) – The customer email associated with the booking.

  • start_date (string/timestamp) – The date the booking starts on (i.e. check-in).

  • end_date (string/timestamp) – The date the booking ends on (i.e. check-out).

  • created_date (string/timestamp) – The date the booking was created.

  • last_modified (string/timestamp) – The date the booking was last changed. Useful for getting bookings added or changed since your last call.

  • partner_id (string) – The partner account ID that a booking is attributed to.

  • item_id (integer) – The ID of an item attached to the booking.

  • limit (integer) – The limit of bookings to return per page (default: 100).

  • page (integer) – The page of results to return.

Response JSON Array of Objects:

  • booking_id (integer) – The internal index of a booking.

  • code (string) – The unique booking reference code.

  • status_id (string) – The status code of the booking.

  • status_name (string) – The display name of the booking status.

  • created_date (timestamp) – The date/time the booking was created.

  • total (float) – The full value of the booking.

  • tax_total (float) – The sum of the taxes applied to the booking.

  • paid_total (float) – The amount the customer has paid on the booking.

  • customer_name (string) – The full name of the booking contact.

  • customer_email (string) – The email address of the booking contact.

  • summary (string) – A brief description of the contents of the booking.

  • date_desc (string) – A string describing the booked dates/times.

  • token (string) – A customer token for the booking, can be used to build links to customer portions of the reservation system.

 1{
 2    "version": "3.0",
 3    "account_id": 1,
 4    "host_id": "your-company.checkfront.com",
 5    "name": "Your Company",
 6    "locale": {
 7        "id": "en_US",
 8        "lang": "en",
 9        "currency": "CAD"
10    },
11    "request": {
12        "path": [
13            "booking",
14            "index"
15        ],
16        "id": "index",
17        "resource": "booking",
18        "records": 100,
19        "total_records": 11985,
20        "status": "OK",
21        "limit": 100,
22        "page": 1,
23        "pages": 120,
24        "time": 0.0501,
25        "method": "get"
26    },
27    "booking/index": {
28        "2": {
29            "booking_id": 2,
30            "code": "CFPP-290317",
31            "status_id": "PEND",
32            "status_name": "Pending",
33            "created_date": 1490854462,
34            "total": "80.40",
35            "tax_total": "13.40",
36            "paid_total": "0.00",
37            "customer_id": 3,
38            "customer_name": "Bridgette Hammes",
39            "customer_email": "bridgette@example.com",
40            "summary": "Walking Tour with a Taste of London, The London Experience Hat, The London Experience Mini-Bus",
41            "date_desc": "Sun Dec 24, 2017",
42            "tid": "",
43            "token": "b93eb6589f3ac8bdfca07f26dbe1a73ff6354620a51d8609a54a6697e686567f"
44        }
45    }
46}