The Event Object is used across the ACME APIs. Currently, this page focuses on the endpoints for B2C, and will be enhanced later with additional endpoints (e.g. for Backoffice B2B)

TABLE OF CONTENTS

Event Object

GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/slim
GET   /v2/b2c/event/templates/{Event Template ID}


*The values marked x are returned in List Event Template (Slim) call


Event Instance vs Template
ParameterExampleSlim *
Bothid  (Required for updates)
Unique ID of this event		Example:
57113d507947cc39efb44249		x
InstancetemplateId (Read Only)
The ID of the parent template, which created this event instance through it's schedule.		Example:
63d08b46c9092f6d5ed46389
Bothtype 
Type of event, either Standard or Private, default is Standard. Read Only for the Instance.		Example:
  • standard
  • private
x
BothadmissionType
Either generalAdmission or standard, default is standard.
Read Only for the Instance.		Example:
  • generalAdmission
  • standard

Bothname (Required)
The name of this event.		Example:
Admissions		x
Bothdescription (Required, HTML supported)
The description of the event.		Example:
Any description		x
BothshortDescription 
A summary description of the event. Default is the first 300 characters of the description.		Example:
Any short description		x
BothemailConfirmationMessage (HTML supported)
A message to be added to the emails sent to customers when they purchase events of this template.		Example:
We look forward to seeing you soon!		x
BothstartTime (ISO-8601 format)

The time that this event starts.  

  • For instance if the museum is being loaned some Tang Dynasty Artwork from June 1, to November 30 and this event is a tour for the Tang Dynasty exhibition, startTime would be the day that the tours begin, June 1st and endTime would be when the tours end November 30.  
  • If no start time is provided when configuring an event, then it is assumed that the event starts now.

Note: On the slim call, it is not ISO-8601 format

Example:
2023-01-01T00:00:00-00:00		x
BothendTime (ISO-8601 format)
The end time for the event. If no endTime is provided when configuring an event, then it is assumed that this is an ongoing event.  


Note: On the slim call, it is not ISO-8601 format

Example:
2024-01-01T00:00:00-00:00		x
Instancecapacity (Required)
The maximum capacity that the event will support. This can be configured at both the Schedule and Event Instance <LINK> level.
When updating an Event Instance, an error will be thrown if updating to a number less than the sold quantity.		Example:
1000
Instanceresources[ ] 
A list of resource specifications for an event instance. See Resource Object below.

Note: For an Event Template, Resource Requests are returned in the array of Schedules. 
Templateschedules[ ] 
A list of schedules for this event template. These schedules are used to generate events of this template. See Scheduling JSON › for additional detail.		x
TemplatepriceLists[ ] 
The list of prices for an event instance. See Price List Object › for additional detail.		x
InstancepriceList[ ] 
The list of prices for an event instance. See Price List Object › for additional detail.
Bothimages[ ]
A list of images for the event. See Images Object below.		x
Templaterecommendations[ ]
The list of events that are recommended after buying this event. Also known as Upsells. 
See Recommendations (Upsells) Object below.		x
TemplatereviewState
Either Draft or Published, default is Draft. Keep your event template in Draft mode until you are ready to start selling events of this template. Once you put in Published mode the events will be generated and available on ACME's consumer website. You can not go back to Draft mode after you've Published.		Example:
  • Draft
  • Published

TemplateGLCode:
General ledger value.		Example:
BothaddOns[ ]
A list of Add On (inventory) items available for the event. See Add On Object below.		x
BothticketDetails
Details used when configuring or viewing tickets for an event. See Ticket Details Object below.
TemplateemailNotify[ ]
A list of people to notify when a purchase happens on an event generated by this template. This is particularly good when you are selling tickets to a third party event.
TemplateemailNotify[x].name:
Name of the person being notified.		Example:
Jane Doe
TemplateemailNotify[x].email:
Email address of the person being notified.		Example:
jane@venue.com
Templatemembership
The membership elements of the event template, such as what memberships are required and what discounts different memberships are eligible for. See Membership Entitlements/Rules Object below.
Bothavailable
True if the event template is available based on the membership provided. If false the visitor doesn't meet the required membership level.    		Example:
  • true
  • false
