Events

Event objects represent an Event where tickets can be purchased for. Extended periods, like a season, are also represented through an event.

The Event object

The associated event which has been deleted

Required attributes

Name
_id
Type
string
Description
The ID of the event
Name
name
Type
string
Description
The name of the event
Name
start
Type
string
Description
An ISO timestamp indicating when the event starts
Name
end
Type
string
Description
An ISO timestamp indicating when the event ends
Name
maxAmount
Type
number
Description
Maximum amount of tickets of the event
Name
maxAmountPerOrder
Type
number
Description
Maximum amount of tickets per order of the event

Optional attributes

Name
sellerId
Type
string
Description
The ID of the seller owning this event
Name
slogan
Type
string
Description
The slogan of the event
Name
description
Type
string
Description
A description about the event. Description is in RichText - JSON format.
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
locationStreet
Type
string
Description
The street of the location where the event takes place
Name
locationCity
Type
string
Description
The city of the location where the event takes place
Name
locationPostal
Type
string
Description
The postal code of the location where the event takes place
Name
locationCountry
Type
string
Description
The country code of the location where the event takes place
Name
image
Type
string
Description
An image for the event
Name
ticketFooter
Type
string
Description
A footer image for the ticket PDF of the event
Name
ticketBackground
Type
string
Description
A background image for the ticket PDF of the event
Name
ticketShopHeader
Type
string
Description
A header image for the ticket shop of the event
Name
groups
Type
array<object>
Description
An array of groups of ticket types of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of of the ticket group of the event
Name
name
Type
string
Description
The name of the ticket group of the event
Name
tickets
Type
array<string>
Description
An array of ID's of ticket types of the event
Name
discountGroups
Type
array<object>
Description
An array of discount groups of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group of the event
Name
name
Type
string
Description
The name of the discount group of the event
Name
value
Type
number
Description
The value of the discount group
Optional nested attributes (2)
Name
rules
Type
array<object>
Description
An array of rules of the discount group
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group rule
Name
min
Type
number
Description
Minimum amount of tickets where the discount is valid
Name
max
Type
number
Description
Maximum amount of tickets where the discount is valid
Optional nested attributes (2)
Name
group
Type
string
Description
The ID of the discount group
Name
type
Type
enum(ticketGroups, cartSum)
Description
The type of the discount rule. ticketGroups is the type for tickets. cartSum is the type for sum of a cart
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the discount group. TOTAL = absolute discount. PERCENTAGE = percentage discount. fix = fixed discount. var = variable discount
Name
cartAutomationRules
Type
array<object>
Description
An array of automation rules for carts of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the cart automation rule
Name
name
Type
string
Description
The name of the automation rule for carts of the event
Name
triggerType
Type
enum(hasBeenAdded)
Description
The trigger type of the automation rule.
Name
triggerTargetGroup
Type
string
Description
The trigger target group of the rule. The ID of a ticket group
Name
thenType
Type
enum(autoAdd, chooseFrom)
Description
The type of thenType of the rule. autoAdd = is the type to add automatically to cart. chooseFrom = is the type to choose from e.g. another ticket group
Optional nested attributes (1)
Name
thenTargets
Type
array<object>
Description
The target of the then type
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the then target
Optional nested attributes (3)
Name
thenTargetGroup
Type
string
Description
The ID of the ticket group 'then' refers to
Name
thenTargetMin
Type
number
Description
Minimum amount of tickets where the then action is valid
Name
thenTargetMax
Type
number
Description
Maximum amount of tickets where the then action is valid
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the POS discount
Name
categories
Type
array<object>
Description
An array of ticket categories of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket category of the event
Name
name
Type
string
Description
The name of the ticket category of the event
Optional nested attributes (7)
Name
description
Type
string
Description
The description of the ticket category of the event
Name
seatingReference
Type
string
Description
The ID of the seating category
Name
ref
Type
string
Description
The reference to identify the seating category
Name
amount
Type
number
Description
The amount of available tickets of the category of the event
Name
recommendedTicket
Type
string
Description
Recommended ticket of the category
Name
maxAmountPerOrder
Type
number
Description
Maximum amount per order of the category
Name
listWithoutSeats
Type
boolean
Description
Whether this category can be sold without seats
Name
tickets
Type
array<object>
Description
An array of ticket types of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the ticket type of the event
Name
name
Type
string
Description
The name of the ticket type of the event
Name
price
Type
number
Description
The price of the ticket type of the event
Name
amount
Type
number
Description
The amount of the ticket type of the event
Name
active
Type
boolean
Description
Whether the ticket type of the event is active
Optional nested attributes (35)
Name
description
Type
string
Description
The description of the ticket type of the event
Name
image
Type
string
Description
The image of the ticket type of the event
Name
color
Type
string
Description
The font color of the ticket type of the event
Name
posActive
Type
boolean
Description
Whether POS for the ticket type of the event is active
Name
categoryRef
Type
string
Description
The reference of the category of the ticket type of the event
Name
ignoredForStartingPrice
Type
boolean
Description
Whether the price of the ticket type should be ignored on starting price determination of the event
Name
conditionalAvailability
Type
boolean
Description
Whether rules can be operated on the ticket type
Name
ticketBackground
Type
string
Description
The background for the ticket PDF of the ticket type
Name
rules
Type
array<object>
Description
An array of rules for the ticket type of the event
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the ticket type rule
Name
ticketGroup
Type
string
Description
The ID of the ticket group to operate the rule on
Name
min
Type
number
Description
Minimum amount of tickets where the rule is active
Name
max
Type
number
Description
Maximum amount of tickets where the rule is active
Name
requiresPersonalization
Type
boolean
Description
Deprecated, use `requiresPersonalizationMode` instead
Name
requiresPersonalizationMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs personalization
Name
requiresExtraFields
Type
boolean
Description
Deprecated, use `requiresExtraFieldsMode` instead
Name
requiresExtraFieldsMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs extra fields
Name
repersonalizationAllowedMode
Type
enum(ENABLED, DISABLED)
Description
Whether re-personalization (name changes) is allowed for this ticket type. When unset, inherits the event-level `repersonalizationAllowed`. Enables flex-ticket-like re-personalization without an addon.
Name
repersonalizationFee
Type
number
Description
The per-ticket fee for repersonalization.
Name
sortingKey
Type
number
Description
The key to sort the ticket type within the ticket group
Name
enableHardTicketOption
Type
boolean
Description
Whether the ticket type is a hard ticket
Name
forceHardTicketOption
Type
boolean
Description
Whether to force the hard ticket option
Name
maxAmountPerOrder
Type
number
Description
Maximum amount per order of the ticket type
Name
minAmountPerOrder
Type
number
Description
Minimum amount per order of the ticket type
Name
minAmountPerOrderRule
Type
number
Description
Minimum amount of the ticket type, where the minAmountPerOrder goes active
Name
taxRate
Type
number
Description
The tax rate of the ticket type of the event
Name
styleOptions
Type
object
Description
Style options of the ticket type
Optional nested attributes (3)
Name
thumbnailImage
Type
string
Description
Thumbnail of the ticket type, which will be displayed on checkout
Name
showAvailable
Type
boolean
Description
Whether to show availability of the ticket type
Name
hiddenInSelectionArea
Type
boolean
Description
Whether to show this ticket in the selection area
Name
priceCategoryId
Type
string
Description
The ID of the price category of the ticket type
Name
entryPermissions
Type
array<string>
Description
An array of IDs of entry permissions where the ticket buyer has access to certain areas
Name
ignoreForMaxAmounts
Type
boolean
Description
Do not include tickets if this typw when calculating available amount in categories and event
Name
expirationSettings
Type
object
Description
Expiration settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether expiration enabled for the event ticket types
Name
expiresAfter
Type
object
Description
If enabled = true. A relatve date specification until when ticket is valid.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
barcodePrefix
Type
string
Description
Characters that precede the barcodes of tickets.
Name
salesStart
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type starts
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesEnd
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type ends
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
transferSettings
Type
object
Description
Transfer settings of the ticket type.
Optional nested attributes (6)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
scanSettings
Type
object
Description
Scan settings of the ticket type.
Optional nested attributes (2)
Name
feedback
Type
enum(highlight)
Description
Feedback mode during scanning of the ticket
Name
allowedScanCount
Type
number
Description
Number of times a ticket is allowed to be scanned as valid
Name
deliverySettings
Type
object
Description
Delivery settings of the ticket type.
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
Type
object
Description
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
createdAt
Type
string
Description
An ISO timestamp indicating when the event was created
Name
updatedAt
Type
string
Description
An ISO timestamp indicating when the event was updated
Name
sellStart
Type
string
Description
An ISO timestamp indicating when the event sale starts
Name
sellEnd
Type
string
Description
An ISO timestamp indicating when the event sale ends
Name
maxAmountPerCustomer
Type
number
Description
Maximum amount of tickets per customer of the event
Name
maxTransactionsPerCustomer
Type
number
Description
Maximum amount of transactions per customer of the event
Name
minAmountPerOrder
Type
number
Description
Minimum amount of tickets per order
Name
customerTags
Type
array<string>
Description
An array of customer tags of the event
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the event
Name
showCountdown
Type
boolean
Description
Whether the countdown should be visible till event start
Name
hideInListing
Type
boolean
Description
Whether the event should be hide in listings
Name
visibleAfter
Type
string
Description
An ISO timestamp indicating when the event is visible in listings.
Name
customSettings
Type
object
Description
Custom settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom settings of the event
Optional nested attributes (22)
Name
hideTicketsInTransactionPage
Type
boolean
Description
Whether the ticket types of the event should be visible on transaction page
Name
dontSendTicketMail
Type
boolean
Description
Whether an email should be sent of tickets of the event
Name
dontSendBookingConfirmationMail
Type
boolean
Description
Whether an email should be sent for booking confirmation
Name
customMailHeaderImage
Type
string
Description
A custom header image of the mail for ticket types of the event
Name
customTransactionCompletionText
Type
string
Description
A custom transaction completion text for completed transactions of the event
Name
disableAppleWallet
Type
boolean
Description
Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead
Name
disablePdfTickets
Type
boolean
Description
Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInListing
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
customCheckoutCSS
Type
string
Description
Custom CSS styling of the checkout of the event
Name
useCustomCheckoutBrand
Type
boolean
Description
Whether the checkout of the event should use custom brand
Name
customCheckoutBrand
Type
string
Description
A custom checkout brand of the event
Name
hideLogoInCheckout
Type
boolean
Description
Whether the logo should be hide on the checkout of the event
Name
customEventPageHTML
Type
string
Description
A custom HTML of the event page
Name
customEventPageCSS
Type
string
Description
A custom css styling of the event page
Name
customConfirmationPage
Type
string
Description
A custom css styling of the event page
Name
hideSeatmapInCheckout
Type
boolean
Description
Hides the seatmap from the ticket buyer even if seating ticket types are available
Name
dontSendBookingConfirmationSMS
Type
boolean
Description
Whether a sms should be sent for booking confirmation
Name
extraFields
Type
array<object>
Description
An array of extra fields of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
oneOf
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
Name
ticketExtraFields
Type
array<object>
Description
An array of extra fields for ticket types of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
oneOf
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
Name
accentColor
Type
string
Description
The accent color of the event page
Name
pageStyle
Type
string
Description
The page style of the event page
Name
showOtherEvents
Type
boolean
Description
Whether other events should be displayed on the event page
Name
underShops
Type
array<object>
Description
An array of under shops of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the under shop of the event
Name
name
Type
string
Description
The name of the under shop of the event
Name
active
Type
boolean
Description
Whether the under shop is active
Optional nested attributes (25)
Name
tickets
Type
array<object>
Description
An array of ticket types of the under shop
Required nested attributes (6)
Name
_id
Type
string
Description
The ID of ticket type extension of the event under shop
Name
baseTicket
Type
string
Description
The ID of a ticket type of the event used as base ticket type
Name
name
Type
string
Description
The name of the ticket type
Name
price
Type
number
Description
The price of the ticket type
Name
amount
Type
number
Description
The amount of the ticket type
Name
active
Type
boolean
Description
Whether the ticket type is active
Optional nested attributes (1)
Name
description
Type
string
Description
The description of the ticket type
Name
categories
Type
array<object>
Description
The array of ticket categories of the under shop
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of ticket category extension
Name
baseCategoryId
Type
string
Description
The ID of a ticket category of the event used as base ticket category
Name
amount
Type
number
Description
The amount of the ticket category
Name
timeSlots
Type
array<object>
Description
The array of time slots of the under shop
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of time slot extension
Name
baseTimeSlotId
Type
string
Description
The ID of a time slot of the event used as base time slot
Name
amount
Type
number
Description
The amount of the time slot
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether the time slot enabled for under shop.
Name
sellStart
Type
string
Description
The sell start of the under shop. Optional for ROOT events only
Name
sellEnd
Type
string
Description
The sell end of the under shop. Optional for ROOT events only
Name
maxAmount
Type
number
Description
The maximum amount of tickets of the under shop
Name
maxAmountPerOrder
Type
number
Description
The maximum amount per order of the under shop
Name
minAmountPerOrder
Type
number
Description
The minimum amount per order of the under shop
Name
maxTransactionsPerCustomer
Type
number
Description
The maximum amount of transactions per customer of the under shop
Name
maxAmountPerCustomer
Type
number
Description
Maximum amount of tickets per customer of the event
Name
ticketShopHeaderText
Type
string
Description
The header of the ticket shop of the under shop
Name
customCharges
Type
object
Description
Custom charges of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number
Description
The fix cart outer charge of the custom charge
Name
seatingContingents
Type
array<string>
Description
An array of seating contingents of the under shop
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The availability mode of the shop
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating options of the under shop
Optional nested attributes (3)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
allowMassBooking
Type
boolean
Description
Whether the best available seating allows to buy seated tickets in bulk.
Name
reservationSettings
Type
object
Description
The reservation settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
accountSettings
Type
object
Description
Account settings of the under shop
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
customerTags
Type
array<string>
Description
An array of customer tags of the under shop
Name
customerSegments
Type
array<string>
Description
An array of customer segments of the under shop
Name
allowMassDownload
Type
boolean
Description
Enables option to download bulk tickets as a CSV or PDF file.
Name
inventoryStrategy
Type
enum(independent, subsidiary, global)
Description
Sets how available tickets will be calculated
Name
extraFields
Type
array<object>
Description
An array of extra fields of the under shop
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
oneOf
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the under shop
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
unlockMode
Type
enum(none, couponCode)
Description
Sets how event is locked, e.g. by coupon code.
Name
seating
Type
object
Description
The seating of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the seating
Name
active
Type
boolean
Description
Whether the seating is active
Optional nested attributes (8)
Name
eventKey
Type
string
Description
The key of the event of the seating
Name
eventId
Type
string
Description
The ID of the event of the seating
Name
seatMapId
Type
string
Description
The ID of the seat map of the event
Name
revisionId
Type
string
Description
The ID of the revision of the event
Name
orphanConfiguration
Type
object
Description
The orphan configuration of the seating
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the seating orphan configuration
Optional nested attributes (2)
Name
minSeatDistance
Type
number
Description
Minimum distance of seats to each other
Name
edgeSeatsOrphaning
Type
boolean
Description
Whether the edge seats can orphaning
Name
contingents
Type
array<string>
Description
An array of seating contingent ids
Name
availabilityMode
Type
enum(default, contingentsOnly)
Description
The seating availability mode
Name
bestAvailableSeatingConfiguration
Type
object
Description
The best available seating configuration of the seating
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether the best available seating is enabled
Name
enforced
Type
boolean
Description
Whether the best available seating is the only option to buy seated tickets. Seatmap won't be shown during checkout
Name
customTextConfig
Type
object
Description
The custom text configuration of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom text configuration
Optional nested attributes (1)
Name
buyTicketsCTA
Type
string
Description
The custom CTA after buy tickets
Name
eventType
Type
enum(SINGLE, GROUP, RECURRENCE, ROOT)
Description
The type of the event. SINGLE = it is a single event. GROUP = the event is part of a group of events
Name
childEvents
Type
array<string>
Description
An array of IDs of child events
Name
url
Type
string
Description
The url of the event
Name
tags
Type
array<string>
Description
An array of tags of the event
Name
seoSettings
Type
object
Description
The search engine optimization settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the SEO setting
Optional nested attributes (4)
Name
tags
Type
array<string>
Description
An array of tags of the seo settings
Name
noIndex
Type
boolean
Description
Whether the seo setting has no indexing
Name
title
Type
string
Description
The title of the seo settings
Name
description
Type
string
Description
The description of the seo settings
Name
extraInformation
Type
object
Description
The extra information of the event
Optional nested attributes (4)
Name
_id
Type
string
Description
The ID of the extra information of the event
Name
type
Type
string
Description
The type of the extra information of the event
Name
category
Type
string
Description
The category of the extra information of the event
Name
subCategory
Type
string
Description
The subCategory of the extra information of the event
Name
customCharges
Type
object
Description
Custom charges of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom charge
Optional nested attributes (7)
Name
outerChargeVar
Type
number
Description
The variable outer charge of the custom charge
Name
innerChargeVar
Type
number
Description
The variable inner charge of the custom charge
Name
outerChargeFix
Type
number
Description
The fix outer charge of the custom charge
Name
innerChargeFix
Type
number
Description
The fix inner charge of the custom charge
Name
posOuterChargeFix
Type
number
Description
The fix POS outer charge of the custom charge
Name
posOuterChargeVar
Type
number
Description
The variable POS outer charge of the custom charge
Name
cartOuterChargeFix
Type
number
Description
The fix cart outer charge of the custom charge
Name
gallery
Type
array<object>
Description
An array of gallery items of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the gallery item
Optional nested attributes (5)
Name
title
Type
string
Description
The title of the gallery item
Name
description
Type
string
Description
The description of the gallery item
Name
copyright
Type
string
Description
The copyright of the gallery item
Name
index
Type
number
Description
The index of the gallery item
Name
image
Type
string
Description
The image of the gallery item
Name
video
Type
object
Description
The video settings of the event
Optional nested attributes (1)
Name
youtubeID
Type
string
Description
The youtube video ID of the event video setting
Name
soldOutFallback
Type
object
Description
The sold out fallback of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of sold out entry
Optional nested attributes (2)
Name
soldOutFallbackType
Type
enum(default, moreinformation, waitinglist)
Description
Name
soldOutFallbackLink
Type
string
Description
The link of the sold out fallback
Name
ticketDesign
Type
object
Description
The ticket design settings for ticket types of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the ticket types design of the event
Optional nested attributes (8)
Name
useCustomDesign
Type
boolean
Description
Whether to use custom design on ticket types of event
Name
customDesignURL
Type
string
Description
The custom design URL for ticket types of event
Name
footerDesignURL
Type
string
Description
The footer design URL for ticket types of the event
Name
disclaimer
Type
string
Description
The disclaimer for ticket types of the event
Name
infoColor
Type
string
Description
The info color for ticket types of the event
Name
showTimeRange
Type
boolean
Description
Whether to show time range on ticket types of the event
Name
hideDates
Type
boolean
Description
Whether to hide dates on ticket types of the event
Name
hideTimes
Type
boolean
Description
Whether to hide the time on ticket types of the event
Name
checkinInformation
Type
object
Description
The checkin information of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the checkin information of the event
Optional nested attributes (1)
Name
checkinStarts
Type
string
Description
The date of when the checkin of the event starts
Name
tracking
Type
object
Description
The tracking of the event
Optional nested attributes (2)
Name
facebookPixel
Type
object
Description
The facebook pixel information of the event tracking
Optional nested attributes (2)
Name
active
Type
boolean
Description
Whether facebook pixel of event tracking is active
Name
pixelId
Type
string
Description
The ID of facebook pixel of the event tracking
Name
tagging
Type
object
Description
The tagging of the event tracking
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether tagging of event tracking is enabled
Name
tags
Type
array<string>
Description
An array of tags of the event tracking
Name
hardTicketSettings
Type
object
Description
The hard ticket settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the event hard ticket settings
Optional nested attributes (9)
Name
enabled
Type
boolean
Description
Whether hard tickets can be bought for this event
Name
fulfillmentType
Type
enum(self, managed)
Description
The type of fulfillment. self fulfilled by the seller. managed fulfilled by vivenu.
Name
printingMethod
Type
enum(preprinted, adhoc)
Description
Which printing method is used. preprinted = The tickets are preprinted. adhoc = The tickets are printed ad-hoc.
Name
hardTicketOuterCharge
Type
number
Description
Additional charge for every hard ticket that is added to the ticket price and the other outer charges - paid by the ticket buyer.
Name
hardTicketInnerCharge
Type
number
Description
Additional charge for hard tickets as in the contract of the seller
Name
hardTicketPreviewURL
Type
string
Description
The hard ticket design image
Name
promotionName
Type
string
Description
A special name for hard tickets. e.g. "Collector edition"
Name
promotionText
Type
string
Description
A description about what makes this ticket so special
Name
requiredDays
Type
integer
Description
Required days until deliver of the hard tickets
Name
dataRequestSettings
Type
object
Description
The data request settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the data request settings of the event
Optional nested attributes (12)
Name
requiresPersonalization
Type
boolean
Description
Whether the tickets for this event need personalization
Name
requiresExtraFields
Type
boolean
Description
Whether the tickets for this event need extra data fields
Name
repersonalization
Type
boolean
Description
Whether the tickets can be re personalized.
Name
repersonalizationAllowed
Type
boolean
Description
Whether the tickets can be re personalized.
Name
repersonalizationEndDate
Type
string
Description
If repersonalization = true. Until when the re personalization is allowed.
Name
repersonalizationDeadline
Type
object
Description
If repersonalization = true. A relatve date specification until when the re personalization is allowed.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
repersonalizationFee
Type
number
Description
If repersonalization = true. The per-ticket fee for repersonalization.
Name
repersonalizationsLimit
Type
number
Description
If repersonalization = true. The number of times repersonalization is allowed.
Name
limitOnlyNameChanges
Type
boolean
Description
If enabled, only name changes count towards the re-personalization limit for every ticket type of the event. Extra fields can always be updated until the re-personalization deadline.
Name
posPersonalization
Type
enum(noPersonalization, optionalPersonalization, requiredPersonalization)
Description
The type of personalization for this event on Point of Sale applications.
Name
skipAddressInfo
Type
boolean
Description
Whether the checkout should not ask for the address of the ticket buyer.
Name
enforceCompany
Type
boolean
Description
Whether the company of the ticket buyer is a required field.
Name
styleOptions
Type
object
Description
Style options of the event page
Optional nested attributes (10)
Name
headerStyle
Type
string
Description
Header style of the event page
Name
brandOne
Type
string
Description
First brand of the event
Name
brandTwo
Type
string
Description
Second brand of the event
Name
hideLocationMap
Type
boolean
Description
Whether the location map on the event page hide
Name
hideLocationAddress
Type
boolean
Description
Whether the location address on the event page hide
Name
categoryAlignment
Type
enum(cascade, asTabs, boxes, ticketWizard, 0, 1, 2, 3)
Description
The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured.
Name
showAvailabilityIndicator
Type
boolean
Description
Whether the availability indicator on the event page should be shown
Name
availabilityIndicatorThresholds
Type
array<number>
Description
The availability indicator thresholds of the event
Name
showAvailable
Type
boolean
Description
Whether to show availability of the time slot. Only applicable for time slot events.
Name
timeSlotsCheckoutSelection
Type
enum(beforeTickets, afterTickets)
Description
Time slots selection in checkout.
Name
geoCode
Type
object
Description
The geographic code of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the geo code
Name
lat
Type
number
Description
Latitude coordinate of the geo code
Name
lng
Type
number
Description
Longitude coordinate of the geo code
Name
accountSettings
Type
object
Description
Account settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
reservationSettings
Type
object
Description
The reservation settings of event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
upsellSettings
Type
object
Description
The upsell settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the upsell settings of the event
Optional nested attributes (4)
Name
active
Type
boolean
Description
Whether upselling is active on the event
Name
productStream
Type
string
Description
The product stream for upselling
Name
headerImage
Type
string
Description
A header image for the ticket shop, when selecting products
Name
crossSells
Type
object
Description
The cross selling settings.
Optional nested attributes (1)
Name
eventIds
Type
array<string>
Description
The array of the promoted event IDs.
Name
repetitionSettings
Type
array<object>
Description
The repetition settings of the event
Required nested attributes (4)
Name
every
Type
number
Description
Repeat event every unit of time
Name
unit
Type
enum(DAY, WEEK, MONTH)
Description
Unit of repetition - day, week, month
Name
from
Type
string
Description
Repeat event from date
Name
to
Type
string
Description
Repeat event till date
Optional nested attributes (1)
Name
repeatsOn
Type
array<enum(SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY)>
Description
Days of a week when the event is repeated
Name
rootId
Type
string
Description
The id of the root event
Name
daySchemes
Type
array<object>
Description
The possible day schemas of how event could be sold
Name
daySchemeId
Type
string
Description
The ID of the day scheme assigned to the event.
Name
ticketSettings
Type
object
Description
The event ticket settings
Optional nested attributes (8)
Name
cancellationStrategy
Type
enum(disabled, freeTicketsOnly, withoutRefund)
Description
Cancellation strategy of the ticket types
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the event.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
Type
object
Description
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
transferSettings
Type
object
Description
Transfer settings of the ticket types
Optional nested attributes (7)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
useSeasonCardTemplate
Type
boolean
Description
Whether to use the season card template for individual tickets transferred from the season.
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesStart
Type
object
Description
A relative date specification of sales start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
barcodeSettings
Type
object
Description
Barcode settings
Optional nested attributes (1)
Name
issueOfflineBarcodes
Type
enum(ENABLED, DISABLED)
Description
Whether offline barcodes are enabled
Name
childEventMapping
Type
array<object>
Description
Child event mapping
Required nested attributes (2)
Name
childEventId
Type
string
Description
The child event for this mapping
Name
ticketTypeMapping
Type
object
Description
Mapping between ticket types of the parent event and the child events
Optional nested attributes (1)
Name
valueShare
Type
number
Description
The percentage value of this child event from the value of the parent event
Name
seasonCardValueStrategy
Type
enum(childValue, averagePerChild, sharePerChild)
Description
The strategy used to determine the value of a child event in the context of the parent event
Name
accessListMapping
Type
array<object>
Description
The array represents a mapping between access list ids and ticket type ids for which a ticket will be created.
Required nested attributes (2)
Name
listId
Type
string
Description
The ID of the access list.
Name
ticketTypeId
Type
string
Description
The ID of the ticket type.
Name
deliverySettings
Type
object
Description
Delivery Settings
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (3)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
nfc
Type
enum(ENABLED, DISABLED)
Description
Name
seasonCardShowNextEvent
Type
boolean
Description
Whether to display the information for next event of the season event on a wallet ticket or not. If activated, the information of the next event will be displayed on the wallet ticket instead of the season event.
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
timezone
Type
string
Description
Timezone of event
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the event
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
timeSlots
Type
array<object>
Description
The time slots for the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the time slot
Name
startTime
Type
object
Description
The time of day the time slot starts
Required nested attributes (2)
Name
hour
Type
integer
Description
Name
minute
Type
integer
Description
Name
refs
Type
array<object>
Description
The ticket references for the time slot
Required nested attributes (2)
Name
refType
Type
enum(category)
Description
The type of the reference
Name
categoryRef
Type
string
Description
The ticket category reference to use for the time slot
Optional nested attributes (1)
Name
amount
Type
number
Description
The amount of available tickets of the time slot of the event
Name
useTimeSlots
Type
boolean
Description
Whether the event uses time slots.
Name
attributes
Type
object
Description

