Visit

A Visit represents a single visit to the venue. A visit is either a ticket utilization (when a ticket is used for entry), an event ticket utilization (when an event ticket is scanned), or a customer checkin (when a member checks in with their membership).

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"bd4a0997-39db-41d9-883a-cdfa83e2101f"
datestringTimestamp of the visit"2024-07-15 14:30:00"
typestringType of visit: TICKET_UTILIZATION, EVENT_TICKET_UTILIZATION, or CUSTOMER_CHECKIN"TICKET_UTILIZATION"
additionalPersonsnumber0Number of additional persons accompanying the visitor2
adultsnumber0Number of adults in the visit1
childrennumber0Number of children in the visit2
totalnumber0Total number of persons in the visit3
ticketUtilizationTicketUtilizationnullPresent when type is TICKET_UTILIZATION. Contains the ticket utilization details
eventTicketUtilizationEventTicketUtilizationnullPresent when type is EVENT_TICKET_UTILIZATION. Contains the event ticket utilization details
customerCheckinCustomerCheckinnullPresent 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.

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"e4ee88c7-c5a1-4cf2-8794-741b7f1e2ad5"
datestringTimestamp of when the ticket was used"2024-07-15 14:30:00"
ticketobjectnullThe ticket that was used

Ticket (within TicketUtilization)

PropertyTypeDescriptionExample
idstring (UUIDv4)Unique identifier of the ticket"bd4a0997-39db-41d9-883a-cdfa83e2101f"
numbernumberNumber of the ticket166
globalNumberstringGlobal number of the ticket"G12345"
autoUsedbooleanWhether the ticket was automatically usedfalse
ticketTypeobjectThe ticket type of the ticket{ "id": "...", "name": "Adult Ticket", "sku": "ADULT-001" }

EventTicketUtilization

An EventTicketUtilization represents a single use of an event ticket. It is included in a visit when the visit type is EVENT_TICKET_UTILIZATION.

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"e4ee88c7-c5a1-4cf2-8794-741b7f1e2ad5"
datestringTimestamp of when the event ticket was used"2024-07-15 14:30:00"
eventTicketobjectnullThe event ticket that was used

EventTicket (within EventTicketUtilization)

PropertyTypeDescriptionExample
idstring (UUIDv4)Unique identifier of the event ticket"bd4a0997-39db-41d9-883a-cdfa83e2101f"
numbernumberNumber of the event ticket42
eventobjectThe event the ticket belongs to{ "id": "...", "title": "Concert" }
eventTicketTypeobjectThe event ticket type{ "id": "...", "name": "Standard" }
customerobjectThe customer who owns the event ticket, if applicable

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.

PropertyTypeDefaultDescriptionExample
id*string (UUIDv4)Unique identifier"e4ee88c7-c5a1-4cf2-8794-741b7f1e2ad5"
datestringTimestamp of the checkin"2024-07-15 14:30:00"
museumobjectnullThe museum where the checkin occurred
departmentobjectnullThe department where the checkin occurred, if applicable
customerobjectnullThe customer who checked in
eligibleMembershipMembershipnullThe membership used for the checkin, if applicable

Museum (within CustomerCheckin)

PropertyTypeDescriptionExample
idstring (UUIDv4)Unique identifier of the museum"bd4a0997-39db-41d9-883a-cdfa83e2101f"
namestringName of the museum"National Museum"

Department (within CustomerCheckin)

PropertyTypeDescriptionExample
idstring (UUIDv4)Unique identifier of the department"bd4a0997-39db-41d9-883a-cdfa83e2101f"
namestringName of the department"Modern Art Wing"

Customer (within CustomerCheckin)

PropertyTypeDescriptionExample
idstring (UUIDv4)Unique identifier of the customer"bd4a0997-39db-41d9-883a-cdfa83e2101f"
firstNamestringFirst name of the customer"Johanna"
lastNamestringLast name of the customer"Hansen"
emailstringEmail of the customer"johanna@example.com"
memberNumbernumberMember number of the customer1234
phonestringPhone number of the customer"+4512345678"
phoneCountryCodestringCountry code for the phone number"DK"
addressstringAddress of the customer"Vestergade 12"
address2stringSecond address line"3. sal"
postalCodestringPostal code"1456"
citystringCity"Copenhagen"
countrystringCountry"DK"
Previous
Event Ticket
Next
List Customers