Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WaitingList

Hierarchy

Index

Properties

accessMode

accessMode: WL_ACCESS_MODE

The way to access this WL

Optional actionStatus

What action can be taken next?

currency

currency: Currency

Currency

description

description: any

Experience (description) (locale => value)

directSalesEnabled

directSalesEnabled: boolean

Wether direct sales is enabled for this WL, meaning the fan can receive his seats immediately if available, without the need for manual distribution.

discountAmount

discountAmount: Price

Discount amount

discountPercentage

discountPercentage: number

% discount based on price / discount price

displayName

displayName: string

Display name (wl name if available, otherwise venue category name)

eventEndDate

eventEndDate: string

Event end date

eventImageUrl

eventImageUrl: string

Event image URL

eventName

eventName: object

Event name: { string => string }

deprecated

use translatedEventName instead

eventRequiredAttendeeInfo

eventRequiredAttendeeInfo: EVENT_REQUIRED_ATTENDEE_INFO[]

The information that all attendees should provide to obtain tickets for this WL

eventShortName

eventShortName: object

Event short name: { string => string }

deprecated

use translatedEventShortName

eventStartDate

eventStartDate: string

When the event for this WL starts

format

ISO_8601

experienceName

experienceName: any

Experience name (wish list name) (locale => value)

feeCalculationParameters

feeCalculationParameters: FeeCalculationParameters

Fee calculation parameters

fixedNumberOfSeatsPerPosition

fixedNumberOfSeatsPerPosition: number

(random distribution only) Fixed amount of tickets to be won by a fan

formattedDiscountAmount

formattedDiscountAmount: string

Formatted discount

formattedOriginalPrice

formattedOriginalPrice: string

Formatted original price

freeWaitingList

freeWaitingList: boolean

True if Waiting List is free, false otherwise.

groupBackgroundImageUrl

groupBackgroundImageUrl: string

Fan Group background image URL

groupCategories

groupCategories: FanGroupCategory[]

FanGroup categories

groupCoverImageUrl

groupCoverImageUrl: string

Fan Group cover image URL

groupId

groupId: string

Fan Group ID

format

UUID

groupName

groupName: string

Fan Group name: { string => string }

deprecated

use translatedGroupName

groupProfileImageUrl

groupProfileImageUrl: string

Fan Group profile image URL

groupRankAndLikelihoodHidden

groupRankAndLikelihoodHidden: boolean

Visibility of Rank and Likelihood at fan group level

groupShortName

groupShortName: any

Group short name: { string => string }

deprecated

use translatedGroupShortName

groupSlug

groupSlug: string

slug of the group (e.g. https://seaters.com/my-slug)

keywords

keywords: LanguageCode

Keywords related to the WL

maxNumberOfSeatsPerPosition

maxNumberOfSeatsPerPosition: number

Maximum number of Seats a Fan can reserve when joining a Waiting List

minNumberOfSeatsPerPosition

minNumberOfSeatsPerPosition: number

Minimum number of Seats a Fan can reserve when joining a Waiting List

originalPrice

originalPrice: Price

Original price of a single ticket To be used when calculating the discount (done at backend side)

participationEndDate

participationEndDate: string

(random distribution only) End date of contest

position

Position data or null if Waiting List is not yet joined

positionsDistributionMode

positionsDistributionMode: string

Distribution mode - how tickets are distributed

  • wl_positions_distribution_mode_fifs = default, rank based distribution
  • wl_positions_distribution_mode_random = random distribution

price

price: Price

Price breakdown for the # of ordered ticket(s) or for one single ticket

processing

processing: boolean

Is seaters currently processing your request?

protectionCodeExplanation

protectionCodeExplanation: string

Translated text explaining how to obtain the code protecting this WL

request

Join request status

seat

seat: Seat

Seat data or null if Waiting List has no seat yet

seatCategory

seatCategory: string

Seat category

seatDistributionMode

seatDistributionMode: SEAT_DISTRIBUTION_MODE

What kind of tickets are distributed

shouldProvideAttendeesInfo

shouldProvideAttendeesInfo: boolean

If required, does the attendee info needs to be provided still?

showFreePrice

showFreePrice: boolean

Visibility of price when waiting list is free indicator

termsAndConditionFileURL

termsAndConditionFileURL: string

(random distribution only) URL to the terms and conditions PDF file

translatedDescription

translatedDescription: string

Description, translated in fan's locale

translatedEventDescription

translatedEventDescription: string

Event description, translated in the fan's locale

translatedEventName

translatedEventName: string

Event name, translated in fan's locale

translatedEventShortName

translatedEventShortName: string

Event short name, translated in fan's locale

translatedExperienceName

translatedExperienceName: string

Experience name, translated in fan's locale

translatedGroupName

translatedGroupName: string

Fan Group name, translated in fan's locale

translatedShortGroupName

translatedShortGroupName: string

Group short name, translated in fan's locale

translatedVenueCity

translatedVenueCity: string

Venue city, translated in fan's locale

translatedVenueCountry

translatedVenueCountry: string

Venue country, translated in the fan's locale

translatedVenueName

translatedVenueName: string

Venue name, translated in fan's locale

translatedVenueShortName

translatedVenueShortName: string

Venue short name, translated in fan's locale

venueCity

venueCity: object

Venue city: { string => string }

deprecated

use translatedVenueCity

venueCountry

venueCountry: object

Venue country: {string =>string}

deprecated

use translatedVenueCountry

venueImageUrl

venueImageUrl: string

Venue image URL

venueName

venueName: object

Venue name: { string => string }

deprecated

use translatedVenueName

venueShortName

venueShortName: any

Venue short name: { string => string }

deprecated

use translatedVenueShortName

voucherText

voucherText: LanguageCode

Always-populated voucher text

waitingListId

waitingListId: string

Waiting List ID

waitingListImageUrl

waitingListImageUrl: string

Waiting list image URL

waitingListStatus

waitingListStatus: WL_STATUS

Waiting List status

Generated using TypeDoc