x
InstancesalesChannels[ ]
A list of sales channels specifying which sales channels are enabled for this event instance.

Note: For an Event Template, the sales channels are returned in the array of Schedules. See Scheduling JSON › for additional detail.
BothsoldQuantity (Read Only)
The total number of tickets sold for events of this template.		Example:
143		x
Templatestars (Read Only)
The total number of stars that the event has received in ratings by customers. To get the average number of stars, divide this number by the number of ratings below.		Example:
97		x
Templateratings (Read Only)
The total number of ratings that the event has received by customers. To get the average number of stars, divide the number of stars by this number.		Example:
100		x
BothcustomFields[ ]
List of custom fields for the event


Note: The list of custom fields available for events can be obtained by the following api: 

v2/tenant/settings/custom/fields?sortField=name&sortDirection=asc (GET)


BothcustomField[x].name:
Name of custom field (corresponds to the "label" property of custom fields obtained from the v2/tenant/settings/custom/fields API)		Example:
Location
BothcustomField[x].value:
Value of custom field		Example:
North Gallery
TemplateentitlementConfiguration
Contains information about the membership entitlements and ticket rules associated with this template. See Entitlement Configuration Object below.


Additional fields you may see returned

  • allMembersCanPurchase
  • checkInCount
  • colorCategory
  • discountAvailable
  • displayOrder
  • fieldStatus
  • formattedStartTime
  • lastPublished
  • lastUpdated
  • manuallyDeleted
  • memberOnlyEvent
  • offSchedule
  • originalFields
  • rebookingFee
  • resourceDetails
  • ruleSets
  • state
  • summary
  • thirdPartyEvent
  • thirdPartyPercentage
  • ticktConfig

Event Time Object

The Event Time Object contains optimized event information in the scenario where you want to display the event dates and times of events still available for sale, along with a count of remaining tickets.


GET /v2/b2c/event/templates/times
GET /v2/b2c/event/templates/{Event Template ID}/times


FieldExample
id
The id of the Event Template		Example:
5ad547ff58ccc435e559054d
date
String representation of the date.		Example:
Mon, Nov 17, 2018
time
String representation of the time		Example:
9:30 AM EST
availableSeats
The number of seats still available for this time (integer).		Example:
100
startTime (ISO-8601 format)
The start time for this event.		Example:
2023-01-01T00:00:00-00:00
event
The event details for the given timeslot. See Event Object above.


Ticket Details Object

Details used when configuring or viewing tickets for an event.


GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/{Event Template ID}
GET   /v2/b2c/events/{Event Instance ID}


ParameterExample
ticketDetails.ticketDurationDays
The number of days that tickets generated for events of this template will be valid.		Example:
365
ticketDetails.checkInWindow
Details about when visitors can check in with tickets for events of this template.
ticketDetails.checkInWindow.minutesBefore
The number of minutes before the event start time that the ticket can be scanned.		Example:
30
ticketDetails.checkInWindow.minutesAfter
The number of minutes after the event start time that the ticket can be scanned.		Example:
15
ticketDetails.checkInWindow.blockScan
Boolean value. A value of true will prevent scanning of tickets for this event at the venue. The tickets will not contain a barcode.		Example:
  • true
  • false
ticketDetails.checkInWindow.autoRebook
Boolean value. A value of true will enable tickets of an event template to be automatically rebooked upon scanning at Access Control. The new event must have enough capacity and be of the same event template. By default, this value is false.		Example:
  • true
  • false
ticketDetails.checkInWindow.purchaseAvailability
When is the event stops being available for sale.
ticketDetails.purchaseAvailability.timeFrame:
Valid values are 'when', 'before' and 'after' the event starts.		Example:
  • when
  • before
  • after