Example

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

POST/api/events

Create an Event

Payload

Required attributes

Name
name
Type
string
Description
Name
description
Type
string
Description

Optional attributes

Name
slogan
Type
string
Description
Name
locationName
Type
string
Description
Name
locationStreet
Type
string
Description
Name
locationCity
Type
string
Description
Name
locationPostal
Type
string
Description
Name
locationCountry
Type
string
Description
Name
groups
Type
array<oneOf>
Description
Name
discountGroups
Type
array<oneOf>
Description
Name
posDiscounts
Type
array<oneOf>
Description
Name
categories
Type
array<oneOf>
Description
Name
tickets
Type
array<oneOf>
Description
Name
image
Type
string
Description
Name
ticketFooter
Type
string
Description
Name
ticketShopHeader
Type
string
Description
Name
start
Type
oneOf
Description
Name
end
Type
oneOf
Description
Name
timezone
Type
string
Description
Name
sellStart
Type
string
Description
Name
sellEnd
Type
string
Description
Name
pricingSettings
Type
object
Description
Optional nested attributes (3)
Name
priceTableId
Type
string
Description
Name
priceTableTierId
Type
string
Description
Name
dynamicPricing
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Name
taxSettings
Type
object
Description
Optional nested attributes (1)
Name
defaultTicketTaxServiceTypeId
Type
string
Description
Name
rebookingSettings
Type
object
Description
Optional nested attributes (1)
Name
rebookingStrategyId
Type
string
Description
Name
maxAmount
Type
number
Description
Name
maxAmountPerOrder
Type
number
Description
Name
maxAmountPerCustomer
Type
number
Description
Name
maxTransactionsPerCustomer
Type
number
Description
Name
minAmountPerOrder
Type
number
Description
Name
customerTags
Type
array<string>
Description
Name
customerSegments
Type
array<string>
Description
Name
showCountdown
Type
boolean
Description
Name
hideInListing
Type
boolean
Description
Name
visibleAfter
Type
string
Description
Name
customSettings
Type
object
Description
Name
extraFields
Type
array<oneOf>
Description
Name
ticketExtraFields
Type
array<oneOf>
Description
Name
accentColor
Type
string
Description
Name
pageStyle
Type
string
Description
Name
showOtherEvents
Type
boolean
Description
Name
underShops
Type
array<oneOf>
Description
Name
seating
Type
object
Description
Name
eventType
Type
string
Description
Name
extraInformation
Type
object
Description
Name
customCharges
Type
object
Description
Name
gallery
Type
array<oneOf>
Description
Name
video
Type
object
Description
Name
ticketDesign
Type
object
Description
Name
checkinInformation
Type
object
Description
Name
tracking
Type
object
Description
Name
hardTicketSettings
Type
object
Description
Name
customTextConfig
Type
object
Description
Name
documentTemplateSettings
Type
object
Description
Name
dataRequestSettings
Type
object
Description
Name
timeSlots
Type
array<object>
Description
The time slots for the event
Required nested attributes (2)
Name
startTime
Type
object
Description
The time of day the time slot starts
Required nested attributes (2)
Name
hour
Type
integer
Description
Name
minute
Type
integer
Description
Name
refs
Type
array<object>
Description
The ticket references for the time slot
Required nested attributes (2)
Name
refType
Type
enum(category)
Description
The type of the reference
Name
categoryRef
Type
string
Description
The ticket category reference to use for the time slot
Optional nested attributes (2)
Name
_id
Type
string
Description
The ID of the time slot
Name
amount
Type
number
Description
The amount of available tickets of the time slot of the event
Name
useTimeSlots
Type
boolean
Description
Name
ticketSettings
Type
object
Description
Optional nested attributes (2)
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesStart
Type
object
Description
A relative date specification of sales start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
attributes
Type
object
Description
Name
seoSettings
Type
object
Description

