Sign in
CheckIns

Create a Check-in

Records a new check-in for a customer at the given site.

post/customers/check-ins

Request body

customer_idstring required

The customer ID associated with this check-in

membership_idstring

The membership ID associated with this check-in

site_idstring required

The site ID where this check-in happened

method_idstring nullable

Identifier of the method that produced the check-in. Use one of the generic string codes (scanned, check_in_button) for human-driven check-ins, or the ID of an integrated resource such as a Gantner device for hardware-driven check-ins. When passing a resource ID, also set method_type accordingly.

method_type'gantner' nullable

The type of method used to create this check-in. Omit this field for a generic method, or set to gantner when the method is an allowed resource such as a Gantner Device.

Example request

{
  "customer_id": "000000-000000-000000-000000",
  "membership_id": "000000-000000-000000-000000",
  "site_id": "000000-000000-000000-000000",
  "method_id": "scanned"
}

Response

The check-in was successfully retrieved

Example response

{
  "data": {
    "id": "000000-000000-000000-000000",
    "customer": {
      "id": "000000-000000-000000-000000",
      "first_name": "John",
      "last_name": "Smith",
      "full_name": "John Smith",
      "email": "john@example.com"
    },
    "membership_id": "000000-000000-000000-000000",
    "site_id": "000000-000000-000000-000000",
    "method": {
      "name": "Scanned"
    },
    "source": "kiosk",
    "checked_in_at": "2021-01-01T00:00:00.000Z",
    "checked_out_at": "2021-01-01T00:00:00.000Z"
  }
}

Changes