ticketDetails.purchaseAvailability.minutes:

Applicable when a timeFrame of 'before' or 'after' is used, in order to specify how many minutes. 

Note: If timeFrame is 'when', minutes is implied to be 0.

Example:
30
ticketDetails.ticketPrintLines[ ]
A set of string values that you want printed on the bottom of tickets generated for this event template. Up to 4 can be configured.		Example:

["Message 1", "Message 2", "Message 3", "Message 4"]


ticketDetails.hideEventDate:
Set to true if you don't want the date and time of the event to appear on the tickets. This is useful when the tickets are valid for multiple days.		Example:
  • true
  • false

Add On Object

Add Ons are also referred to as Inventory.


GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/slim
GET   /v2/b2c/event/templates/{Event Template ID}
GET   /v2/b2c/events/{Event Instance ID}


FieldExample
addOns[x].inventoryIds[ ]
List of inventory ids		Example:
[573, 3169]
addOns[x].inventoryAddOns[ ]
List of filled in inventory objects
addOns[x].inventoryAddOns[y].id (Read Only)
ID of the inventory item.		Example:
573
addOns[x].inventoryAddOns[y].name
The name of the inventory Item.		Example:
Audio Tour
addOns[x].inventoryAddOns[y].description
The description of the inventory Item. 		Example:
Personal headset
addOns[x].inventoryAddOns[y].sku
The SKU (Stock Keeping Unit) for the inventory item.		Example:
3838383
addOns[x].inventoryAddOns[y].price
The price of the inventory item.		Example:
8.00
addOns[x].inventoryAddOns[y].quantity
The number of inventory items (e.g. in a cart).		Example:
2
addOns[x].inventoryAddOns[y].type (Read Only)
The type of inventory item one of (doNotTrack, consumable or resource).		Example:
doNotTrack
addOns[x].inventoryAddOns[y].displayOrder
The order you want this item displayed in when you list the add ons.		Example:
0
addOns[x].inventoryAddOns[y].createdOn (Read Only)
The date that this item was created.		Example:
2023-01-01T00:00:00-00:00
addOns[x].inventoryAddOns[y].updatedOn (Read Only)
The time that this item was created.		Example:
2023-01-01T00:00:00-00:00
addOns[x].inventoryAddOns[y].salesChannels[ ]
A list of sales channels specifying which sales channels are enabled for this add on.
addOns[x].inventoryAddOns[y].salesChannels[z].name: (Read Only)
Name of the channel.		Example:
Web
addOns[x].inventoryAddOns[y].salesChannels[z].channel: (Read Only)
Label of the channel.		Example:
online
addOns[x].inventoryAddOns[y].salesChannels[z].enabled
Boolean value, true if enabled otherwise false.		Example:
  • true
  • false


Membership Entitlements/Rules Object

The Membership Entitlements/Rules Object contains the membership elements of the event template, such as which memberships are required to purchase the event and what discounts different memberships are eligible for.


If you are looking for the Membership Object when selling a membership, see Membership & Entitlement Objects.


GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/{Event Template ID}


ParameterExample
membership.restrictions
A list of membership levels that are eligible for this event template (aka Member Only Events). Gives the ability to create events that require specific levels of membership before you can attend.
membership.restrictions[x].id:
The ID of the membership category that you are allowing access to this event template		Example:

membership.restrictions[x].name: (Read Only)
The name of the membership category.		Example:
membership.restrictions[x].description: (Read Only)
The description of the membership category.		Example:

membership.restrictions[x].defaultType: (Read Only)

The defaultType of the membership category.		Example:

membership.restrictions[x].defaultType.id: (Read Only)

The id of the defaultType of the membership category.		Example:

membership.restrictions[x].defaultType.program: (Read Only)

The program of the defaultType of the membership category.		Example:

membership.restrictions[x].defaultType.category: (Read Only)

The category of the defaultType of the membership category.		Example:

membership.restrictions[x].defaultType.subcategory: (Read Only)