Request

POST

/api/events

const response = await fetch('https://vivenu.com/api/events', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "name": "Example Name",
    "description": "string",
    "slogan": "string",
    "locationName": "string",
    "locationStreet": "string",
    "locationCity": "string",
    "locationPostal": "string",
    "locationCountry": "string",
    "groups": [
      "string"
    ],
    "discountGroups": [
      "string"
    ],
    "posDiscounts": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "tickets": [
      "string"
    ],
    "image": "string",
    "ticketFooter": "string",
    "ticketShopHeader": "string",
    "start": "ROOT",
    "end": "ROOT",
    "timezone": "2030-01-23T23:00:00.123Z",
    "sellStart": "2030-01-23T23:00:00.123Z",
    "sellEnd": "2030-01-23T23:00:00.123Z",
    "pricingSettings": {
      "priceTableId": "507f191e810c19729de860ea",
      "priceTableTierId": "507f191e810c19729de860ea",
      "dynamicPricing": {
        "enabled": true
      }
    },
    "taxSettings": {
      "defaultTicketTaxServiceTypeId": "507f191e810c19729de860ea"
    },
    "rebookingSettings": {
      "rebookingStrategyId": "507f191e810c19729de860ea"
    },
    "maxAmount": 10.5,
    "maxAmountPerOrder": 10.5,
    "maxAmountPerCustomer": 10.5,
    "maxTransactionsPerCustomer": 10.5,
    "minAmountPerOrder": 10.5,
    "customerTags": [
      "string"
    ],
    "customerSegments": [
      "string"
    ],
    "showCountdown": true,
    "hideInListing": true,
    "visibleAfter": "2030-01-23T23:00:00.123Z",
    "customSettings": {},
    "extraFields": [
      "string"
    ],
    "ticketExtraFields": [
      "string"
    ],
    "accentColor": "string",
    "pageStyle": "string",
    "showOtherEvents": true,
    "underShops": [
      "string"
    ],
    "seating": {},
    "eventType": "string",
    "extraInformation": {},
    "customCharges": {},
    "gallery": [
      "string"
    ],
    "video": {},
    "ticketDesign": {},
    "checkinInformation": {},
    "tracking": {},
    "hardTicketSettings": {},
    "customTextConfig": {},
    "documentTemplateSettings": {},
    "dataRequestSettings": {},
    "timeSlots": [
      {
        "startTime": {
          "hour": 1,
          "minute": 1
        },
        "refs": [
          {
            "refType": "category",
            "categoryRef": "string"
          }
        ],
        "_id": "507f191e810c19729de860ea",
        "amount": 10.5
      }
    ],
    "useTimeSlots": true,
    "ticketSettings": {
      "upgradeSettings": {
        "enabled": "ENABLED",
        "underShopMapping": [
          {
            "type": "tag",
            "tag": "string",
            "underShopId": "507f191e810c19729de860ea"
          }
        ]
      },
      "resellSettings": {
        "enabled": "ENABLED",
        "resellerFeeFix": 10.5,
        "resellerFeeVar": 10.5,
        "buyerFeeFix": 10.5,
        "buyerFeeVar": 10.5,
        "offerCreationStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "offerCreationEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "priceMarkup": 10.5,
        "cartAutomationMode": "BLOCKED"
      }
    },
    "meta": {},
    "attributes": {},
    "seoSettings": {}
  }),
})

const data = await response.json()

Response (201)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

GET/api/events/:id

Get an Event

Request

GET

/api/events/:id

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

PUT/api/events/:id

Update an Event

Payload

Optional attributes

Name
name
Type
string
Description
Name
description
Type
string
Description
Name
slogan
Type
string
Description
Name
locationName
Type
string
Description
Name
locationStreet
Type
string
Description
Name
locationCity
Type
string
Description
Name
locationPostal
Type
string
Description
Name
locationCountry
Type
string
Description
Name
groups
Type
array<oneOf>
Description
Name
discountGroups
Type
array<oneOf>
Description
Name
posDiscounts
Type
array<oneOf>
Description
Name
rules
Type
array<oneOf>
Description
Name
categories
Type
array<oneOf>
Description
Name
tickets
Type
array<object>
Description
Optional nested attributes (1)
Name
barcodePrefix
Type
string
Description
Name
image
Type
string
Description
Name
ticketFooter
Type
string
Description
Name
ticketBackground
Type
string
Description
Name
ticketShopHeader
Type
string
Description
Name
start
Type
string
Description
Name
end
Type
string
Description
Name
timezone
Type
string
Description
Name
sellStart
Type
string
Description
Name
sellEnd
Type
string
Description
Name
pricingSettings
Type
object
Description
Optional nested attributes (3)
Name
priceTableId
Type
string
Description
Name
priceTableTierId
Type
string
Description
Name
dynamicPricing
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Name
taxSettings
Type
object
Description
Optional nested attributes (1)
Name
defaultTicketTaxServiceTypeId
Type
string
Description
Name
maxAmount
Type
number
Description
Name
maxAmountPerOrder
Type
number
Description
Name
maxAmountPerCustomer
Type
number
Description
Name
maxTransactionsPerCustomer
Type
number
Description
Name
minAmountPerOrder
Type
number
Description
Name
customerTags
Type
array<string>
Description
Name
customerSegments
Type
array<string>
Description
Name
showCountdown
Type
boolean
Description
Name
hideInListing
Type
boolean
Description
Name
visibleAfter
Type
string
Description
Name
customSettings
Type
object
Description
Name
extraFields
Type
array<oneOf>
Description
Name
ticketExtraFields
Type
array<oneOf>
Description
Name
accentColor
Type
string
Description
Name
pageStyle
Type
string
Description
Name
showOtherEvents
Type
boolean
Description
Name
underShops
Type
array<oneOf>
Description
Name
seating
Type
object
Description
Name
eventType
Type
string
Description
Name
childEvents
Type
array<oneOf>
Description
Name
url
Type
string
Description
Name
tags
Type
array<oneOf>
Description
Name
seoSettings
Type
object
Description
Name
extraInformation
Type
object
Description
Name
customCharges
Type
object
Description
Name
gallery
Type
array<oneOf>
Description
Name
video
Type
object
Description
Name
ticketDesign
Type
object
Description
Name
checkinInformation
Type
object
Description
Name
tracking
Type
object
Description
Name
hardTicketSettings
Type
object
Description
Name
customTextConfig
Type
object
Description
Name
upsellSettings
Type
object
Description
Name
documentTemplateSettings
Type
object
Description
Name
daySchemes
Type
array<object>
Description
Optional nested attributes (4)
Name
_id
Type
string
Description
The ID of the day scheme.
Name
name
Type
string
Description
The name of the day scheme.
Name
color
Type
string
Description
The color of the day scheme.
Name
offers
Type
object
Description
Offers of the day scheme.
Optional nested attributes (3)
Name
allTicketTypesActive
Type
boolean
Description
Whether the all ticket types active.
Name
ticketTypes
Type
array<object>
Description
The day scheme offer ticket types.
Required nested attributes (1)
Name
ticketTypeId
Type
string
Description
The ticket type id which could be sold.
Optional nested attributes (1)
Name
active
Type
boolean
Description
Whether the ticket type is selling.
Name
timeSlots
Type
array<object>
Description
Time slots overrides.
Required nested attributes (1)
Name
slotId
Type
string
Description
The slotId of the time slot.
Optional nested attributes (2)
Name
enabled
Type
string
Description
Whether the slot is enabled.
Name
amount
Type
number
Description
The amount of available tickets of the time slot of the day scheme.
Name
daySchemeId
Type
string
Description
Name
feeSettings
Type
object
Description
Name
subscriptionSettings
Type
object
Description
Name
accessListMapping
Type
array<oneOf>
Description
Name
deliverySettings
Type
object
Description
Delivery Settings
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (3)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
nfc
Type
enum(ENABLED, DISABLED)
Description
Name
seasonCardShowNextEvent
Type
boolean
Description
Whether to display the information for next event of the season event on a wallet ticket or not. If activated, the information of the next event will be displayed on the wallet ticket instead of the season event.
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
dataRequestSettings
Type
object
Description
Name
salesChannelGroupSettings
Type
array<object>
Description
An array of sales channel group settings associated with the event
Required nested attributes (1)
Name
salesChannelGroupId
Type
string
Description
The ID of the associated sales channel group
Optional nested attributes (1)
Name
enabled
Type
boolean
Description
Whether the sales channel group is enabled
Name
paymentSettings
Type
object
Description
The payment settings of the event
Optional nested attributes (1)
Name
paymentStrategyId
Type
string
Description
The ID of the associated payment strategy
Name
timeSlots
Type
array<object>
Description
The time slots for the event
Required nested attributes (2)
Name
startTime
Type
object
Description
The time of day the time slot starts
Required nested attributes (2)
Name
hour
Type
integer
Description
Name
minute
Type
integer
Description
Name
refs
Type
array<object>
Description
The ticket references for the time slot
Required nested attributes (2)
Name
refType
Type
enum(category)
Description
The type of the reference
Name
categoryRef
Type
string
Description
The ticket category reference to use for the time slot
Optional nested attributes (2)
Name
_id
Type
string
Description
The ID of the time slot
Name
amount
Type
number
Description
The amount of available tickets of the time slot of the event
Name
useTimeSlots
Type
boolean
Description
Name
ticketSettings
Type
object
Description
Optional nested attributes (4)
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
childEventMapping
Type
array<object>
Description
Child event mapping
Required nested attributes (2)
Name
childEventId
Type
string
Description
The child event for this mapping
Name
ticketTypeMapping
Type
object
Description
Mapping between ticket types of the parent event and the child events
Optional nested attributes (1)
Name
valueShare
Type
number
Description
The percentage value of this child event from the value of the parent event
Name
seasonCardValueStrategy
Type
enum(childValue, averagePerChild, sharePerChild)
Description
The strategy used to determine the value of a child event in the context of the parent event
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesStart
Type
object
Description
A relative date specification of sales start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
attributes
Type
object
Description

Request

PUT

/api/events/:id

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "name": "Example Name",
    "description": "string",
    "slogan": "string",
    "locationName": "string",
    "locationStreet": "string",
    "locationCity": "string",
    "locationPostal": "string",
    "locationCountry": "string",
    "groups": [
      "string"
    ],
    "discountGroups": [
      "string"
    ],
    "posDiscounts": [
      "string"
    ],
    "rules": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "tickets": [
      {
        "barcodePrefix": "string"
      }
    ],
    "image": "string",
    "ticketFooter": "string",
    "ticketBackground": "string",
    "ticketShopHeader": "string",
    "start": "2030-01-23T23:00:00.123Z",
    "end": "2030-01-23T23:00:00.123Z",
    "timezone": "2030-01-23T23:00:00.123Z",
    "sellStart": "2030-01-23T23:00:00.123Z",
    "sellEnd": "2030-01-23T23:00:00.123Z",
    "pricingSettings": {
      "priceTableId": "507f191e810c19729de860ea",
      "priceTableTierId": "507f191e810c19729de860ea",
      "dynamicPricing": {
        "enabled": true
      }
    },
    "taxSettings": {
      "defaultTicketTaxServiceTypeId": "507f191e810c19729de860ea"
    },
    "maxAmount": 10.5,
    "maxAmountPerOrder": 10.5,
    "maxAmountPerCustomer": 10.5,
    "maxTransactionsPerCustomer": 10.5,
    "minAmountPerOrder": 10.5,
    "customerTags": [
      "string"
    ],
    "customerSegments": [
      "string"
    ],
    "showCountdown": true,
    "hideInListing": true,
    "visibleAfter": "2030-01-23T23:00:00.123Z",
    "customSettings": {},
    "extraFields": [
      "string"
    ],
    "ticketExtraFields": [
      "string"
    ],
    "accentColor": "string",
    "pageStyle": "string",
    "showOtherEvents": true,
    "underShops": [
      "string"
    ],
    "seating": {},
    "eventType": "string",
    "childEvents": [
      "string"
    ],
    "url": "https://example.com",
    "tags": [
      "string"
    ],
    "seoSettings": {},
    "extraInformation": {},
    "customCharges": {},
    "gallery": [
      "string"
    ],
    "video": {},
    "ticketDesign": {},
    "checkinInformation": {},
    "tracking": {},
    "hardTicketSettings": {},
    "customTextConfig": {},
    "upsellSettings": {},
    "documentTemplateSettings": {},
    "daySchemes": [],
    "daySchemeId": "507f191e810c19729de860ea",
    "feeSettings": {},
    "subscriptionSettings": {},
    "accessListMapping": [
      "string"
    ],
    "deliverySettings": {
      "wallet": {
        "enabled": "ENABLED",
        "nfc": "ENABLED",
        "seasonCardShowNextEvent": true
      },
      "pdf": {
        "enabled": "ENABLED"
      }
    },
    "dataRequestSettings": {},
    "salesChannelGroupSettings": [
      {
        "salesChannelGroupId": "507f191e810c19729de860ea",
        "enabled": true
      }
    ],
    "paymentSettings": {
      "paymentStrategyId": "507f191e810c19729de860ea"
    },
    "timeSlots": [
      {
        "startTime": {
          "hour": 1,
          "minute": 1
        },
        "refs": [
          {
            "refType": "category",
            "categoryRef": "string"
          }
        ],
        "_id": "507f191e810c19729de860ea",
        "amount": 10.5
      }
    ],
    "useTimeSlots": true,
    "ticketSettings": {
      "upgradeSettings": {
        "enabled": "ENABLED",
        "underShopMapping": [
          {
            "type": "tag",
            "tag": "string",
            "underShopId": "507f191e810c19729de860ea"
          }
        ]
      },
      "childEventMapping": [
        {
          "childEventId": "507f191e810c19729de860ea",
          "ticketTypeMapping": {},
          "valueShare": 10.5
        }
      ],
      "seasonCardValueStrategy": "childValue",
      "resellSettings": {
        "enabled": "ENABLED",
        "resellerFeeFix": 10.5,
        "resellerFeeVar": 10.5,
        "buyerFeeFix": 10.5,
        "buyerFeeVar": 10.5,
        "offerCreationStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "offerCreationEnd": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "salesStart": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        },
        "priceMarkup": 10.5,
        "cartAutomationMode": "BLOCKED"
      }
    },
    "meta": {},
    "attributes": {}
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

DELETE/api/events/:id

Delete an Event

Request

DELETE

/api/events/:id

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea', {
  method: 'DELETE',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

POST/api/events/duplicate

Duplicate an Event

Request

POST

/api/events/duplicate

const response = await fetch('https://vivenu.com/api/events/duplicate', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "_id": "507f191e810c19729de860ea",
    "name": "Example Name",
    "eventType": "ROOT",
    "image": "string",
    "duplicateContingents": true,
    "revisionId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "salesChannelGroupSettings": [
      {
        "salesChannelGroupId": "507f191e810c19729de860ea",
        "enabled": true
      }
    ],
    "start": [],
    "end": [],
    "sellStart": [],
    "sellEnd": []
  }),
})

const data = await response.json()

Response (201)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

POST/api/events/:id/seating

Set the seating event id of an event

Payload

Required attributes

Name
seatMapId
Type
string
Description
Name
revisionId
Type
string
Description

Request

POST

/api/events/:id/seating

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea/seating', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea"
  }),
})

const data = await response.json()

GET/api/events

Get all Events

Query parameters

Required query parameters

