Visit
A Visit represents a single visit to the venue. A visit is either a ticket utilization (when a ticket is used for entry) or a customer checkin (when a member checks in with their membership).
| Property | Type | Default | Description | Example |
|---|
id* | string (UUIDv4) | | Unique identifier | "bd4a0997-39db-41d9-883a-cdfa83e2101f" |
date | string | | Timestamp of the visit | "2024-07-15 14:30:00" |
type | string | | Type of visit: TICKET_UTILIZATION or CUSTOMER_CHECKIN | "TICKET_UTILIZATION" |
additionalPersons | number | 0 | Number of additional persons accompanying the visitor | 2 |
adults | number | 0 | Number of adults in the visit | 1 |
children | number | 0 | Number of children in the visit | 2 |
total | number | 0 | Total number of persons in the visit | 3 |
ticketUtilization | TicketUtilization | null | Present when type is TICKET_UTILIZATION. Contains the ticket utilization details | |
customerCheckin | CustomerCheckin | null | Present when type is CUSTOMER_CHECKIN. Contains the customer checkin details | |
TicketUtilization
A TicketUtilization represents a single use of a ticket. It is included in a visit when the visit type is TICKET_UTILIZATION.
| Property | Type | Default | Description | Example |
|---|
id* | string (UUIDv4) | | Unique identifier | "e4ee88c7-c5a1-4cf2-8794-741b7f1e2ad5" |
date | string | | Timestamp of when the ticket was used | "2024-07-15 14:30:00" |
ticket | object | null | The ticket that was used | |
Ticket (within TicketUtilization)
| Property | Type | Description | Example |
|---|
id | string (UUIDv4) | Unique identifier of the ticket | "bd4a0997-39db-41d9-883a-cdfa83e2101f" |
number | number | Number of the ticket | 166 |
globalNumber | string | Global number of the ticket | "G12345" |
autoUsed | boolean | Whether the ticket was automatically used | false |
ticketType | object | The ticket type of the ticket | { "id": "...", "name": "Adult Ticket", "sku": "ADULT-001" } |
CustomerCheckin
A CustomerCheckin represents a customer checking in, typically using their membership. It is included in a visit when the visit type is CUSTOMER_CHECKIN.
| Property | Type | Default | Description | Example |
|---|
id* | string (UUIDv4) | | Unique identifier | "e4ee88c7-c5a1-4cf2-8794-741b7f1e2ad5" |
date | string | | Timestamp of the checkin | "2024-07-15 14:30:00" |
customer | object | null | The customer who checked in | |
eligibleMembership | Membership | null | The membership used for the checkin, if applicable | |
Customer (within CustomerCheckin)
| Property | Type | Description | Example |
|---|
id | string (UUIDv4) | Unique identifier of the customer | "bd4a0997-39db-41d9-883a-cdfa83e2101f" |
firstName | string | First name of the customer | "Johanna" |
lastName | string | Last name of the customer | "Hansen" |
email | string | Email of the customer | "johanna@example.com" |
memberNumber | number | Member number of the customer | 1234 |
phone | string | Phone number of the customer | "+4512345678" |
phoneCountryCode | string | Country code for the phone number | "DK" |
address | string | Address of the customer | "Vestergade 12" |
address2 | string | Second address line | "3. sal" |
postalCode | string | Postal code | "1456" |
city | string | City | "Copenhagen" |
country | string | Country | "DK" |