The subcategory of the defaultType of the membership category.		Example:

membership.restrictions[x].defaultType.level: (Read Only)

The level of the defaultType of the membership category.		Example:

membership.restrictions[x].types: (Read Only)

A list of membership types that are part of the membership category.		Example:

membership.restrictions[x].types[y].id: (Read Only)

The id of the membership type which is part of the membership category.		Example:

membership.restrictions[x].types[y].program: (Read Only)

The program of the membership type which is part of the membership category.		Example:

membership.restrictions[x].types[y].category: (Read Only)

The category of the membership type which is part of the membership category.		Example:

membership.restrictions[x].types[y].subcategory: (Read Only)

The subcategory of the membership type which is part of the membership category.		Example:

membership.restrictions[x].types[y].level: (Read Only)

The level of the membership type which is part of the membership category.		Example:
membership.discounts[ ]
A list of discounts associated with each membership.
membership.discounts[x].maxTickets: (Read Only) 
The maximum number of tickets this member can purchase at this discounted value.		Example:

membership.discounts[x].category

The membership category associated with this discount.

membership.discounts[x].category.id:

The id of the membership category you are giving a discount.		Example:

membership.discounts[x].category.name: (Read Only)


membership.discounts[x].category.description:(Read Only)


membership.discounts[x].category.defaultType:(Read Only)


membership.discounts[x].category.defaultType.id: (Read Only)


membership.discounts[x].category.defaultType.program: (Read Only)


membership.discounts[x].category.defaultType.category: (Read Only)


membership.discounts[x].category.defaultType.subcategory: (Read Only)


membership.discounts[x].category.defaultType.level: (Read Only)


membership.discounts[x].category.types: (Read Only)


membership.discounts[x].category.types[y].id: (Read Only)


membership.discounts[x].category.types[y].program: (Read Only)


membership.discounts[x].category.types[y].category: (Read Only)


membership.discounts[x].category.types[y].subcategory: (Read Only)


membership.discounts[x].category.types[y].level: (Read Only)


membership.discounts[x].discount (Read Only)

The details of the discount.

membership.discounts[x].discount.id:

The id of the discount you are giving this membership category..		Example:

membership.discounts[x].discount.code:(Read Only)


membership.discounts[x].discount.name: (Read Only)


membership.discounts[x].discount.description: (Read Only)


membership.discounts[x].discount.values[ ]


membership.discounts[x].discount.values[y].personTypeId: (Read Only)


membership.discounts[x].discount.values[y].personType: (Read Only)


membership.discounts[x].discount.values[y].discountType: (Read Only)


membership.discounts[x].discount.values[y].value: (Read Only)


membership.discounts[x].discount.values[y].tag: (Read Only)


membership.discounts[x].maxTickets: (Read Only) 
The maximum number of tickets this member can purchase at this discounted value.		Example:

Entitlement Configuration Object

The Entitlement Configuration Object contains details for non member ticket limits and member entitlements. You can learn more about configuring these in our Knowledge Base:


GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/{Event Template ID}


ParameterExample
id (Read Only)
The id of the entitlement config		Example:
49428e1f-2ab5-4bae-8c76-1b660513cb60
name
The name of the entitlement config		Example:
Any description
eventTemplateId
ID of the Event Template		Example:
  • true
  • false
entitlementConfig
Configuration details for member entitlements, which include discounts and ticket limits. This includes:
  • membershipLevels
  • pricepoints (aka Ticket Types)
  • discountCodes
  • quantity (aka Ticket Limit)
  • timeFrame

ticketRuleConfig
Configuration details for ticket limits per order / event time, which includes
  • pricepoints (aka Ticket Types)
  • quantity (aka Ticket Limit)
  • acrossOrder


Note: salesRuleConfig is not currently supported

Images Object

The images configured for an Event


GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/slim
GET   /v2/b2c/event/templates/{Event Template ID}
GET   /v2/b2c/events/{Event Instance ID}