Name
top
Type
integer
Description
A limit on the number of objects to be returned. Can range between 1 and 1000.
Name
skip
Type
integer
Description
The number of objects to skip for the requested result

Optional query parameters

Name
name
Type
string
Description
Name
start
Type
object
Description
Name
end
Type
object
Description
Name
sortDir
Type
enum(1, -1)
Description
Name
rootId
Type
string
Description
Name
type
Type
anyOf
Description
Name
sellerId
Type
string
Description
Name
groupEventId
Type
string
Description
Name
salesChannelId
Type
string
Description
Name
childEvents
Type
anyOf
Description
Name
subscriptionPlanId
Type
string
Description
Name
updatedAt
Type
object
Description
Name
createdAt
Type
object
Description

Request

GET

/api/events

const response = await fetch('https://vivenu.com/api/events?top=1&skip=1&name=Example+Name&start=value&end=value&sortDir=1&rootId=507f191e810c19729de860ea&type=value&sellerId=507f191e810c19729de860ea&groupEventId=507f191e810c19729de860ea&salesChannelId=507f191e810c19729de860ea&childEvents=value&subscriptionPlanId=507f191e810c19729de860ea&updatedAt=2030-01-23T23%3A00%3A00.123Z&createdAt=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "rows": [],
  "total": 1
}

GET/api/events/:id/parents

Get Event parents

Request

GET

/api/events/:id/parents

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea/parents', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

[]

The Event Info object

You can retrieve the Event info object with the Get Event info endpoint. This API provides information about how and with which settings you sell an event's tickets.

Required attributes

Name
_id
Type
string
Description
The ID of the event
Name
name
Type
string
Description
The name of the event
Name
start
Type
string
Description
An ISO timestamp indicating when the event starts
Name
end
Type
string
Description
An ISO timestamp indicating when the event ends

Optional attributes

Name
url
Type
string
Description
The url of the event
Name
slogan
Type
string
Description
The slogan of the event
Name
description
Type
string
Description
A description about the event. Description is in RichText - JSON format.
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the POS discount
Name
categories
Type
array<object>
Description
An array of ticket categories of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the ticket category of the event
Name
name
Type
string
Description
The name of the ticket category of the event
Optional nested attributes (7)
Name
description
Type
string
Description
The description of the ticket category of the event
Name
seatingReference
Type
string
Description
The ID of the seating category
Name
ref
Type
string
Description
The reference to identify the seating category
Name
amount
Type
number
Description
The amount of available tickets of the category of the event
Name
recommendedTicket
Type
string
Description
Recommended ticket of the category
Name
maxAmountPerOrder
Type
number
Description
Maximum amount per order of the category
Name
listWithoutSeats
Type
boolean
Description
Whether this category can be sold without seats
Name
groups
Type
array<object>
Description
An array of groups of ticket types of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of of the ticket group of the event
Name
name
Type
string
Description
The name of the ticket group of the event
Name
tickets
Type
array<string>
Description
An array of ID's of ticket types of the event
Name
cartAutomationRules
Type
array<object>
Description
An array of automation rules for carts of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the cart automation rule
Name
name
Type
string
Description
The name of the automation rule for carts of the event
Name
triggerType
Type
enum(hasBeenAdded)
Description
The trigger type of the automation rule.
Name
triggerTargetGroup
Type
string
Description
The trigger target group of the rule. The ID of a ticket group
Name
thenType
Type
enum(autoAdd, chooseFrom)
Description
The type of thenType of the rule. autoAdd = is the type to add automatically to cart. chooseFrom = is the type to choose from e.g. another ticket group
Optional nested attributes (1)
Name
thenTargets
Type
array<object>
Description
The target of the then type
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the then target
Optional nested attributes (3)
Name
thenTargetGroup
Type
string
Description
The ID of the ticket group 'then' refers to
Name
thenTargetMin
Type
number
Description
Minimum amount of tickets where the then action is valid
Name
thenTargetMax
Type
number
Description
Maximum amount of tickets where the then action is valid
Name
discountGroups
Type
array<object>
Description
An array of discount groups of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group of the event
Name
name
Type
string
Description
The name of the discount group of the event
Name
value
Type
number
Description
The value of the discount group
Optional nested attributes (2)
Name
rules
Type
array<object>
Description
An array of rules of the discount group
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the discount group rule
Name
min
Type
number
Description
Minimum amount of tickets where the discount is valid
Name
max
Type
number
Description
Maximum amount of tickets where the discount is valid
Optional nested attributes (2)
Name
group
Type
string
Description
The ID of the discount group
Name
type
Type
enum(ticketGroups, cartSum)
Description
The type of the discount rule. ticketGroups is the type for tickets. cartSum is the type for sum of a cart
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var, fixPerItem, waiveFees)
Description
The type of the discount group. TOTAL = absolute discount. PERCENTAGE = percentage discount. fix = fixed discount. var = variable discount
Name
extraFields
Type
array<object>
Description
An array of extra fields of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
oneOf
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
Name
ticketExtraFields
Type
array<object>
Description
An array of extra fields for ticket types of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
oneOf
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
Name
image
Type
string
Description
An image for the event
Name
styleOptions
Type
object
Description
Style options of the event page
Optional nested attributes (10)
Name
headerStyle
Type
string
Description
Header style of the event page
Name
brandOne
Type
string
Description
First brand of the event
Name
brandTwo
Type
string
Description
Second brand of the event
Name
hideLocationMap
Type
boolean
Description
Whether the location map on the event page hide
Name
hideLocationAddress
Type
boolean
Description
Whether the location address on the event page hide
Name
categoryAlignment
Type
enum(cascade, asTabs, boxes, ticketWizard, 0, 1, 2, 3)
Description
The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured.
Name
showAvailabilityIndicator
Type
boolean
Description
Whether the availability indicator on the event page should be shown
Name
availabilityIndicatorThresholds
Type
array<number>
Description
The availability indicator thresholds of the event
Name
showAvailable
Type
boolean
Description
Whether to show availability of the time slot. Only applicable for time slot events.
Name
timeSlotsCheckoutSelection
Type
enum(beforeTickets, afterTickets)
Description
Time slots selection in checkout.
Name
video
Type
object
Description
The video settings of the event
Optional nested attributes (1)
Name
youtubeID
Type
string
Description
The youtube video ID of the event video setting
Name
gallery
Type
array<object>
Description
An array of gallery items of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the gallery item
Optional nested attributes (5)
Name
title
Type
string
Description
The title of the gallery item
Name
description
Type
string
Description
The description of the gallery item
Name
copyright
Type
string
Description
The copyright of the gallery item
Name
index
Type
number
Description
The index of the gallery item
Name
image
Type
string
Description
The image of the gallery item
Name
checkinInformation
Type
object
Description
The checkin information of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the checkin information of the event
Optional nested attributes (1)
Name
checkinStarts
Type
string
Description
The date of when the checkin of the event starts
Name
accentColor
Type
string
Description
The accent color of the event page
Name
sellerId
Type
string
Description
The ID of the seller owning this event
Name
sellStart
Type
string
Description
An ISO timestamp indicating when the event sale starts
Name
ticketShopHeader
Type
string
Description
A header image for the ticket shop of the event
Name
hardTicketSettings
Type
object
Description
The hard ticket settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the event hard ticket settings
Optional nested attributes (9)
Name
enabled
Type
boolean
Description
Whether hard tickets can be bought for this event
Name
fulfillmentType
Type
enum(self, managed)
Description
The type of fulfillment. self fulfilled by the seller. managed fulfilled by vivenu.
Name
printingMethod
Type
enum(preprinted, adhoc)
Description
Which printing method is used. preprinted = The tickets are preprinted. adhoc = The tickets are printed ad-hoc.
Name
hardTicketOuterCharge
Type
number
Description
Additional charge for every hard ticket that is added to the ticket price and the other outer charges - paid by the ticket buyer.
Name
hardTicketInnerCharge
Type
number
Description
Additional charge for hard tickets as in the contract of the seller
Name
hardTicketPreviewURL
Type
string
Description
The hard ticket design image
Name
promotionName
Type
string
Description
A special name for hard tickets. e.g. "Collector edition"
Name
promotionText
Type
string
Description
A description about what makes this ticket so special
Name
requiredDays
Type
integer
Description
Required days until deliver of the hard tickets
Name
tracking
Type
object
Description
The tracking of the event
Optional nested attributes (2)
Name
facebookPixel
Type
object
Description
The facebook pixel information of the event tracking
Optional nested attributes (2)
Name
active
Type
boolean
Description
Whether facebook pixel of event tracking is active
Name
pixelId
Type
string
Description
The ID of facebook pixel of the event tracking
Name
tagging
Type
object
Description
The tagging of the event tracking
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether tagging of event tracking is enabled
Name
tags
Type
array<string>
Description
An array of tags of the event tracking
Name
accountSettings
Type
object
Description
Account settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
dataRequestSettings
Type
object
Description
The data request settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the data request settings of the event
Optional nested attributes (12)
Name
requiresPersonalization
Type
boolean
Description
Whether the tickets for this event need personalization
Name
requiresExtraFields
Type
boolean
Description
Whether the tickets for this event need extra data fields
Name
repersonalization
Type
boolean
Description
Whether the tickets can be re personalized.
Name
repersonalizationAllowed
Type
boolean
Description
Whether the tickets can be re personalized.
Name
repersonalizationEndDate
Type
string
Description
If repersonalization = true. Until when the re personalization is allowed.
Name
repersonalizationDeadline
Type
object
Description
If repersonalization = true. A relatve date specification until when the re personalization is allowed.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
repersonalizationFee
Type
number
Description
If repersonalization = true. The per-ticket fee for repersonalization.
Name
repersonalizationsLimit
Type
number
Description
If repersonalization = true. The number of times repersonalization is allowed.
Name
limitOnlyNameChanges
Type
boolean
Description
If enabled, only name changes count towards the re-personalization limit for every ticket type of the event. Extra fields can always be updated until the re-personalization deadline.
Name
posPersonalization
Type
enum(noPersonalization, optionalPersonalization, requiredPersonalization)
Description
The type of personalization for this event on Point of Sale applications.
Name
skipAddressInfo
Type
boolean
Description
Whether the checkout should not ask for the address of the ticket buyer.
Name
enforceCompany
Type
boolean
Description
Whether the company of the ticket buyer is a required field.
Name
seoSettings
Type
object
Description
The search engine optimization settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the SEO setting
Optional nested attributes (4)
Name
tags
Type
array<string>
Description
An array of tags of the seo settings
Name
noIndex
Type
boolean
Description
Whether the seo setting has no indexing
Name
title
Type
string
Description
The title of the seo settings
Name
description
Type
string
Description
The description of the seo settings
Name
soldOutFallback
Type
object
Description
The sold out fallback of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of sold out entry
Optional nested attributes (2)
Name
soldOutFallbackType
Type
enum(default, moreinformation, waitinglist)
Description
Name
soldOutFallbackLink
Type
string
Description
The link of the sold out fallback
Name
reservationSettings
Type
object
Description
The reservation settings of event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
customTextConfig
Type
object
Description
The custom text configuration of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom text configuration
Optional nested attributes (1)
Name
buyTicketsCTA
Type
string
Description
The custom CTA after buy tickets
Name
customSettings
Type
object
Description
Custom settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom settings of the event
Optional nested attributes (22)
Name
hideTicketsInTransactionPage
Type
boolean
Description
Whether the ticket types of the event should be visible on transaction page
Name
dontSendTicketMail
Type
boolean
Description
Whether an email should be sent of tickets of the event
Name
dontSendBookingConfirmationMail
Type
boolean
Description
Whether an email should be sent for booking confirmation
Name
customMailHeaderImage
Type
string
Description
A custom header image of the mail for ticket types of the event
Name
customTransactionCompletionText
Type
string
Description
A custom transaction completion text for completed transactions of the event
Name
disableAppleWallet
Type
boolean
Description
Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead
Name
disablePdfTickets
Type
boolean
Description
Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInListing
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
customCheckoutCSS
Type
string
Description
Custom CSS styling of the checkout of the event
Name
useCustomCheckoutBrand
Type
boolean
Description
Whether the checkout of the event should use custom brand
Name
customCheckoutBrand
Type
string
Description
A custom checkout brand of the event
Name
hideLogoInCheckout
Type
boolean
Description
Whether the logo should be hide on the checkout of the event
Name
customEventPageHTML
Type
string
Description
A custom HTML of the event page
Name
customEventPageCSS
Type
string
Description
A custom css styling of the event page
Name
customConfirmationPage
Type
string
Description
A custom css styling of the event page
Name
hideSeatmapInCheckout
Type
boolean
Description
Hides the seatmap from the ticket buyer even if seating ticket types are available
Name
dontSendBookingConfirmationSMS
Type
boolean
Description
Whether a sms should be sent for booking confirmation
Name
upsellSettings
Type
object
Description
The upsell settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the upsell settings of the event
Optional nested attributes (4)
Name
active
Type
boolean
Description
Whether upselling is active on the event
Name
productStream
Type
string
Description
The product stream for upselling
Name
headerImage
Type
string
Description
A header image for the ticket shop, when selecting products
Name
crossSells
Type
object
Description
The cross selling settings.
Optional nested attributes (1)
Name
eventIds
Type
array<string>
Description
The array of the promoted event IDs.
Name
useTimeSlots
Type
boolean
Description
Whether the event uses time slots.
Name
saleStatus
Type
enum(onSale, planned, past, soldOut)
Description
The status of event sale
Name
underShopId
Type
string
Description
The ID of the selected under shop
Name
unlockMode
Type
enum(none, couponCode)
Description
Sets how event is locked, e.g. by coupon code.
Name
channelId
Type
string
Description
The ID of the selected channel
Name
seating
Type
boolean
Description
Whether seating is active or not
Name
seatingEventId
Type
string
Description
The ID of the seating event
Name
seatingChildEventIds
Type
array<string>
Description
The seating event IDs of the child events. Usually used to render maps for season ticket events
Name
seatingConfigurations
Type
object
Description
Settings to control the behaviour of maps
Name
contingents
Type
array<string>
Description
An array of contingents IDs
Name
theme
Type
string
Description
The theme of the event
Name
taxRate
Type
number
Description
The default tax rate of the event
Name
max
Type
number
Description
Maximum amount of tickets per order
Name
min
Type
number
Description
Minimum amount of tickets per order
Name
v
Type
number
Description
The remaining volume of the event
Name
cXv
Type
number
Description
Name
cXf
Type
number
Description
Name
ccXf
Type
number
Description
Name
startingPrice
Type
string
Description
The starting price of the event
Name
showTimeRangeInTicket
Type
boolean
Description
Whether to show the start and end time of the event on a ticket PDF or not
Name
showTimeRangeInListing
Type
boolean
Description
Whether to show the start and end time of the event in listings or not
Name
showCountdown
Type
boolean
Description
Whether to show the countdown till the sale of the event starts or not
Name
showOtherEvents
Type
boolean
Description
Whether to show other events of the seller on the event page
Name
accountsModule
Type
boolean
Description
Whether customer accounts for the event are enabled or not
Name
stripe_api_key
Type
string
Description
Name
currency
Type
enum(EUR, USD, GBP, AUD, CHF, THB, ILS, COP, MXN, DKK, NOK, SEK, QAR, CAD, ISK, GTQ, INR, DOP, SGD, PLN, SAR, TTD, ZAR, KYD, HKD, CZK, KRW, JPY, NZD, AED, MAD, TWD, BRL, BWP, NAD, KES, SCR, TRY, SZL, LSL, TZS, UGX, ZMW, ZWG, GHS, NGN, SLE, LRD, XOF, XAF, GEL, IDR, ARS, CRC, HUF, EGP, MYR, VND, PHP)
Description
The default currency of the event
Name
seller
Type
object
Description
Seller information
Required nested attributes (1)
Name
name
Type
string
Description
The name of the seller
Optional nested attributes (7)
Name
description
Type
string
Description
The description of the seller
Name
image
Type
string
Description
The logo of the seller
Name
documentImage
Type
string
Description
The logo of the seller visible on ticket PDFs
Name
url
Type
string
Description
The url of the seller
Name
supportUrl
Type
string
Description
The support url of the seller
Name
customLogo
Type
string
Description
Custom seller branding logo
Name
defaultLanguage
Type
string
Description
The language of the seller
Name
timezone
Type
string
Description
Timezone of event
Name
location
Type
object
Description
The event's location
Optional nested attributes (6)
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
locationStreet
Type
string
Description
The street of the location where the event takes place
Name
locationCity
Type
string
Description
The city of the location where the event takes place
Name
locationPostal
Type
string
Description
The postal code of the location where the event takes place
Name
locationCountry
Type
string
Description
The country code of the location where the event takes place
Name
geoCode
Type
object
Description
The geographic code of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the geo code
Name
lat
Type
number
Description
Latitude coordinate of the geo code
Name
lng
Type
number
Description
Longitude coordinate of the geo code
Name
slots
Type
array<object>
Description
Time slots of the assigned event day scheme.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the time slot.
Name
start
Type
string
Description
The start time of the time slot.
Name
amount
Type
integer
Description
Maximum amount the time slot could be used.
Optional nested attributes (1)
Name
offers
Type
object
Description
Offers of the slot
Optional nested attributes (3)
Name
allTicketTypesActive
Type
boolean
Description
Whether the all ticket types active.
Name
ticketTypes
Type
array<object>
Description
The day scheme offer ticket types.
Required nested attributes (1)
Name
ticketTypeId
Type
string
Description
The ticket type id which could be sold.
Optional nested attributes (1)
Name
active
Type
boolean
Description
Whether the ticket type is selling.
Name
timeSlots
Type
array<object>
Description
Time slots overrides.
Required nested attributes (1)
Name
slotId
Type
string
Description
The slotId of the time slot.
Optional nested attributes (2)
Name
enabled
Type
string
Description
Whether the slot is enabled.
Name
amount
Type
number
Description
The amount of available tickets of the time slot of the day scheme.
Name
timeSlots
Type
array<object>
Description
The time slots for the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the time slot
Name
startTime
Type
object
Description
The time of day the time slot starts
Required nested attributes (2)
Name
hour
Type
integer
Description
Name
minute
Type
integer
Description
Name
v
Type
number
Description
The remaining volume of the time slot
Optional nested attributes (3)
Name
categories
Type
array<object>
Description
The categories of the time slot
Required nested attributes (1)
Name
v
Type
number
Description
The remaining volume of the category
Optional nested attributes (1)
Name
categoryRef
Type
string
Description
The reference of the category of the time slot
Name
ticketTypes
Type
array<object>
Description
The ticket types of the time slot
Required nested attributes (1)
Name
v
Type
number
Description
The remaining volume of the ticket type
Optional nested attributes (1)
Name
ticketTypeId
Type
string
Description
The ID of the ticket type
Name
availabilityIndicator
Type
enum(green, yellow, red)
Description
The availability of the time slot. It shows whether there are tickets available. green = Enough available tickets. yellow = The tickets are almost sold out. red = There are no more available tickets
Name
ticketShopHeaderText
Type
string
Description
Name
tickets
Type
array<object>
Description
An array of ticket types of the event
Required nested attributes (4)
Name
id
Type
string
Description
The ID of the ticket type of the event
Name
name
Type
string
Description
The name of the ticket type of the event
Name
price
Type
number
Description
The price of the ticket type of the event
Name
active
Type
boolean
Description
Whether the ticket type of the event is active
Optional nested attributes (26)
Name
v
Type
number
Description
The remaining volume
Name
color
Type
string
Description
The font color of the ticket type of the event
Name
description
Type
string
Description
The description of the ticket type of the event
Name
categoryRef
Type
string
Description
The reference of the category of the ticket type of the event
Name
requiresPersonalization
Type
boolean
Description
Whether the ticket type of the event needs personalization
Name
sortingKey
Type
number
Description
The key to sort the ticket type within the ticket group
Name
enableHardTicketOption
Type
boolean
Description
Whether the ticket type is a hard ticket
Name
forceHardTicketOption
Type
boolean
Description
Whether to force the hard ticket option
Name
maxAmountPerOrder
Type
number
Description
Maximum amount per order of the ticket type
Name
minAmountPerOrder
Type
number
Description
Minimum amount per order of the ticket type
Name
minAmountPerOrderRule
Type
number
Description
Minimum amount of the ticket type, where the minAmountPerOrder goes active
Name
taxRate
Type
number
Description
The tax rate of the ticket type of the event
Name
styleOptions
Type
object
Description
Style options of the ticket type
Optional nested attributes (3)
Name
thumbnailImage
Type
string
Description
Thumbnail of the ticket type, which will be displayed on checkout
Name
showAvailable
Type
boolean
Description
Whether to show availability of the ticket type
Name
hiddenInSelectionArea
Type
boolean
Description
Whether to show this ticket in the selection area
Name
ignoreForMaxAmounts
Type
boolean
Description
Do not include tickets if this typw when calculating available amount in categories and event
Name
conditionalAvailability
Type
boolean
Description
Whether rules can be operated on the ticket type
Name
conditionalAvailabilityMode
Type
enum(blockAddToCart, blockCheckout)
Description
The conditional availability mode of the ticket type
Name
rules
Type
array<object>
Description
An array of rules for the ticket type of the event
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the ticket type rule
Name
ticketGroup
Type
string
Description
The ID of the ticket group to operate the rule on
Name
min
Type
number
Description
Minimum amount of tickets where the rule is active
Name
max
Type
number
Description
Maximum amount of tickets where the rule is active
Name
outerChargeFix
Type
number
Description
The outer charge fix of the ticket type of the event
Name
innnerChargeFix
Type
number
Description
The inner charge fix of the ticket type of the event
Name
dynamicFees
Type
array<object>
Description
Dynamic fees of the ticket type
Name
salesStart
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type starts
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesEnd
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type ends
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
subscriptionSettings
Type
object
Description
Name
priceTableTypeId
Type
string
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
resellSettings
Type
object
Description
Resell settings.
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether secondary market settings enabled.
Name
resell
Type
object
Description
Resell information
Optional nested attributes (4)
Name
saleActive
Type
boolean
Description
Whether the event has buying on the secondary market active.
Name
offerActive
Type
boolean
Description
Whether the event has selling on the secondary market active.
Name
fees
Type
object
Description
Fee information
Optional nested attributes (2)
Name
buyerFeeFix
Type
number
Description
The fixed fees charged for each ticket to the buyer.
Name
buyerFeeVar
Type
number
Description
The variable fees charged to the buyer.
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.

