Showtime Models

Request Models

GetShowtimeDetailsRequest

Used with the POST /partner/v1/showtime/details/byIds endpoint.

GetShowtimeDetailsRequest {
  ids: List[String],
  page: Option[Int],
  pageSize: Option[Int]
}

Field	Type	Required	Description
`ids`	`List[String]`	Yes	List of showtime IDs to look up
`page`	`Int`	No	Page number
`pageSize`	`Int`	No	Items per page (default: 25, max: 100)

GetShowtimesForVenuesRequest

Used with the POST /partner/v1/showtime/details/forVenues endpoint.

GetShowtimesForVenuesRequest {
  venueIds: Set[String],
  productionIds: Option[Set[String]],
  isoDateBounds: Option[ISODateBounds],
  localDateBounds: Option[LocalDateBounds],
  includeProductionDetails: Option[Boolean],
  marketplaceId: Option[String]
}

Field	Type	Required	Description
`venueIds`	`Set[String]`	Yes	Set of venue IDs to query
`productionIds`	`Set[String]`	No	Filter to specific productions
`isoDateBounds`	`ISODateBounds`	No	Date range (ISO 8601)
`localDateBounds`	`LocalDateBounds`	No	Date range (local time)
`includeProductionDetails`	`Boolean`	No	If `true`, response includes `productionDetailsMap`
`marketplaceId`	`String`	No	Marketplace filter

Response Models

Attribute

Describes a showtime attribute (e.g., IMAX, Reserved Seating, 3D).

Attribute {
  id: String,
  type: String,
  iconUrl: String,
  friendlyName: Option[String],
  description: Option[String]
}

Field	Type	Description
`id`	`String`	Attribute key (e.g., `"RESERVED"`, `"REALD3D"`)
`type`	`String`	Attribute type category
`iconUrl`	`String`	URL to the attribute icon image
`friendlyName`	`String?`	Human-readable name
`description`	`String?`	Full description of the attribute

Price

Price {
  value: BigDecimal,
  currencyCode: String
}

Field	Type	Description
`value`	`BigDecimal`	Price amount
`currencyCode`	`String`	Currency code (e.g., `"USD"`)

Offer

A ticket type and its price.

Offer {
  label: String,
  price: Price
}

Field	Type	Description
`label`	`String`	Ticket type (e.g., `"Ticket"`, `"Matinee"`, `"Child"`, `"Senior"`)
`price`	`Price`	Ticket price

OfferData

OfferData {
  offers: List[Offer]
}

ShowtimeDetail

Full showtime information.

ShowtimeDetail {
  showtimeId: String,
  productionId: String,
  venueId: String,
  offerData: OfferData,
  utcShowtimeStart: String,
  localShowtimeStart: String,
  attributes: List[String],
  checkoutUrl: Option[String],
  availableInventory: Option[Int],
  tags: Option[Set[String]]
}

Field	Type	Description
`showtimeId`	`String`	Unique showtime identifier
`productionId`	`String`	Associated production ID
`venueId`	`String`	Associated venue ID
`offerData`	`OfferData`	Available ticket offers and pricing
`utcShowtimeStart`	`String`	Showtime in UTC (ISO 8601, no milliseconds)
`localShowtimeStart`	`String`	Showtime in local timezone (ISO 8601)
`attributes`	`List[String]`	Attribute keys — look up in `attributeMap`
`checkoutUrl`	`String?`	Direct link to the Atom checkout flow
`availableInventory`	`Int?`	Number of available seats
`tags`	`Set[String]?`	Tags for special event showtimes

PreOrderDetail

Information about upcoming showtimes available for pre-order.

PreOrderDetail {
  productionId: String,
  venueId: String,
  showtimeDays: List[String]
}

Field	Type	Description
`productionId`	`String`	Associated production ID
`venueId`	`String`	Associated venue ID
`showtimeDays`	`List[String]`	Dates with available pre-order showtimes

ShowtimeDetailsResponse

Response for single-venue showtime queries.

ShowtimeDetailsResponse {
  showtimeDetails: List[ShowtimeDetail],
  preOrderDetails: List[PreOrderDetail],
  attributeMap: Map[String, Attribute]
}

Field	Type	Description
`showtimeDetails`	`List[ShowtimeDetail]`	List of showtimes
`preOrderDetails`	`List[PreOrderDetail]`	Pre-order showtime info
`attributeMap`	`Map[String, Attribute]`	Attribute definitions keyed by attribute ID

VenueShowtimeDetails

Showtimes grouped for a single venue (used within the multi-venue response).

VenueShowtimeDetails {
  showtimeDetails: List[ShowtimeDetail],
  preOrderDetails: List[PreOrderDetail]
}

ShowtimeDetailsForVenuesResponse

Response for multi-venue showtime queries.

ShowtimeDetailsForVenuesResponse {
  venueShowtimeDetailsMap: Map[String, VenueShowtimeDetails],
  attributeMap: Map[String, Attribute],
  productionDetailsMap: Map[String, ProductionDetail]
}

Field	Type	Description
`venueShowtimeDetailsMap`	`Map[String, VenueShowtimeDetails]`	Showtimes keyed by venue ID
`attributeMap`	`Map[String, Attribute]`	Attribute definitions
`productionDetailsMap`	`Map[String, ProductionDetail]`	Production details (only if `includeProductionDetails` was `true`)