ParameterExample
images[ ]
An array of images for this event.
images[x].id (Read Only)
The id of the image.		Example:
49428e1f-2ab5-4bae-8c76-1b660513cb60
images[x].description
A description of the image, which can be displayed as a caption. Recommend keeping descriptive and short.		Example:
A view of the venue entrance
images[x].primary
Boolean value for whether this is the primary image, which is displayed when listing the event. True if this is a primary image (the logo image), false otherwise. Default false.		Example:
  • true
  • false
images[x].thumbnail
images[x].highRes
images[x].screen
images[x].preview
Links to the various image sizes returned so you can optimize display and performance.		Example:

preview: "https://s3-us-west-1.amazonaws.com/acme-prod-images/49428e1f-2ab5-4bae-8c76-1b660513cb60_PV.png"


Resources Object

A list of resource specifications for an event instance. For example, if the event requires a tour guide that speaks French you would specify Tour Guide as the resource type and Language : French as a field definition. See Resource Management for more information.


GET   /v2/b2c/events/{Event Instance ID}


FieldExample
resources[x].type
The type of resource, like Tour Guide, etc...		Example:
  • Tour Guide
  • Dining Hall
  • Projector
  • ...
resources[x].resourceTemplateId
The ID of the resource template.
resources[x].resourceId
The id of the resource assigned to this event template. Generally this will be null and assigned at the event instance level.

resources[x].quantity
The number of resources that will be required.		Example:
2
resources[x].fields[ ] 
A list of name/value pairs of requirements for resources assigned to Event Instances.		Example:
Language=French
resources[x].fields[y].name
The name for the field, like Language.		Example:
Language
resources[x].fields[y].value
The value for the field, like French.		Example:
French

Resource Requests Object

A list of resource requests for an event template Schedule. For example, if the event template requires a tour guide that speaks French for every instance, you would specify Tour Guide as the resource type and Language : French as a field definition. See Resource Management for more information.


GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/{Event Template ID}


Information returned includes:

  • id
  • resourceTimeFrame
  • eventResource (resource requested)
  • notes
  • sendEmail (boolean)
  • eventResourceRequestType


More information coming soon.

Recommendations (Upsells) Object

A list of recommended events configured for a given event template.


GET   /v2/b2c/event/templates
GET   /v2/b2c/event/templates/slim
GET   /v2/b2c/event/templates/{Event Template ID}


FieldExample
recommendations[x].eventTemplateId:
Template ID to recommend after this one has been added to the shopping cart.		Example:
recommendations[x].min:
Amount of time it takes to get from this event to the recommended event. We won't recommend events that happen too early and make it difficult to get from the current event to the recommended event.		Example
recommendations[x].min.minutes:
Minimum number of minutes to allow between this event and the recommended event.		Example:
recommendations[x].min.hours:
Minimum number of hours to allow between this event and the recommended event.		Example:
recommendations[x].min.days:
Minimum number of days to allow between this event and the recommended event.		Example:
recommendations[x].min.endOfDay:
Boolean value for whether the the time period is extended to the end of the day. If the two events were both physically stressful and you wouldn't recommend doing them both on the same day then you might set the number of days to 1 and this value to true to recommend that they come back tomorrow for the recommended event.		Example:
recommendations[x].max:
Maximum amount of time to recommend the new event.		Example:
recommendations[x].max.minutes:
Maximum number of minutes to recommend the second event.		Example:
recommendations[x].max.hours:
Maximum hours of minutes to recommend the second event.		Example:
recommendations[x].max.days:
Maximum days of minutes to recommend the second event.		Example:
recommendations[x].max.endOfDay:
Boolean value for whether the the time period is extended to the end of the day.		Example:


Deprecated

Prerequisite (Dependencies) Object


operation:
Either allOf or anyOf.
  • allOf: All of the prerequisites must be met.
  • anyOf: Any one of the prerequisites must be met.