Example

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "url": "https://example.com",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "image": "string",
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "accentColor": "#006DCC",
  "sellerId": "507f191e810c19729de860ea",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "ticketShopHeader": "string",
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "customSettings": {},
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "useTimeSlots": true,
  "saleStatus": "onSale",
  "underShopId": "507f191e810c19729de860ea",
  "unlockMode": "none",
  "channelId": "507f191e810c19729de860ea",
  "seating": true,
  "seatingEventId": "507f191e810c19729de860ea",
  "seatingChildEventIds": [
    "string"
  ],
  "seatingConfigurations": {},
  "contingents": [
    "string"
  ],
  "theme": "string",
  "taxRate": 10.5,
  "max": 10.5,
  "min": 10.5,
  "v": 10.5,
  "cXv": 10.5,
  "cXf": 10.5,
  "ccXf": 10.5,
  "startingPrice": "string",
  "showTimeRangeInTicket": true,
  "showTimeRangeInListing": true,
  "showCountdown": true,
  "showOtherEvents": true,
  "accountsModule": true,
  "stripe_api_key": "string",
  "currency": "EUR",
  "seller": {
    "name": "Example Name",
    "description": "string",
    "image": "string",
    "documentImage": "string",
    "url": "https://example.com",
    "supportUrl": "https://example.com",
    "customLogo": "string",
    "defaultLanguage": "string"
  },
  "timezone": "2030-01-23T23:00:00.123Z",
  "location": {
    "locationName": "string",
    "locationStreet": "string",
    "locationCity": "string",
    "locationPostal": "string",
    "locationCountry": "string",
    "geoCode": {
      "_id": "507f191e810c19729de860ea",
      "lat": 10.5,
      "lng": 10.5
    }
  },
  "slots": [
    {
      "_id": "507f191e810c19729de860ea",
      "start": "string",
      "amount": 1,
      "offers": {}
    }
  ],
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "v": 10.5,
      "categories": [
        {
          "v": 10.5,
          "categoryRef": "string"
        }
      ],
      "ticketTypes": [
        {
          "v": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea"
        }
      ],
      "availabilityIndicator": "green"
    }
  ],
  "ticketShopHeaderText": "string",
  "tickets": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "active": true,
      "v": 10.5,
      "color": "string",
      "description": "string",
      "categoryRef": "string",
      "requiresPersonalization": true,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "ignoreForMaxAmounts": true,
      "conditionalAvailability": true,
      "conditionalAvailabilityMode": "blockAddToCart",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "outerChargeFix": 10.5,
      "innnerChargeFix": 10.5,
      "dynamicFees": [
        {}
      ],
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "subscriptionSettings": {},
      "priceTableTypeId": "507f191e810c19729de860ea",
      "meta": {},
      "resellSettings": {
        "enabled": "ENABLED"
      }
    }
  ],
  "resell": {
    "saleActive": true,
    "offerActive": true,
    "fees": {
      "buyerFeeFix": 10.5,
      "buyerFeeVar": 10.5
    },
    "priceMarkup": 10.5
  }
}

GETPUBLIC/api/events/info/:id

Get Event info

Query parameters

Optional query parameters

Name
web
Type
string
Description
Name
underShop
Type
string
Description
Name
posOperationMode
Type
enum(OPERATOR, KIOSK)
Description
Name
pos
Type
boolean
Description
Name
channel
Type
string
Description
Name
locale
Type
string
Description

Request

GET

/api/events/info/:id

const response = await fetch('https://vivenu.com/api/events/info/507f191e810c19729de860ea?web=value&underShop=value&posOperationMode=OPERATOR&pos=true&channel=value&locale=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "url": "https://example.com",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "image": "string",
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "accentColor": "#006DCC",
  "sellerId": "507f191e810c19729de860ea",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "ticketShopHeader": "string",
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "customSettings": {},
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "useTimeSlots": true,
  "saleStatus": "onSale",
  "underShopId": "507f191e810c19729de860ea",
  "unlockMode": "none",
  "channelId": "507f191e810c19729de860ea",
  "seating": true,
  "seatingEventId": "507f191e810c19729de860ea",
  "seatingChildEventIds": [
    "string"
  ],
  "seatingConfigurations": {},
  "contingents": [
    "string"
  ],
  "theme": "string",
  "taxRate": 10.5,
  "max": 10.5,
  "min": 10.5,
  "v": 10.5,
  "cXv": 10.5,
  "cXf": 10.5,
  "ccXf": 10.5,
  "startingPrice": "string",
  "showTimeRangeInTicket": true,
  "showTimeRangeInListing": true,
  "showCountdown": true,
  "showOtherEvents": true,
  "accountsModule": true,
  "stripe_api_key": "string",
  "currency": "EUR",
  "seller": {
    "name": "Example Name",
    "description": "string",
    "image": "string",
    "documentImage": "string",
    "url": "https://example.com",
    "supportUrl": "https://example.com",
    "customLogo": "string",
    "defaultLanguage": "string"
  },
  "timezone": "2030-01-23T23:00:00.123Z",
  "location": {
    "locationName": "string",
    "locationStreet": "string",
    "locationCity": "string",
    "locationPostal": "string",
    "locationCountry": "string",
    "geoCode": {
      "_id": "507f191e810c19729de860ea",
      "lat": 10.5,
      "lng": 10.5
    }
  },
  "slots": [
    {
      "_id": "507f191e810c19729de860ea",
      "start": "string",
      "amount": 1,
      "offers": {}
    }
  ],
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "v": 10.5,
      "categories": [
        {
          "v": 10.5,
          "categoryRef": "string"
        }
      ],
      "ticketTypes": [
        {
          "v": 10.5,
          "ticketTypeId": "507f191e810c19729de860ea"
        }
      ],
      "availabilityIndicator": "green"
    }
  ],
  "ticketShopHeaderText": "string",
  "tickets": [
    {
      "id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "active": true,
      "v": 10.5,
      "color": "string",
      "description": "string",
      "categoryRef": "string",
      "requiresPersonalization": true,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "ignoreForMaxAmounts": true,
      "conditionalAvailability": true,
      "conditionalAvailabilityMode": "blockAddToCart",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "outerChargeFix": 10.5,
      "innnerChargeFix": 10.5,
      "dynamicFees": [
        {}
      ],
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "subscriptionSettings": {},
      "priceTableTypeId": "507f191e810c19729de860ea",
      "meta": {},
      "resellSettings": {
        "enabled": "ENABLED"
      }
    }
  ],
  "resell": {
    "saleActive": true,
    "offerActive": true,
    "fees": {
      "buyerFeeFix": 10.5,
      "buyerFeeVar": 10.5
    },
    "priceMarkup": 10.5
  }
}

GETPUBLIC/api/events/:eventId/recommendations

Get more Events

Query parameters

Optional query parameters

Name
locale
Type
string
Description

Request

GET

/api/events/:eventId/recommendations

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea/recommendations?locale=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

The Public Event object

Required attributes

Name
_id
Type
string
Description
The ID of the event
Name
name
Type
string
Description
The name of the event
Name
start
Type
string
Description
An ISO timestamp indicating when the event starts
Name
end
Type
string
Description
An ISO timestamp indicating when the event ends

Optional attributes

