Reference

Interface: OccurrenceOffers

Interface: OccurrenceOffers in @ticketlayer/live.

@ticketlayer/live / index / OccurrenceOffers

What getOffers resolves to.

Properties#

availability#

availability: 
  | {
  closesAt: string | null;
  opensAt: string | null;
  reason:   | "SALE_CLOSED"
     | "NOT_AVAILABLE"
     | "SOLD_OUT"
     | "SALE_NOT_OPEN"
     | "TAG_REQUIRED"
     | null;
  state:   | "on_sale"
     | "not_yet_on_sale"
     | "off_sale"
     | "sold_out"
     | "locked"
     | "hidden";
}
  | null;

Defined in: elements.ts:331

The occurrence's own state for this buyer; null on an older response.

Union Members#

Type Literal

{
  closesAt: string | null;
  opensAt: string | null;
  reason:   | "SALE_CLOSED"
     | "NOT_AVAILABLE"
     | "SOLD_OUT"
     | "SALE_NOT_OPEN"
     | "TAG_REQUIRED"
     | null;
  state:   | "on_sale"
     | "not_yet_on_sale"
     | "off_sale"
     | "sold_out"
     | "locked"
     | "hidden";
}

closesAt

closesAt: string | null;

Description

When the sale this buyer is under closes; for off_sale, when it closed

Example

2026-10-14T18:00:00.000Z

opensAt

opensAt: string | null;

Description

When a sale not yet open opens for this buyer

Example

null

reason

reason: 
  | "SALE_CLOSED"
  | "NOT_AVAILABLE"
  | "SOLD_OUT"
  | "SALE_NOT_OPEN"
  | "TAG_REQUIRED"
  | null;

Description

Why it cannot be bought now: SALE_CLOSED, NOT_AVAILABLE, SOLD_OUT, SALE_NOT_OPEN or TAG_REQUIRED; null when on sale

Example

null
@enum {string|null}

state

state: 
  | "on_sale"
  | "not_yet_on_sale"
  | "off_sale"
  | "sold_out"
  | "locked"
  | "hidden";

Example

on_sale
@enum {string}

null

lockedTicketTypes#

lockedTicketTypes: ElementTicketType[];

Defined in: elements.ts:334

Locked prices: show them as locked, never as buyable.

ticketTypes#

ticketTypes: ElementTicketType[];

Defined in: elements.ts:332