This object is deprecated
requires:
A list of requirements.
requires[x].eventTemplateId:
Template id of the required template.		This object is deprecated
requires[x].min:
Buffer time to allow between the end of the required template to the dependent template.  The amount of time it takes to get from the required event to the dependent template.		This object is deprecated
requires[x].min.minutes:
The number of minutes that you must have completed the prerequisite before you can buy tickets for this event.		This object is deprecated
requires[x].min.hours:
The hours of minutes that you must have completed the prerequisite before you can buy tickets for this event.		This object is deprecated
requires[x].min.days:
The days of minutes that you must have completed the prerequisite before you can buy tickets for this event.		This object is deprecated
requires[x].min.endOfDay:
Boolean value if set to true then will go to the end of the day for the number of days. So if you must have performed this prerequisite any time yesterday you set the min time to be 1 days and endOfDay to true.		This object is deprecated
requires[x].max:
Maximum amount of time to allow. You have to finish the required template less than this amount of time before you can take the dependent template. For instance if the required event is a daily pass, the max time might be 1 days and endOfDay.		This object is deprecated
requires[x].max.minutes:
The maximum number of minutes that you have after taking this prerequisite before going to the next event.		This object is deprecated
requires[x].max.hours:
The maximum number of hours that you have after taking this prerequisite before going to the next event.		This object is deprecated
requires[x].max.days:
The maximum number of days that you have after taking this prerequisite before going to the next event.		This object is deprecated
requires[x].max.endOfDay:
Boolean value for whether the the time period is extended to the end of the day. If it's a three day pass for instance you might set the days to 3 and endOfDay to true so that you go the entire way through the third day.		This object is deprecated
requires[x].name:  (Read Only)
The name of the prerequisite template.		This object is deprecated
prerequisites: 
The list of events that need to be attended before this event can be attended. See Prerequisites JSON Object below.
prerequisites.operation: 

Either allOf or anyOf.

  • allOf: All of the prerequisites must be met.
  • anyOf: Any one of the prerequisites must be met.
This object is deprecated


prerequisites.requires: 
A list of requirements.		This object is deprecated


prerequisites.requires[x].eventTemplateId: 
Template id of the required template.		This object is deprecated


prerequisites.requires[x].min: 
Buffer time to allow between the end of the required template to the dependent template.  The amount of time it takes to get from the required event to the dependent template.		This object is deprecated

prerequisites.requires[x].min.minutes: 
The number of minutes that you must have completed the prerequisite before you can buy tickets for this event.		This object is deprecated

prerequisites.requires[x].min.hours: 
The hours of minutes that you must have completed the prerequisite before you can buy tickets for this event.		This object is deprecated


prerequisites.requires[x].min.days: 
The days of minutes that you must have completed the prerequisite before you can buy tickets for this event.		This object is deprecated


prerequisites.requires[x].min.endOfDay: 
Boolean value if set to true then will go to the end of the day for the number of days. So if you must have performed this prerequisite any time yesterday you set the min time to be 1 days and endOfDay to true.		This object is deprecated

prerequisites.requires[x].max: 
Maximum amount of time to allow.  You have to finish the required template less than this amount of time before you can take the dependent template.  For instance if the required event is a daily pass, the max time might be 1 days and endOfDay.		This object is deprecated


prerequisites.requires[x].max.minutes: 
The maximum number of minutes that you have after taking this prerequisite before going to the next event.		This object is deprecated


prerequisites.requires[x].max.hours: 
The maximum number of hours that you have after taking this prerequisite before going to the next event.		This object is deprecated

prerequisites.requires[x].max.days: 
The maximum number of days that you have after taking this prerequisite before going to the next event.		This object is deprecated

prerequisites.requires[x].max.endOfDay: 
Boolean value for whether the the time period is extended to the end of the day. If it's a three day pass for instance you might set the days to 3 and endOfDay to true so that you go the entire way through the third day.		This object is deprecated

prerequisites.requires[x].name: 
The name of the prerequisite template.
This object is deprecated. Read Only