Name
sellerId
Type
string
Description
The ID of the seller owning this event
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
eventType
Type
enum(SINGLE, GROUP, RECURRENCE, ROOT)
Description
The type of the event. SINGLE = it is a single event. GROUP = the event is part of a group of events
Name
url
Type
string
Description
The url of the event
Name
slogan
Type
string
Description
The slogan of the event
Name
description
Type
string
Description
A description about the event. Description is in RichText - JSON format.
Name
image
Type
string
Description
An image for the event
Name
pageStyle
Type
string
Description
The page style of the event page
Name
styleOptions
Type
object
Description
Style options of the event page
Optional nested attributes (10)
Name
headerStyle
Type
string
Description
Header style of the event page
Name
brandOne
Type
string
Description
First brand of the event
Name
brandTwo
Type
string
Description
Second brand of the event
Name
hideLocationMap
Type
boolean
Description
Whether the location map on the event page hide
Name
hideLocationAddress
Type
boolean
Description
Whether the location address on the event page hide
Name
categoryAlignment
Type
enum(cascade, asTabs, boxes, ticketWizard, 0, 1, 2, 3)
Description
The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured.
Name
showAvailabilityIndicator
Type
boolean
Description
Whether the availability indicator on the event page should be shown
Name
availabilityIndicatorThresholds
Type
array<number>
Description
The availability indicator thresholds of the event
Name
showAvailable
Type
boolean
Description
Whether to show availability of the time slot. Only applicable for time slot events.
Name
timeSlotsCheckoutSelection
Type
enum(beforeTickets, afterTickets)
Description
Time slots selection in checkout.
Name
video
Type
object
Description
The video settings of the event
Optional nested attributes (1)
Name
youtubeID
Type
string
Description
The youtube video ID of the event video setting
Name
gallery
Type
array<object>
Description
An array of gallery items of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the gallery item
Optional nested attributes (5)
Name
title
Type
string
Description
The title of the gallery item
Name
description
Type
string
Description
The description of the gallery item
Name
copyright
Type
string
Description
The copyright of the gallery item
Name
index
Type
number
Description
The index of the gallery item
Name
image
Type
string
Description
The image of the gallery item
Name
checkinInformation
Type
object
Description
The checkin information of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the checkin information of the event
Optional nested attributes (1)
Name
checkinStarts
Type
string
Description
The date of when the checkin of the event starts
Name
accentColor
Type
string
Description
The accent color of the event page
Name
tickets
Type
array<object>
Description
An array of ticket types of the event
Required nested attributes (5)
Name
_id
Type
string
Description
The ID of the ticket type of the event
Name
name
Type
string
Description
The name of the ticket type of the event
Name
price
Type
number
Description
The price of the ticket type of the event
Name
amount
Type
number
Description
The amount of the ticket type of the event
Name
active
Type
boolean
Description
Whether the ticket type of the event is active
Optional nested attributes (35)
Name
description
Type
string
Description
The description of the ticket type of the event
Name
image
Type
string
Description
The image of the ticket type of the event
Name
color
Type
string
Description
The font color of the ticket type of the event
Name
posActive
Type
boolean
Description
Whether POS for the ticket type of the event is active
Name
categoryRef
Type
string
Description
The reference of the category of the ticket type of the event
Name
ignoredForStartingPrice
Type
boolean
Description
Whether the price of the ticket type should be ignored on starting price determination of the event
Name
conditionalAvailability
Type
boolean
Description
Whether rules can be operated on the ticket type
Name
ticketBackground
Type
string
Description
The background for the ticket PDF of the ticket type
Name
rules
Type
array<object>
Description
An array of rules for the ticket type of the event
Required nested attributes (4)
Name
_id
Type
string
Description
The ID of the ticket type rule
Name
ticketGroup
Type
string
Description
The ID of the ticket group to operate the rule on
Name
min
Type
number
Description
Minimum amount of tickets where the rule is active
Name
max
Type
number
Description
Maximum amount of tickets where the rule is active
Name
requiresPersonalization
Type
boolean
Description
Deprecated, use `requiresPersonalizationMode` instead
Name
requiresPersonalizationMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs personalization
Name
requiresExtraFields
Type
boolean
Description
Deprecated, use `requiresExtraFieldsMode` instead
Name
requiresExtraFieldsMode
Type
enum(ENABLED, DISABLED)
Description
Whether the ticket type of the event needs extra fields
Name
repersonalizationAllowedMode
Type
enum(ENABLED, DISABLED)
Description
Whether re-personalization (name changes) is allowed for this ticket type. When unset, inherits the event-level `repersonalizationAllowed`. Enables flex-ticket-like re-personalization without an addon.
Name
repersonalizationFee
Type
number
Description
The per-ticket fee for repersonalization.
Name
sortingKey
Type
number
Description
The key to sort the ticket type within the ticket group
Name
enableHardTicketOption
Type
boolean
Description
Whether the ticket type is a hard ticket
Name
forceHardTicketOption
Type
boolean
Description
Whether to force the hard ticket option
Name
maxAmountPerOrder
Type
number
Description
Maximum amount per order of the ticket type
Name
minAmountPerOrder
Type
number
Description
Minimum amount per order of the ticket type
Name
minAmountPerOrderRule
Type
number
Description
Minimum amount of the ticket type, where the minAmountPerOrder goes active
Name
taxRate
Type
number
Description
The tax rate of the ticket type of the event
Name
styleOptions
Type
object
Description
Style options of the ticket type
Optional nested attributes (3)
Name
thumbnailImage
Type
string
Description
Thumbnail of the ticket type, which will be displayed on checkout
Name
showAvailable
Type
boolean
Description
Whether to show availability of the ticket type
Name
hiddenInSelectionArea
Type
boolean
Description
Whether to show this ticket in the selection area
Name
priceCategoryId
Type
string
Description
The ID of the price category of the ticket type
Name
entryPermissions
Type
array<string>
Description
An array of IDs of entry permissions where the ticket buyer has access to certain areas
Name
ignoreForMaxAmounts
Type
boolean
Description
Do not include tickets if this typw when calculating available amount in categories and event
Name
expirationSettings
Type
object
Description
Expiration settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether expiration enabled for the event ticket types
Name
expiresAfter
Type
object
Description
If enabled = true. A relatve date specification until when ticket is valid.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
barcodePrefix
Type
string
Description
Characters that precede the barcodes of tickets.
Name
salesStart
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type starts
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesEnd
Type
object
Description
A relative date before the end of the event, when the sale of this ticket type ends
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
transferSettings
Type
object
Description
Transfer settings of the ticket type.
Optional nested attributes (6)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
scanSettings
Type
object
Description
Scan settings of the ticket type.
Optional nested attributes (2)
Name
feedback
Type
enum(highlight)
Description
Feedback mode during scanning of the ticket
Name
allowedScanCount
Type
number
Description
Number of times a ticket is allowed to be scanned as valid
Name
deliverySettings
Type
object
Description
Delivery settings of the ticket type.
Optional nested attributes (2)
Name
wallet
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
pdf
Type
object
Description
Optional nested attributes (1)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the ticket type.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
Type
object
Description
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
ticketExtraFields
Type
array<object>
Description
An array of extra fields for ticket types of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
oneOf
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
Name
ticketDesign
Type
object
Description
The ticket design settings for ticket types of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the ticket types design of the event
Optional nested attributes (8)
Name
useCustomDesign
Type
boolean
Description
Whether to use custom design on ticket types of event
Name
customDesignURL
Type
string
Description
The custom design URL for ticket types of event
Name
footerDesignURL
Type
string
Description
The footer design URL for ticket types of the event
Name
disclaimer
Type
string
Description
The disclaimer for ticket types of the event
Name
infoColor
Type
string
Description
The info color for ticket types of the event
Name
showTimeRange
Type
boolean
Description
Whether to show time range on ticket types of the event
Name
hideDates
Type
boolean
Description
Whether to hide dates on ticket types of the event
Name
hideTimes
Type
boolean
Description
Whether to hide the time on ticket types of the event
Name
extraFields
Type
array<object>
Description
An array of extra fields of the event
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the extra field
Name
required
Type
boolean
Description
Whether the extra field is required
Optional nested attributes (11)
Name
name
Type
string
Description
The name of the extra field
Name
description
Type
string
Description
The description of the extra field
Name
collectInCheckout
Type
boolean
Description
Whether the extra field is collected in checkout
Name
deleted
Type
boolean
Description
Whether the extra field is deleted
Name
type
Type
enum(text, number, select, checkbox, tel, country, email, date, documentUpload, signature, address)
Description
The type of the extra field. text = is a text field. number = is a number field. select = is a selection field of different selections. checkbox = is a checkbox field. tel = is a number field for a phone number. email = is a text field for an email. country = is a text field field for country.
Name
options
Type
array<string>
Description
An array of options of the extra field
Name
onlyForCertainTicketTypes
Type
boolean
Description
Whether the extra field is only for certain ticket types
Name
allowedTicketTypes
Type
array<string>
Description
An array of IDs of the ticket types allowed for the extra field
Name
printable
Type
boolean
Description
Whether the extra field is printable
Name
conditions
Type
array<object>
Description
An array of conditions of the extra field. The conditions can refer to other extra fields.
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the condition
Name
baseSlug
Type
string
Description
The slug of the base extra field which the condition refers to
Name
operator
Type
enum(equals, notEquals, greaterThan, lessThan, greaterThanOrEquals, lessThanOrEquals, exists, notExists)
Description
The operator which will be used to check the condition
Optional nested attributes (1)
Name
value
Type
oneOf
Description
The value which the operator will be used on to check the condition.
Name
settings
Type
oneOf
Description
Type-specific settings for the extra field
Name
showCountdown
Type
boolean
Description
Whether the countdown should be visible till event start
Name
showOtherEvents
Type
boolean
Description
Whether other events should be displayed on the event page
Name
hardTicketSettings
Type
object
Description
The hard ticket settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the event hard ticket settings
Optional nested attributes (9)
Name
enabled
Type
boolean
Description
Whether hard tickets can be bought for this event
Name
fulfillmentType
Type
enum(self, managed)
Description
The type of fulfillment. self fulfilled by the seller. managed fulfilled by vivenu.
Name
printingMethod
Type
enum(preprinted, adhoc)
Description
Which printing method is used. preprinted = The tickets are preprinted. adhoc = The tickets are printed ad-hoc.
Name
hardTicketOuterCharge
Type
number
Description
Additional charge for every hard ticket that is added to the ticket price and the other outer charges - paid by the ticket buyer.
Name
hardTicketInnerCharge
Type
number
Description
Additional charge for hard tickets as in the contract of the seller
Name
hardTicketPreviewURL
Type
string
Description
The hard ticket design image
Name
promotionName
Type
string
Description
A special name for hard tickets. e.g. "Collector edition"
Name
promotionText
Type
string
Description
A description about what makes this ticket so special
Name
requiredDays
Type
integer
Description
Required days until deliver of the hard tickets
Name
tracking
Type
object
Description
The tracking of the event
Optional nested attributes (2)
Name
facebookPixel
Type
object
Description
The facebook pixel information of the event tracking
Optional nested attributes (2)
Name
active
Type
boolean
Description
Whether facebook pixel of event tracking is active
Name
pixelId
Type
string
Description
The ID of facebook pixel of the event tracking
Name
tagging
Type
object
Description
The tagging of the event tracking
Optional nested attributes (2)
Name
enabled
Type
boolean
Description
Whether tagging of event tracking is enabled
Name
tags
Type
array<string>
Description
An array of tags of the event tracking
Name
seoSettings
Type
object
Description
The search engine optimization settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the SEO setting
Optional nested attributes (4)
Name
tags
Type
array<string>
Description
An array of tags of the seo settings
Name
noIndex
Type
boolean
Description
Whether the seo setting has no indexing
Name
title
Type
string
Description
The title of the seo settings
Name
description
Type
string
Description
The description of the seo settings
Name
soldOutFallback
Type
object
Description
The sold out fallback of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of sold out entry
Optional nested attributes (2)
Name
soldOutFallbackType
Type
enum(default, moreinformation, waitinglist)
Description
Name
soldOutFallbackLink
Type
string
Description
The link of the sold out fallback
Name
reservationSettings
Type
object
Description
The reservation settings of event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the reservation setting
Optional nested attributes (2)
Name
option
Type
enum(noReservations, reservationsOnly, reservationsAndPayment, internalReservationsAndPayment)
Description
The option of the reservation setting. reservationsOnly = needs reservation only. noReservations = no reservations needed. reservationsAndPayment = needs reservation and payment
Name
strategyId
Type
string
Description
The ID of the strategy of a purchase intents to be used on the event
Name
customTextConfig
Type
object
Description
The custom text configuration of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom text configuration
Optional nested attributes (1)
Name
buyTicketsCTA
Type
string
Description
The custom CTA after buy tickets
Name
timezone
Type
string
Description
Timezone of event
Name
ticketSettings
Type
object
Description
The event ticket settings
Optional nested attributes (8)
Name
cancellationStrategy
Type
enum(disabled, freeTicketsOnly, withoutRefund)
Description
Cancellation strategy of the ticket types
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the event.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
Type
object
Description
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
transferSettings
Type
object
Description
Transfer settings of the ticket types
Optional nested attributes (7)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
useSeasonCardTemplate
Type
boolean
Description
Whether to use the season card template for individual tickets transferred from the season.
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesStart
Type
object
Description
A relative date specification of sales start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
barcodeSettings
Type
object
Description
Barcode settings
Optional nested attributes (1)
Name
issueOfflineBarcodes
Type
enum(ENABLED, DISABLED)
Description
Whether offline barcodes are enabled
Name
childEventMapping
Type
array<object>
Description
Child event mapping
Required nested attributes (2)
Name
childEventId
Type
string
Description
The child event for this mapping
Name
ticketTypeMapping
Type
object
Description
Mapping between ticket types of the parent event and the child events
Optional nested attributes (1)
Name
valueShare
Type
number
Description
The percentage value of this child event from the value of the parent event
Name
seasonCardValueStrategy
Type
enum(childValue, averagePerChild, sharePerChild)
Description
The strategy used to determine the value of a child event in the context of the parent event
Name
rootId
Type
string
Description
The id of the root event
Name
customSettings
Type
object
Description
Custom settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom settings of the event
Optional nested attributes (22)
Name
hideTicketsInTransactionPage
Type
boolean
Description
Whether the ticket types of the event should be visible on transaction page
Name
dontSendTicketMail
Type
boolean
Description
Whether an email should be sent of tickets of the event
Name
dontSendBookingConfirmationMail
Type
boolean
Description
Whether an email should be sent for booking confirmation
Name
customMailHeaderImage
Type
string
Description
A custom header image of the mail for ticket types of the event
Name
customTransactionCompletionText
Type
string
Description
A custom transaction completion text for completed transactions of the event
Name
disableAppleWallet
Type
boolean
Description
Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead
Name
disablePdfTickets
Type
boolean
Description
Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInListing
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
customCheckoutCSS
Type
string
Description
Custom CSS styling of the checkout of the event
Name
useCustomCheckoutBrand
Type
boolean
Description
Whether the checkout of the event should use custom brand
Name
customCheckoutBrand
Type
string
Description
A custom checkout brand of the event
Name
hideLogoInCheckout
Type
boolean
Description
Whether the logo should be hide on the checkout of the event
Name
customEventPageHTML
Type
string
Description
A custom HTML of the event page
Name
customEventPageCSS
Type
string
Description
A custom css styling of the event page
Name
customConfirmationPage
Type
string
Description
A custom css styling of the event page
Name
hideSeatmapInCheckout
Type
boolean
Description
Hides the seatmap from the ticket buyer even if seating ticket types are available
Name
dontSendBookingConfirmationSMS
Type
boolean
Description
Whether a sms should be sent for booking confirmation
Name
upsellSettings
Type
object
Description
The upsell settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the upsell settings of the event
Optional nested attributes (4)
Name
active
Type
boolean
Description
Whether upselling is active on the event
Name
productStream
Type
string
Description
The product stream for upselling
Name
headerImage
Type
string
Description
A header image for the ticket shop, when selecting products
Name
crossSells
Type
object
Description
The cross selling settings.
Optional nested attributes (1)
Name
eventIds
Type
array<string>
Description
The array of the promoted event IDs.
Name
category
Type
string
Description
The category of the extra information of the event
Name
subCategory
Type
string
Description
The subCategory of the extra information of the event
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
showTimeRangeInListing
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
accountSettings
Type
object
Description
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
location
Type
object
Description
Optional nested attributes (6)
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
locationStreet
Type
string
Description
The street of the location where the event takes place
Name
locationCity
Type
string
Description
The city of the location where the event takes place
Name
locationPostal
Type
string
Description
The postal code of the location where the event takes place
Name
locationCountry
Type
string
Description
The country code of the location where the event takes place
Name
geoCode
Type
object
Description
The geographic code of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the geo code
Name
lat
Type
number
Description
Latitude coordinate of the geo code
Name
lng
Type
number
Description
Longitude coordinate of the geo code
Name
resell
Type
object
Description
Resell information
Optional nested attributes (4)
Name
saleActive
Type
boolean
Description
Whether the event has buying on the secondary market active.
Name
offerActive
Type
boolean
Description
Whether the event has selling on the secondary market active.
Name
fees
Type
object
Description
Fee information
Optional nested attributes (2)
Name
buyerFeeFix
Type
number
Description
The fixed fees charged for each ticket to the buyer.
Name
buyerFeeVar
Type
number
Description
The variable fees charged to the buyer.
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.

