Skip to content
Docs
Reference

Interface: BestAvailableRequest

Interface: BestAvailableRequest in @ticketlayer/live.

@ticketlayer/live


@ticketlayer/live / index / BestAvailableRequest

Defined in: seating.ts:165

A party, as best available is asked for it. Prices are fee-inclusive minor units, as the engine compares them. There is no sessionId: Live sets the spread seed from the session and drops one a browser sends.

Properties#

accessible?#

optional accessible?: number;

Defined in: seating.ts:186

Wheelchair spaces needed; companion seats become eligible beside them.


aisle?#

optional aisle?: boolean;

Defined in: seating.ts:184

An end seat of the block on an aisle.


areas?#

optional areas?: string[];

Defined in: seating.ts:179

Area ids (a tier, a stand): only these, or preferred when withinHard is false.


categories?#

optional categories?: string[];

Defined in: seating.ts:171

Seat category ids: only these.


maxPriceEach?#

optional maxPriceEach?: number;

Defined in: seating.ts:173

The most one ticket may cost, fees included.


maxTotal?#

optional maxTotal?: number;

Defined in: seating.ts:175

The most the whole block may cost, fees included.


options?#

optional options?: number;

Defined in: seating.ts:190

How many options, 1 to 8; absent, the channel's default (three online).


priceHard?#

optional priceHard?: boolean;

Defined in: seating.ts:177

False: the price ceilings are a preference, not a filter.


quantity#

quantity: number;

Defined in: seating.ts:167

How many seats, 1 to the channel's maxTickets.


sectionId?#

optional sectionId?: string | null;

Defined in: seating.ts:192

One section, the one the map is in: the same as sections: [sectionId] with withinHard.


sections?#

optional sections?: string[];

Defined in: seating.ts:181

Section ids, the same way.


tickets?#

optional tickets?: {
  quantity: number;
  ticketTypeId: string;
}[];

Defined in: seating.ts:169

The ticket mix, adding up to quantity; absent, each seat on its category's default type.

quantity#

quantity: number;

ticketTypeId#

ticketTypeId: string;

together?#

optional together?: "row" | "rows" | "any";

Defined in: seating.ts:188

row: one row. rows (the engine's default): rows one behind the other if one row cannot. any: then the nearest seats.


withinHard?#

optional withinHard?: boolean;

Defined in: seating.ts:182