Example

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "sellerId": "507f191e810c19729de860ea",
  "meta": {},
  "eventType": "SINGLE",
  "url": "https://example.com",
  "slogan": "string",
  "description": "string",
  "image": "string",
  "pageStyle": "white",
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "accentColor": "#006DCC",
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "showCountdown": true,
  "showOtherEvents": true,
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "timezone": "2030-01-23T23:00:00.123Z",
  "ticketSettings": {},
  "rootId": "507f191e810c19729de860ea",
  "customSettings": {},
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "category": "string",
  "subCategory": "string",
  "showTimeRangeInTicket": true,
  "showTimeRangeInListing": true,
  "showStartDate": true,
  "showStartTime": true,
  "showEndDate": true,
  "showEndTime": true,
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "location": {
    "locationName": "string",
    "locationStreet": "string",
    "locationCity": "string",
    "locationPostal": "string",
    "locationCountry": "string",
    "geoCode": {
      "_id": "507f191e810c19729de860ea",
      "lat": 10.5,
      "lng": 10.5
    }
  },
  "resell": {
    "saleActive": true,
    "offerActive": true,
    "fees": {
      "buyerFeeFix": 10.5,
      "buyerFeeVar": 10.5
    },
    "priceMarkup": 10.5
  }
}

GETPUBLIC/api/public/events/:id

Get Public Event

Query parameters

Optional query parameters

Name
locale
Type
string
Description

Request

GET

/api/public/events/:id

const response = await fetch('https://vivenu.com/api/public/events/507f191e810c19729de860ea?locale=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "sellerId": "507f191e810c19729de860ea",
  "meta": {},
  "eventType": "SINGLE",
  "url": "https://example.com",
  "slogan": "string",
  "description": "string",
  "image": "string",
  "pageStyle": "white",
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "accentColor": "#006DCC",
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "showCountdown": true,
  "showOtherEvents": true,
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "timezone": "2030-01-23T23:00:00.123Z",
  "ticketSettings": {},
  "rootId": "507f191e810c19729de860ea",
  "customSettings": {},
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "category": "string",
  "subCategory": "string",
  "showTimeRangeInTicket": true,
  "showTimeRangeInListing": true,
  "showStartDate": true,
  "showStartTime": true,
  "showEndDate": true,
  "showEndTime": true,
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "location": {
    "locationName": "string",
    "locationStreet": "string",
    "locationCity": "string",
    "locationPostal": "string",
    "locationCountry": "string",
    "geoCode": {
      "_id": "507f191e810c19729de860ea",
      "lat": 10.5,
      "lng": 10.5
    }
  },
  "resell": {
    "saleActive": true,
    "offerActive": true,
    "fees": {
      "buyerFeeFix": 10.5,
      "buyerFeeVar": 10.5
    },
    "priceMarkup": 10.5
  }
}

The Public Listing Event object

You can retrieve a list of public listing event objects with the Get public listings events endpoint. This API provides information about your public listing events.

Required attributes

Name
_id
Type
string
Description
The ID of the event
Name
name
Type
string
Description
The name of the event
Name
start
Type
string
Description
An ISO timestamp indicating when the event starts
Name
end
Type
string
Description
An ISO timestamp indicating when the event ends

Optional attributes

Name
url
Type
string
Description
The url of the event
Name
image
Type
string
Description
An image for the event
Name
slogan
Type
string
Description
The slogan of the event
Name
sellerId
Type
string
Description
The ID of the seller owning this event
Name
locationName
Type
string
Description
The name of the location where the event takes place
Name
locationStreet
Type
string
Description
The street of the location where the event takes place
Name
locationCity
Type
string
Description
The city of the location where the event takes place
Name
locationPostal
Type
string
Description
The postal code of the location where the event takes place
Name
locationCountry
Type
string
Description
The country code of the location where the event takes place
Name
styleOptions
Type
object
Description
Style options of the event page
Optional nested attributes (10)
Name
headerStyle
Type
string
Description
Header style of the event page
Name
brandOne
Type
string
Description
First brand of the event
Name
brandTwo
Type
string
Description
Second brand of the event
Name
hideLocationMap
Type
boolean
Description
Whether the location map on the event page hide
Name
hideLocationAddress
Type
boolean
Description
Whether the location address on the event page hide
Name
categoryAlignment
Type
enum(cascade, asTabs, boxes, ticketWizard, 0, 1, 2, 3)
Description
The style of category alignment. 0 = cascade = categories among themselves. 1 = asTabs = categories as tabs. 2 = boxes = categories as boxes. 3 = ticket wizard = categories as ticket wizard if configured.
Name
showAvailabilityIndicator
Type
boolean
Description
Whether the availability indicator on the event page should be shown
Name
availabilityIndicatorThresholds
Type
array<number>
Description
The availability indicator thresholds of the event
Name
showAvailable
Type
boolean
Description
Whether to show availability of the time slot. Only applicable for time slot events.
Name
timeSlotsCheckoutSelection
Type
enum(beforeTickets, afterTickets)
Description
Time slots selection in checkout.
Name
accountSettings
Type
object
Description
Account settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the account settings of the event
Optional nested attributes (2)
Name
enforceAccounts
Type
boolean
Description
Whether to enforce accounts for the event
Name
enforceAuthentication
Type
enum(DISABLED, PREVENT_CHECKOUT, PREVENT_DETAILS_STEP)
Description
Whether to enforce authentication for the event and how to enforce it
Name
meta
Type
object
Description
Custom key-value data. Metadata is useful for storing additional, structured information on an object.
Name
eventType
Type
enum(SINGLE, GROUP, RECURRENCE, ROOT)
Description
The type of the event. SINGLE = it is a single event. GROUP = the event is part of a group of events
Name
childEvents
Type
array<string>
Description
An array of IDs of child events
Name
daySchemeId
Type
string
Description
The ID of the day scheme assigned to the event.
Name
rootId
Type
string
Description
The id of the root event
Name
seoSettings
Type
object
Description
The search engine optimization settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the SEO setting
Optional nested attributes (4)
Name
tags
Type
array<string>
Description
An array of tags of the seo settings
Name
noIndex
Type
boolean
Description
Whether the seo setting has no indexing
Name
title
Type
string
Description
The title of the seo settings
Name
description
Type
string
Description
The description of the seo settings
Name
customSettings
Type
object
Description
Custom settings of the event
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the custom settings of the event
Optional nested attributes (22)
Name
hideTicketsInTransactionPage
Type
boolean
Description
Whether the ticket types of the event should be visible on transaction page
Name
dontSendTicketMail
Type
boolean
Description
Whether an email should be sent of tickets of the event
Name
dontSendBookingConfirmationMail
Type
boolean
Description
Whether an email should be sent for booking confirmation
Name
customMailHeaderImage
Type
string
Description
A custom header image of the mail for ticket types of the event
Name
customTransactionCompletionText
Type
string
Description
A custom transaction completion text for completed transactions of the event
Name
disableAppleWallet
Type
boolean
Description
Whether the Apple and Google Wallet functionality should be disabled on the event. Deprecated: use event.deliverySettings.wallet instead
Name
disablePdfTickets
Type
boolean
Description
Whether the PDF tickets download functionality should be disabled on the event. Deprecated: use event.deliverySettings.pdf instead
Name
showStartDate
Type
boolean
Description
Whether the start date of the event should be visible on listings
Name
showStartTime
Type
boolean
Description
Whether the start time of the event should be visible on listings
Name
showEndDate
Type
boolean
Description
Whether the end date of the event should be visible on listings
Name
showEndTime
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInListing
Type
boolean
Description
Whether the end time of the event should be visible on listings
Name
showTimeRangeInTicket
Type
boolean
Description
Whether the time range of the event should be visible on ticket PDFs
Name
customCheckoutCSS
Type
string
Description
Custom CSS styling of the checkout of the event
Name
useCustomCheckoutBrand
Type
boolean
Description
Whether the checkout of the event should use custom brand
Name
customCheckoutBrand
Type
string
Description
A custom checkout brand of the event
Name
hideLogoInCheckout
Type
boolean
Description
Whether the logo should be hide on the checkout of the event
Name
customEventPageHTML
Type
string
Description
A custom HTML of the event page
Name
customEventPageCSS
Type
string
Description
A custom css styling of the event page
Name
customConfirmationPage
Type
string
Description
A custom css styling of the event page
Name
hideSeatmapInCheckout
Type
boolean
Description
Hides the seatmap from the ticket buyer even if seating ticket types are available
Name
dontSendBookingConfirmationSMS
Type
boolean
Description
Whether a sms should be sent for booking confirmation
Name
ticketSettings
Type
object
Description
The event ticket settings
Optional nested attributes (8)
Name
cancellationStrategy
Type
enum(disabled, freeTicketsOnly, withoutRefund)
Description
Cancellation strategy of the ticket types
Name
revealingSettings
Type
object
Description
Barcode reveal settings of the event.
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Name
beforeEvent
Type
object
Description
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
transferSettings
Type
object
Description
Transfer settings of the ticket types
Optional nested attributes (7)
Name
mode
Type
enum(ALLOWED, DISABLED)
Description
Ticket transfer mode.
Name
expiresAfter
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until when ticket transfer is valid.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
retransferMode
Type
enum(ALLOWED, DISABLED)
Description
Ticket retransfer mode.
Name
allowedUntil
Type
object
Description
If 'mode = ALLOWED'. A relatve date specification until the end of the event where ticket transfer is possible.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
hardTicketsMode
Type
enum(ALLOWED, DISABLED)
Description
If 'hardTicketsMode = ALLOWED' then hard tickets transfers allowed.
Name
seasonTicketMode
Type
enum(NO_RESTRICTION, CHILDREN_ONLY, GROUP_ONLY)
Description
Restrict how season tickets can be transferred.
Name
useSeasonCardTemplate
Type
boolean
Description
Whether to use the season card template for individual tickets transferred from the season.
Name
upgradeSettings
Type
object
Description
Upgrade settings of the ticket types
Optional nested attributes (2)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether ticket upgrade settings enabled.
Name
underShopMapping
Type
array<object>
Description
Mapping to define the under shop in which a ticket upgrade will be performed.
Required nested attributes (3)
Name
type
Type
enum(tag)
Description
Name
tag
Type
string
Description
The customer tag
Name
underShopId
Type
string
Description
The ID of the under shop.
Name
resellSettings
Type
object
Description
Resell settings
Optional nested attributes (10)
Name
enabled
Type
enum(ENABLED, DISABLED)
Description
Whether resell is enabled
Name
resellerFeeFix
Type
number
Description
The fixed fee per ticket that the reseller pays
Name
resellerFeeVar
Type
number
Description
The variable fee per ticket that the reseller pays
Name
buyerFeeFix
Type
number
Description
The fixed fee per ticket that the buyer pays
Name
buyerFeeVar
Type
number
Description
The variable fee per ticket that the buyer pays
Name
offerCreationStart
Type
object
Description
A relative date specification of offers creation start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
offerCreationEnd
Type
object
Description
A relative date specification of offers creation end.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
salesStart
Type
object
Description
A relative date specification of sales start.
Required nested attributes (2)
Name
unit
Type
enum(hours, days, weeks, months, years)
Description
The unit in which the offset is specified
Name
offset
Type
integer
Description
The offset to the date
Optional nested attributes (1)
Name
target
Type
string
Description
The target of the relative date
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
cartAutomationMode
Type
enum(BLOCKED, INDIVIDUAL)
Description
Controls whether tickets involved in cart automations can be resold.
Name
barcodeSettings
Type
object
Description
Barcode settings
Optional nested attributes (1)
Name
issueOfflineBarcodes
Type
enum(ENABLED, DISABLED)
Description
Whether offline barcodes are enabled
Name
childEventMapping
Type
array<object>
Description
Child event mapping
Required nested attributes (2)
Name
childEventId
Type
string
Description
The child event for this mapping
Name
ticketTypeMapping
Type
object
Description
Mapping between ticket types of the parent event and the child events
Optional nested attributes (1)
Name
valueShare
Type
number
Description
The percentage value of this child event from the value of the parent event
Name
seasonCardValueStrategy
Type
enum(childValue, averagePerChild, sharePerChild)
Description
The strategy used to determine the value of a child event in the context of the parent event
Name
groups
Type
array<object>
Description
An array of groups of ticket types of the event
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of of the ticket group of the event
Name
name
Type
string
Description
The name of the ticket group of the event
Name
tickets
Type
array<string>
Description
An array of ID's of ticket types of the event
Name
underShopId
Type
string
Description
The ID of the under shop of the event
Name
startingPrice
Type
string
Description
The starting price of the event
Name
showStartDate
Type
boolean
Description
Whether to show the start time of the event in listings or not
Name
showEndDate
Type
boolean
Description
Whether to show the end time of the event in listings or not
Name
showTimeRangeInListing
Type
boolean
Description
Whether to show the end time of the event in listings or not
Name
availabilityIndicator
Type
enum(green, yellow, red)
Description
The availability of the event. It shows whether there are tickets available. green = Enough available tickets. yellow = The tickets are almost sold out. red = There are no more available tickets
Name
currency
Type
enum(EUR, USD, GBP, AUD, CHF, THB, ILS, COP, MXN, DKK, NOK, SEK, QAR, CAD, ISK, GTQ, INR, DOP, SGD, PLN, SAR, TTD, ZAR, KYD, HKD, CZK, KRW, JPY, NZD, AED, MAD, TWD, BRL, BWP, NAD, KES, SCR, TRY, SZL, LSL, TZS, UGX, ZMW, ZWG, GHS, NGN, SLE, LRD, XOF, XAF, GEL, IDR, ARS, CRC, HUF, EGP, MYR, VND, PHP)
Description
The currency of event tickets prices
Name
saleStatus
Type
enum(onSale, planned, past, soldOut)
Description
status of event sale
Name
timezone
Type
string
Description
Timezone of event
Name
category
Type
string
Description
Name
subCategory
Type
string
Description
Name
resell
Type
object
Description
Resell information
Optional nested attributes (4)
Name
saleActive
Type
boolean
Description
Whether the event has buying on the secondary market active.
Name
offerActive
Type
boolean
Description
Whether the event has selling on the secondary market active.
Name
fees
Type
object
Description
Fee information
Optional nested attributes (2)
Name
buyerFeeFix
Type
number
Description
The fixed fees charged for each ticket to the buyer.
Name
buyerFeeVar
Type
number
Description
The variable fees charged to the buyer.
Name
priceMarkup
Type
number
Description
The markup applied to the price of each ticket bought on the secondary market.
Name
attributes
Type
object
Description

Example

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "url": "https://example.com",
  "image": "string",
  "slogan": "string",
  "sellerId": "507f191e810c19729de860ea",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "meta": {},
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "daySchemeId": "507f191e810c19729de860ea",
  "rootId": "507f191e810c19729de860ea",
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "customSettings": {},
  "ticketSettings": {},
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "underShopId": "507f191e810c19729de860ea",
  "startingPrice": "string",
  "showStartDate": true,
  "showEndDate": true,
  "showTimeRangeInListing": true,
  "availabilityIndicator": "green",
  "currency": "EUR",
  "saleStatus": "onSale",
  "timezone": "2030-01-23T23:00:00.123Z",
  "category": "string",
  "subCategory": "string",
  "resell": {
    "saleActive": true,
    "offerActive": true,
    "fees": {
      "buyerFeeFix": 10.5,
      "buyerFeeVar": 10.5
    },
    "priceMarkup": 10.5
  },
  "attributes": {}
}

GETPUBLIC/api/events/public/listings

Get public listing events

Query parameters

Optional query parameters

Name
top
Type
number
Description
Name
skip
Type
number
Description
Name
startMin
Type
string
Description
Name
startMax
Type
string
Description
Name
endMin
Type
string
Description
Name
endMax
Type
string
Description
Name
sectionURL
Type
string
Description
Name
sellerId
Type
string
Description
Name
orgId
Type
string
Description
Name
rootId
Type
oneOf
Description
Name
groupEventId
Type
string
Description
Name
eventIds
Type
array<string>
Description
Name
sortBy
Type
enum(start)
Description
Name
sortOrder
Type
enum(ASC, DESC)
Description
Name
visibleInListing
Type
enum(true)
Description
Name
showStartDate
Type
boolean
Description
Name
locale
Type
string
Description
Name
eventType
Type
enum(SINGLE, GROUP, RECURRENCE)
Description
Name
underShopId
Type
string
Description
Name
attributes
Type
object
Description

Request

GET

/api/events/public/listings

const response = await fetch('https://vivenu.com/api/events/public/listings?top=10.5&skip=10.5&startMin=value&startMax=value&endMin=value&endMax=value&sectionURL=https%3A%2F%2Fexample.com&sellerId=507f191e810c19729de860ea&orgId=507f191e810c19729de860ea&rootId=507f191e810c19729de860ea&groupEventId=507f191e810c19729de860ea&eventIds=value1%2Cvalue2&sortBy=start&sortOrder=ASC&visibleInListing=true&showStartDate=2030-01-23T23%3A00%3A00.123Z&locale=value&eventType=SINGLE&underShopId=507f191e810c19729de860ea&attributes=value', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

[]

POST/api/events/:id/recurrences

Add Recurrences

Request

POST

/api/events/:id/recurrences

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea/recurrences', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "unit": "WEEK",
    "repeatsOn": [
      "string"
    ],
    "every": 1,
    "from": "2030-01-23T23:00:00.123Z",
    "to": "2030-01-23T23:00:00.123Z",
    "startTime": "2030-01-23T23:00:00.123Z",
    "endTime": "2030-01-23T23:00:00.123Z",
    "sellDatesStrategy": "RELATIVE",
    "sellStartAt": "ABSOLUTE",
    "sellEndAt": "ABSOLUTE",
    "sellStartOffset": "RELATIVE",
    "sellEndOffset": "RELATIVE",
    "sellStartTime": "RELATIVE",
    "sellEndTime": "RELATIVE",
    "checkinStartOffset": 1,
    "checkinStartTime": "2030-01-23T23:00:00.123Z",
    "daySchemeId": "507f191e810c19729de860ea",
    "priceTableTierId": "507f191e810c19729de860ea"
  }),
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}

POST/api/events/:id/decouple

Decouple event

Request

POST

/api/events/:id/decouple

const response = await fetch('https://vivenu.com/api/events/507f191e810c19729de860ea/decouple', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "_id": "507f191e810c19729de860ea",
  "name": "Example Name",
  "start": "2030-01-23T23:00:00.123Z",
  "end": "2030-01-23T23:00:00.123Z",
  "maxAmount": 10.5,
  "maxAmountPerOrder": 10.5,
  "sellerId": "507f191e810c19729de860ea",
  "slogan": "string",
  "description": "string",
  "locationName": "string",
  "locationStreet": "string",
  "locationCity": "string",
  "locationPostal": "string",
  "locationCountry": "string",
  "image": "string",
  "ticketFooter": "string",
  "ticketBackground": "string",
  "ticketShopHeader": "string",
  "groups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "tickets": [
        "string"
      ]
    }
  ],
  "discountGroups": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "min": 10.5,
          "max": 10.5,
          "group": "string",
          "type": "ticketGroups"
        }
      ],
      "discountType": "fix"
    }
  ],
  "cartAutomationRules": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "triggerType": "hasBeenAdded",
      "triggerTargetGroup": "string",
      "thenType": "autoAdd",
      "thenTargets": [
        {
          "_id": "507f191e810c19729de860ea",
          "thenTargetGroup": "string",
          "thenTargetMin": 10.5,
          "thenTargetMax": 10.5
        }
      ]
    }
  ],
  "posDiscounts": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "value": 10.5,
      "discountType": "fix"
    }
  ],
  "categories": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "description": "string",
      "seatingReference": "string",
      "ref": "string",
      "amount": 10.5,
      "recommendedTicket": "string",
      "maxAmountPerOrder": 10.5,
      "listWithoutSeats": true
    }
  ],
  "tickets": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "price": 10.5,
      "amount": 10.5,
      "active": true,
      "description": "string",
      "image": "string",
      "color": "string",
      "posActive": true,
      "categoryRef": "string",
      "ignoredForStartingPrice": true,
      "conditionalAvailability": true,
      "ticketBackground": "string",
      "rules": [
        {
          "_id": "507f191e810c19729de860ea",
          "ticketGroup": "string",
          "min": 10.5,
          "max": 10.5
        }
      ],
      "requiresPersonalization": true,
      "requiresPersonalizationMode": "ENABLED",
      "requiresExtraFields": true,
      "requiresExtraFieldsMode": "ENABLED",
      "repersonalizationAllowedMode": "ENABLED",
      "repersonalizationFee": 10.5,
      "sortingKey": 10.5,
      "enableHardTicketOption": true,
      "forceHardTicketOption": true,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 10.5,
      "minAmountPerOrderRule": 10.5,
      "taxRate": 10.5,
      "styleOptions": {},
      "priceCategoryId": "507f191e810c19729de860ea",
      "entryPermissions": [],
      "ignoreForMaxAmounts": true,
      "expirationSettings": {},
      "barcodePrefix": "string",
      "salesStart": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "salesEnd": {
        "unit": "hours",
        "offset": 1,
        "target": "string"
      },
      "transferSettings": {},
      "scanSettings": {
        "feedback": "highlight",
        "allowedScanCount": 10.5
      },
      "deliverySettings": {
        "wallet": {
          "enabled": "ENABLED"
        },
        "pdf": {
          "enabled": "ENABLED"
        }
      },
      "meta": {},
      "revealingSettings": {
        "enabled": "ENABLED",
        "beforeEvent": {
          "unit": "hours",
          "offset": 1,
          "target": "string"
        }
      }
    }
  ],
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "sellStart": "2030-01-23T23:00:00.123Z",
  "sellEnd": "2030-01-23T23:00:00.123Z",
  "maxAmountPerCustomer": 10.5,
  "maxTransactionsPerCustomer": 10.5,
  "minAmountPerOrder": 1,
  "customerTags": [],
  "customerSegments": [],
  "showCountdown": true,
  "hideInListing": true,
  "visibleAfter": "2030-01-23T23:00:00.123Z",
  "customSettings": {},
  "extraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "ticketExtraFields": [
    {
      "_id": "507f191e810c19729de860ea",
      "required": true,
      "name": "Example Name",
      "description": "string",
      "collectInCheckout": true,
      "deleted": true,
      "type": "text",
      "options": [
        "string"
      ],
      "onlyForCertainTicketTypes": true,
      "allowedTicketTypes": [],
      "printable": true,
      "conditions": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseSlug": "string",
          "operator": "equals",
          "value": []
        }
      ],
      "settings": {
        "allowedMimeTypes": [
          "application/pdf"
        ]
      }
    }
  ],
  "accentColor": "#006DCC",
  "pageStyle": "white",
  "showOtherEvents": true,
  "underShops": [
    {
      "_id": "507f191e810c19729de860ea",
      "name": "Example Name",
      "active": true,
      "tickets": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTicket": "string",
          "name": "Example Name",
          "price": 10.5,
          "amount": 10.5,
          "active": true,
          "description": "string"
        }
      ],
      "categories": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseCategoryId": "507f191e810c19729de860ea",
          "amount": 10.5
        }
      ],
      "timeSlots": [
        {
          "_id": "507f191e810c19729de860ea",
          "baseTimeSlotId": "507f191e810c19729de860ea",
          "amount": 10.5,
          "enabled": "ENABLED"
        }
      ],
      "sellStart": "2030-01-23T23:00:00.123Z",
      "sellEnd": "2030-01-23T23:00:00.123Z",
      "maxAmount": 10.5,
      "maxAmountPerOrder": 10.5,
      "minAmountPerOrder": 1,
      "maxTransactionsPerCustomer": 10.5,
      "maxAmountPerCustomer": 10.5,
      "ticketShopHeaderText": "string",
      "customCharges": {},
      "seatingContingents": [
        "string"
      ],
      "availabilityMode": "default",
      "bestAvailableSeatingConfiguration": {
        "enabled": true,
        "enforced": true,
        "allowMassBooking": true
      },
      "reservationSettings": {
        "option": "noReservations"
      },
      "accountSettings": {
        "_id": "507f191e810c19729de860ea",
        "enforceAccounts": true,
        "enforceAuthentication": "DISABLED"
      },
      "customerTags": [],
      "customerSegments": [],
      "allowMassDownload": true,
      "inventoryStrategy": "independent",
      "extraFields": [
        {
          "_id": "507f191e810c19729de860ea",
          "required": true,
          "name": "Example Name",
          "description": "string",
          "collectInCheckout": true,
          "deleted": true,
          "type": "text",
          "options": [
            "string"
          ],
          "onlyForCertainTicketTypes": true,
          "allowedTicketTypes": [],
          "printable": true,
          "conditions": [
            {
              "_id": "507f191e810c19729de860ea",
              "baseSlug": "string",
              "operator": "equals",
              "value": []
            }
          ],
          "settings": {
            "allowedMimeTypes": [
              "application/pdf"
            ]
          }
        }
      ],
      "salesChannelGroupSettings": [
        {
          "salesChannelGroupId": "507f191e810c19729de860ea",
          "enabled": true
        }
      ],
      "paymentSettings": {
        "paymentStrategyId": "507f191e810c19729de860ea"
      },
      "unlockMode": "none"
    }
  ],
  "seating": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "eventKey": "string",
    "eventId": "507f191e810c19729de860ea",
    "seatMapId": "507f191e810c19729de860ea",
    "revisionId": "507f191e810c19729de860ea",
    "orphanConfiguration": {
      "_id": "507f191e810c19729de860ea",
      "minSeatDistance": 2,
      "edgeSeatsOrphaning": true
    },
    "contingents": [
      "string"
    ],
    "availabilityMode": "default",
    "bestAvailableSeatingConfiguration": {
      "enabled": true,
      "enforced": true
    }
  },
  "customTextConfig": {
    "_id": "507f191e810c19729de860ea",
    "buyTicketsCTA": "string"
  },
  "eventType": "SINGLE",
  "childEvents": [
    "string"
  ],
  "url": "https://example.com",
  "tags": [
    "string"
  ],
  "seoSettings": {
    "_id": "507f191e810c19729de860ea",
    "tags": [
      "string"
    ],
    "noIndex": true,
    "title": "string",
    "description": "string"
  },
  "extraInformation": {
    "_id": "507f191e810c19729de860ea",
    "type": "string",
    "category": "string",
    "subCategory": "string"
  },
  "customCharges": {
    "_id": "507f191e810c19729de860ea",
    "outerChargeVar": 10.5,
    "innerChargeVar": 10.5,
    "outerChargeFix": 10.5,
    "innerChargeFix": 10.5,
    "posOuterChargeFix": 10.5,
    "posOuterChargeVar": 10.5,
    "cartOuterChargeFix": 10.5
  },
  "gallery": [
    {
      "_id": "507f191e810c19729de860ea",
      "title": "string",
      "description": "string",
      "copyright": "string",
      "index": 10.5,
      "image": "string"
    }
  ],
  "video": {
    "youtubeID": "507f191e810c19729de860ea"
  },
  "soldOutFallback": {
    "_id": "507f191e810c19729de860ea",
    "soldOutFallbackType": "default",
    "soldOutFallbackLink": "string"
  },
  "ticketDesign": {
    "_id": "507f191e810c19729de860ea",
    "useCustomDesign": true,
    "customDesignURL": "https://example.com",
    "footerDesignURL": "https://example.com",
    "disclaimer": "string",
    "infoColor": "string",
    "showTimeRange": true,
    "hideDates": true,
    "hideTimes": true
  },
  "checkinInformation": {
    "_id": "507f191e810c19729de860ea",
    "checkinStarts": "2030-01-23T23:00:00.123Z"
  },
  "tracking": {
    "facebookPixel": {
      "active": true,
      "pixelId": "507f191e810c19729de860ea"
    },
    "tagging": {
      "enabled": true,
      "tags": [
        "string"
      ]
    }
  },
  "hardTicketSettings": {
    "_id": "507f191e810c19729de860ea",
    "enabled": true,
    "fulfillmentType": "self",
    "printingMethod": "preprinted",
    "hardTicketOuterCharge": 10.5,
    "hardTicketInnerCharge": 10.5,
    "hardTicketPreviewURL": "https://example.com",
    "promotionName": "string",
    "promotionText": "string",
    "requiredDays": 1
  },
  "dataRequestSettings": {
    "requiresPersonalization": false,
    "requiresExtraFields": false,
    "repersonalization": false,
    "posPersonalization": "noPersonalization"
  },
  "styleOptions": {
    "headerStyle": "default",
    "hideLocationMap": false,
    "hideLocationAddress": false,
    "categoryAlignment": 0,
    "showAvailabilityIndicator": false,
    "availabilityIndicatorThresholds": [
      0.3,
      0.7
    ]
  },
  "geoCode": {
    "_id": "507f191e810c19729de860ea",
    "lat": 10.5,
    "lng": 10.5
  },
  "accountSettings": {
    "_id": "507f191e810c19729de860ea",
    "enforceAccounts": true,
    "enforceAuthentication": "DISABLED"
  },
  "reservationSettings": {
    "option": "noReservations"
  },
  "upsellSettings": {
    "_id": "507f191e810c19729de860ea",
    "active": true,
    "productStream": "string",
    "headerImage": "string",
    "crossSells": {
      "eventIds": [
        "string"
      ]
    }
  },
  "repetitionSettings": [
    {
      "every": 10.5,
      "unit": "DAY",
      "from": "2030-01-23T23:00:00.123Z",
      "to": "2030-01-23T23:00:00.123Z",
      "repeatsOn": [
        "SUNDAY"
      ]
    }
  ],
  "rootId": "507f191e810c19729de860ea",
  "daySchemes": [],
  "daySchemeId": "507f191e810c19729de860ea",
  "ticketSettings": {},
  "accessListMapping": [
    {
      "listId": "507f191e810c19729de860ea",
      "ticketTypeId": "507f191e810c19729de860ea"
    }
  ],
  "deliverySettings": {
    "wallet": {
      "enabled": "ENABLED",
      "nfc": "ENABLED",
      "seasonCardShowNextEvent": true
    },
    "pdf": {
      "enabled": "ENABLED"
    }
  },
  "meta": {},
  "timezone": "2030-01-23T23:00:00.123Z",
  "salesChannelGroupSettings": [
    {
      "salesChannelGroupId": "507f191e810c19729de860ea",
      "enabled": true
    }
  ],
  "paymentSettings": {
    "paymentStrategyId": "507f191e810c19729de860ea"
  },
  "timeSlots": [
    {
      "_id": "507f191e810c19729de860ea",
      "startTime": {
        "hour": 1,
        "minute": 1
      },
      "refs": [
        {
          "refType": "category",
          "categoryRef": "string"
        }
      ],
      "amount": 10.5
    }
  ],
  "useTimeSlots": true,
  "attributes": {}
}