Gets a showtime by its unique identifier

Completed Order Assets

Operations

Completed Orders

Operations

Orders

Operations

Seats

Operations

Discounts

Operations

Events

Operations

Showtimes

Operations

Gets a list of showtime entities for an event

Request

Licenses Required

Vista.Ocapi

Path

eventIdstringrequired

The unique identifier of the event

Query

siteIdsArray of stringsunique

Site filter

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/events/{eventId}/showtimes?siteIds=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

eventIdstringnon-emptyrequired

Gets the unique identifier of the event

showtimesArray of objects(Showtime)required

Gets the list of showtime entities

showtimes[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

showtimes[].scheduleobject(ShowtimeSchedule)required

Gets the timing schedule

showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

showtimes[].isSoldOutbooleanrequired

Gets a value indicating whether the showtime is currently sold out

showtimes[].seatLayoutIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the seat layout of the screen

showtimes[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film that is being screened

showtimes[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site that is screening the film

showtimes[].screenIdstringnon-emptyrequired

Gets the unique identifier of the screen that the film will be played on

showtimes[].areaCategoriesArray of objects(ShowtimeAreaCategory)required

Gets the list of showtime area category entities

showtimes[].areaCategories[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category entity

showtimes[].areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].attributeIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned attribute entities

showtimes[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].requires3dGlassesbooleanrequired

Gets a value indicating whether this showtime requires 3D glasses to be viewed

showtimes[].eventIdstring or null

Gets the unique identifier of the event the showtime is assigned to, if applicable

showtimes[].restrictionsArray of strings(ShowtimeRestriction)required

Gets the list of restrictions that apply

Items Value"FilmAdvanceBookingRule"

showtimes[].filmAdvanceBookingRuleIdstring or null

Gets the unique identifier of the film advance booking rule that the showtime is restricted to

relatedDataobject(EventShowtimeListRelatedData)required

Gets the related data for the showtime entities

relatedData.eventobject(Event)required

Gets the related event entity

relatedData.event.idstringnon-emptyrequired

Gets the unique identifier

relatedData.event.nameobject(Translatable)required

Gets the name text, and its translations

relatedData.event.name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.event.name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.event.name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.event.name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.event.shortNameobject(Translatable)

Gets the short name text, and its translations

relatedData.event.descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.event.scheduleobject(EventSchedule)required

Gets the schedule

relatedData.event.schedule.startDatestring or null(date-time)

Gets the start date, if applicable

relatedData.event.schedule.endDatestring or null(date-time)

Gets the end date, if applicable

relatedData.event.siteIdsArray of stringsrequired

Gets the list of unique identifiers of the site entities screening the event

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.filmsArray of objects(Film)required

Gets the list of related film entities

relatedData.films[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.films[].titleobject(Translatable)required

Gets the title text, and its translations

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.films[].synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

relatedData.films[].shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

relatedData.films[].censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

relatedData.films[].censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

relatedData.films[].releaseDatestring(date-time)required

Gets the release date of the film

relatedData.films[].runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

relatedData.films[].trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

relatedData.films[].trailers[].providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"

relatedData.films[].trailers[].uristring(uri)required

Gets the address used for retrieving the trailer

relatedData.films[].trailerUrlstring or null(uri)

Gets the trailer video URL

relatedData.films[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.films[].castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required

relatedData.films[].castAndCrew[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].castAndCrew[].rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"

relatedData.films[].actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].actors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].directors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].producers[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

relatedData.films[].externalIdsobject(FilmExternalIds)required

Gets the external identifiers

relatedData.films[].externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].hopkstring or null

Gets the Head Office primary key

relatedData.films[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.films[].eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

relatedData.films[].distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedData.castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.castAndCrew[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.castAndCrew[].nameobject(PersonName)required

Gets the person's name

relatedData.castAndCrew[].name.givenNamestring or null

Gets the given name

relatedData.castAndCrew[].name.familyNamestring or null

Gets the family name

relatedData.castAndCrew[].name.middleNamestring or null

Gets the middle or any additional name

relatedData.genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.genres[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.genres[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.genres[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.genres[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.genres[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.genres[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.genres[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.attributes[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.attributes[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.attributes[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.attributes[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.attributes[].importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.attributes[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.attributes[].isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screens[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.filmAdvanceBookingRulesArray of objects(FilmAdvanceBookingRule)required

Gets the list of related film advance booking rule entities

relatedData.filmAdvanceBookingRules[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.filmAdvanceBookingRules[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film

relatedData.filmAdvanceBookingRules[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

relatedData.filmAdvanceBookingRules[].bookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

relatedData.filmAdvanceBookingRules[].bookingPeriods[].startsAtstring(date-time)required

Gets the date and time that the booking period starts

relatedData.filmAdvanceBookingRules[].bookingPeriods[].orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

Response

application/json

{
  "eventId": "string",
  "showtimes": [
    { … }
  ],
  "relatedData": {
    "event": { … },
    "sites": [ … ],
    "films": [ … ],
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRatings": [ … ],
    "attributes": [ … ],
    "screens": [ … ],
    "filmAdvanceBookingRules": [ … ],
    "areaCategories": [ … ]
  }
}

Gets a list of showtime entities for a film

Request

Returns an empty list of showtime entities if no showtimes are scheduled for that film

There is a maximum of 5 site identifiers to be passed into the siteIds parameter.

Licenses Required

Vista.Ocapi

Path

filmIdstringrequired

The film identifier of the requested showtimes

Query

siteIdsArray of stringsunique

The site filter

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/films/{filmId}/showtimes?siteIds=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

filmIdstringnon-emptyrequired

showtimesArray of objects(Showtime)required

showtimes[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

showtimes[].scheduleobject(ShowtimeSchedule)required

Gets the timing schedule

showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

showtimes[].isSoldOutbooleanrequired

Gets a value indicating whether the showtime is currently sold out

showtimes[].seatLayoutIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the seat layout of the screen

showtimes[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film that is being screened

showtimes[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site that is screening the film

showtimes[].screenIdstringnon-emptyrequired

Gets the unique identifier of the screen that the film will be played on

showtimes[].areaCategoriesArray of objects(ShowtimeAreaCategory)required

Gets the list of showtime area category entities

showtimes[].areaCategories[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category entity

showtimes[].areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].attributeIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned attribute entities

showtimes[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].requires3dGlassesbooleanrequired

Gets a value indicating whether this showtime requires 3D glasses to be viewed

showtimes[].eventIdstring or null

Gets the unique identifier of the event the showtime is assigned to, if applicable

showtimes[].restrictionsArray of strings(ShowtimeRestriction)required

Gets the list of restrictions that apply

Items Value"FilmAdvanceBookingRule"

showtimes[].filmAdvanceBookingRuleIdstring or null

Gets the unique identifier of the film advance booking rule that the showtime is restricted to

relatedDataobject(FilmShowtimeListRelatedData)required

Related data for a list of showtime entities for a particular film

relatedData.filmobject(Film)required

Represents a film entity

relatedData.film.idstringnon-emptyrequired

Gets the unique identifier

relatedData.film.titleobject(Translatable)required

Gets the title text, and its translations

relatedData.film.title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.film.title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.film.title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.film.title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.film.synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

relatedData.film.shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

relatedData.film.censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

relatedData.film.censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

relatedData.film.releaseDatestring(date-time)required

Gets the release date of the film

relatedData.film.runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

relatedData.film.trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

relatedData.film.trailers[].providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"

relatedData.film.trailers[].uristring(uri)required

Gets the address used for retrieving the trailer

relatedData.film.trailerUrlstring or null(uri)

Gets the trailer video URL

relatedData.film.displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.film.castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required

relatedData.film.castAndCrew[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.castAndCrew[].rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"

relatedData.film.actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.film.actors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.film.directors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.film.producers[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

relatedData.film.externalIdsobject(FilmExternalIds)required

Gets the external identifiers

relatedData.film.externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.film.externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.film.hopkstring or null

Gets the Head Office primary key

relatedData.film.hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.film.eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

relatedData.film.distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.eventsArray of objects(Event)required

relatedData.events[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.events[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.events[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.events[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.events[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.events[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.events[].shortNameobject(Translatable)

Gets the short name text, and its translations

relatedData.events[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.events[].scheduleobject(EventSchedule)required

Gets the schedule

relatedData.events[].schedule.startDatestring or null(date-time)

Gets the start date, if applicable

relatedData.events[].schedule.endDatestring or null(date-time)

Gets the end date, if applicable

relatedData.events[].siteIdsArray of stringsrequired

Gets the list of unique identifiers of the site entities screening the event

relatedData.castAndCrewArray of objects(CastAndCrewMember)required

relatedData.castAndCrew[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.castAndCrew[].nameobject(PersonName)required

Gets the person's name

relatedData.castAndCrew[].name.givenNamestring or null

Gets the given name

relatedData.castAndCrew[].name.familyNamestring or null

Gets the family name

relatedData.castAndCrew[].name.middleNamestring or null

Gets the middle or any additional name

relatedData.genresArray of objects(Genre)required

relatedData.genres[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.genres[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.genres[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.genres[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.genres[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.genres[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.genres[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.censorRatingsArray of objects(CensorRating)required

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.attributesArray of objects(Attribute)required

relatedData.attributes[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.attributes[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.attributes[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.attributes[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.attributes[].importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.attributes[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.attributes[].isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

relatedData.screensArray of objects(Screen)required

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screens[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.filmAdvanceBookingRulesArray of objects(FilmAdvanceBookingRule)required

relatedData.filmAdvanceBookingRules[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.filmAdvanceBookingRules[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film

relatedData.filmAdvanceBookingRules[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

relatedData.filmAdvanceBookingRules[].bookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

relatedData.filmAdvanceBookingRules[].bookingPeriods[].startsAtstring(date-time)required

Gets the date and time that the booking period starts

relatedData.filmAdvanceBookingRules[].bookingPeriods[].orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedData.areaCategoriesArray of objects(AreaCategory)required

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

Response

application/json

{
  "filmId": "string",
  "showtimes": [
    { … }
  ],
  "relatedData": {
    "film": { … },
    "sites": [ … ],
    "events": [ … ],
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRatings": [ … ],
    "attributes": [ … ],
    "screens": [ … ],
    "filmAdvanceBookingRules": [ … ],
    "areaCategories": [ … ]
  }
}

Sets the requested tickets and/or seats for an order showtime within an in progress standard order

Request

This endpoint cannot be used for orders that have a parent order (see standard order ParentOrderId)

Specifying Tickets without Seats (Ticket-first Ordering)

If session seat allocation is marked as None: Tickets will be booked without specific seats
If session seat allocation is marked as Manual: Tickets will be booked. Seats will be auto-allocated if possible.
If session seat allocation is marked as Auto: Tickets will be booked. Seats will be auto-allocated if possible.

Specifying Seats (Ticket-first and seat-first Ordering)

If session seat allocation is marked as None: Specifying seats is invalid - a 400 will be returned.
If session seat allocation is marked as Manual: Specified seats will be reserved if possible - otherwise a SeatsUnavailable error will be returned.
If session seat allocation is marked as Auto: Specified seats will be reserved if possible - otherwise a SeatsUnavailable error will be returned.

Auto-Allocation

The system may attempt to auto-allocate seats if specific seats are not supplied, depending on system configuration.
The auto-allocation system is not guaranteed to allocate seats. Auto-allocation may fail if seats cannot be allocated contiguously.
When allocation fails the client must render a seat plan and the seats must be manually specified.
It is recommended the client render the seat plan regardless to provide the opportunity for the customer to modify the auto-allocated selections.

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the in progress standard order being modified

showtimeIdstringrequired

The unique identifier of the order showtime being modified

Headers

Connect-Region-Codestring

Region Code

Body

required

The requested tickets and/or seats

ticketsArray of objects or null(OrderTicketRequest)

Gets the list of order ticket request entities

seatsArray of strings or null

Gets the list of unique identifiers of the requested seat entities

curl -i -X PUT \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "tickets": [
      {
        "id": "string",
        "ticketTypeId": "string",
        "rewardId": 0,
        "ticketRedemptionCardId": "1c953716-206c-4079-9c26-e26d83d3b6c5",
        "voucherId": "string",
        "discountId": "string"
      }
    ],
    "seats": [
      "string"
    ]
  }'

Responses

Success

Bodyapplication/json

orderobject(InProgressStandardOrder)required

Gets the in progress order base entity

order.idstring or null

Gets the unique identifier

order.typestring(OrderType)required

Gets the type

Enum"Standard""GiftShop""Subscription"

order.statusstring(OrderStatus)required

Gets the status

Enum"InProgress""Completed"

order.totalPriceobject(MonetaryValue)required

Gets the total price to be displayed to the customer

order.totalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.totalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.totalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.bookingobject(InProgressOrderBooking)required

Gets the booking details

order.booking.modestring(OrderBookingMode)required

Gets the order booking mode.

Enum"Paid""Unpaid""UnpaidConfirmed"

order.booking.totalBookingFeeobject(MonetaryValue)required

Gets the total booking fee amount the customer has currently paid.

order.booking.totalBookingFee.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.booking.totalBookingFee.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.booking.totalBookingFee.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.showtimesArray of objects(OrderShowtime)required

Gets the list of order showtime entities

order.showtimes[].showtimeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the showtime

order.showtimes[].ticketsArray of OrderTicketLineBase (object)required

Gets the list of order ticket line base entities

One of:

Represents an order ticket line base for an instance of a package ticket type

order.showtimes[].tickets[].typestring(TicketTypeType)required

Gets the type

Enum"Normal""Package"

order.showtimes[].tickets[].ticketsArray of objects(OrderPackageTicketContentTicket)required

Gets the list of order package ticket content ticket entities

order.showtimes[].tickets[].tickets[].ticketTypeIdstringnon-emptyrequired

Gets the unique identifier of the normal ticket type

order.showtimes[].tickets[].tickets[].admissionStatusstring(OrderTicketAdmissionStatus)required

Gets the admission status

Enum"NotAdmitted""Admitted"

order.showtimes[].tickets[].itemsArray of objects(OrderPackageTicketContentItem)required

Gets the list of order package ticket content item entities

order.showtimes[].tickets[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.showtimes[].tickets[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the line within the order base

order.showtimes[].tickets[].collectionStatusstring(OrderLineCollectionStatus)required

Gets the collection status

Enum"NotCollected""Collected"

order.showtimes[].tickets[].refundStatusstring(OrderLineRefundStatus)required

Gets the refund status

Enum"NotRefunded""Refunded"

order.showtimes[].tickets[].ticketTypeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the ticket type base

order.showtimes[].tickets[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.showtimes[].tickets[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.showtimes[].tickets[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.showtimes[].tickets[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.showtimes[].tickets[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the ticket due to all discounts and deals

order.showtimes[].tickets[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.showtimes[].tickets[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.showtimes[].tickets[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.showtimes[].tickets[].bookingFeeobject(OrderBookingFeeLine)

Gets the booking fee incurred for the ticket, if applicable

order.showtimes[].tickets[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward used, if applicable

order.showtimes[].tickets[].ticketRedemptionCardIdstring or null(uuid)

Gets the unique identifier of the order ticket redemption card base used, if applicable

order.showtimes[].tickets[].voucherIdstring or null

Gets the unique identifier of the order voucher used, if applicable

order.showtimes[].tickets[].discountIdstring or nullread-only

Gets the unique identifier of the discount used, if applicable

order.showtimes[].tickets[].dealIdstring or null

Gets the unique identifier of the order deal used, if applicable

order.showtimes[].tickets[].refundAvailabilityCompletedOrderLineRefundAvailability (object) or CompletedWeightBasedOrderLineRefundAvailability (object) or InProgressOrderLineRefundAvailability (object)required

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

order.showtimes[].tickets[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the order line can be refunded

order.showtimes[].tickets[].refundAvailability.unavailableReasonstring(OrderLineRefundUnavailableReason)required

Gets the reason the order line cannot be refunded

Enum"NotApplicable""NotEnabled""OrderNotCompleted""AlreadyCollected""AlreadyRefunded""ItemDeliveryPreparationStarted""ShowtimeRefundWindowEnded""VoucherRedeemed""RedeemableItemIssued""OrderExpired"

order.showtimes[].seatsArray of objects(OrderSeat)required

Gets the list of order seat entities

order.showtimes[].seats[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

order.showtimes[].seats[].seatLabelstring or null

Gets the label/physical name of the seat

Example: "5"

order.showtimes[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

order.showtimes[].seats[].areaNameobject(Translatable)required

Gets the area name text, and its translations

order.showtimes[].seats[].areaName.textstringnon-emptyrequired

Gets the text in the default language

order.showtimes[].seats[].areaName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

order.showtimes[].seats[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category the seat belongs to

order.showtimes[].seats[].positionobject(SeatPosition)required

Gets the seat position

order.showtimes[].seats[].position.areaNumberinteger(int32)required

Gets the number that can be used to uniquely identify the area within the seat layout

order.showtimes[].seats[].position.columnNumberinteger(int32)required

Gets the number that can be used to uniquely identify the column of the seat entity within the area

order.showtimes[].seats[].position.rowNumberinteger(int32)required

Gets the number that can be used to uniquely identify the row within the area

order.showtimes[].seatSwapStatusobject(OrderShowtimeSeatSwapStatus)required

Gets the seat swap status

order.showtimes[].seatSwapStatus.isAvailablebooleanrequired

Gets a value indicating whether the order showtime Seats can be swapped

order.showtimes[].seatSwapStatus.unavailableReasonstring(OrderShowtimeSeatSwapUnavailableReason)required

Gets the reason the seats cannot be swapped

Enum"NotApplicable""NotEnabled""UnallocatedSeating""NoSeats""PackageTickets""InSeatDeliveryItems""OrderNotCompleted""OrderRefunded""UnpaidBooking""ShowtimeEnded"

order.itemsArray of OrderItemLineBase (object)required

Gets the list of order item line base entities

One of:

Represents the base properties of an order line for a top-level instance of an item base within a standard order or gift shop order

order.items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

order.items[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

order.items[].modifierGroups[].modifiersArray of objects(OrderItemModifier)required

Gets the list of order item modifier entities

order.items[].modifierGroups[].modifiers[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].modifierGroups[].modifiers[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.items[].modifierGroups[].modifiers[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the item due to all discounts and deals

order.items[].itemsArray of objects(OrderPackageItemContentItem)required

Gets the list of order package item content item base entities

order.items[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].items[].typestring(ItemType)required

Gets the item type

Enum"Normal""ParentSales""Package""Recipe""WeightBased"

order.items[].items[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.items[].items[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].items[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].items[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].items[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the item due to all discounts and deals

order.items[].items[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].items[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].items[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].items[].parentSalesItemIdstring or null

Gets the unique identifier of the parent sales item this item is an option for

order.items[].items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

order.items[].items[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

order.items[].items[].modifierGroups[].modifiersArray of objects(OrderItemModifier)required

Gets the list of order item modifier entities

order.items[].items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

order.items[].items[].components[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].items[].components[].typestring(ItemType)required

Gets the item type

Enum"Normal""ParentSales""Package""Recipe""WeightBased"

order.items[].items[].components[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.items[].items[].components[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the item due to all discounts and deals

order.items[].items[].components[].modificationstring(OrderRecipeItemComponentModification)required

Gets the modification

Enum"None""Remove""Extra""OnTheSide""ExtraOnTheSide"

order.items[].items[].components[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

order.items[].items[].components[].parentSalesItemIdstring or nullread-only

Gets the unique identifier of the parent sales item this item is an option for

order.items[].items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

order.items[].items[].commentstring or null

Gets the patron's comment, if applicable

order.items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

order.items[].components[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].components[].typestring(ItemType)required

Gets the item type

Enum"Normal""ParentSales""Package""Recipe""WeightBased"

order.items[].components[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.items[].components[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].components[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].components[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].components[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the item due to all discounts and deals

order.items[].components[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].components[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].components[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].components[].modificationstring(OrderRecipeItemComponentModification)required

Gets the modification

Enum"None""Remove""Extra""OnTheSide""ExtraOnTheSide"

order.items[].components[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

order.items[].components[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

order.items[].components[].modifierGroups[].modifiersArray of objects(OrderItemModifier)required

Gets the list of order item modifier entities

order.items[].components[].parentSalesItemIdstring or nullread-only

Gets the unique identifier of the parent sales item this item is an option for

order.items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

order.items[].commentstring or null

Gets the patron's comment, if applicable

order.items[].itemIdstringnon-emptyrequired

order.items[].idstringnon-emptyrequired

order.items[].typestring(ItemType)required

Represents the type of an item base entity

Enum"Normal""ParentSales""Package""Recipe""WeightBased"

order.items[].priceobject(MonetaryValue)required

Represents a monetary value, and its related tax value

order.items[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].amountSavedobject(MonetaryValue)required

Represents a monetary value, and its related tax value

order.items[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].parentSalesItemIdstring or nullread-only

order.items[].collectionStatusstring(OrderLineCollectionStatus)required

Represents the collection status of an order line

Enum"NotCollected""Collected"

order.items[].refundStatusstring(OrderLineRefundStatus)required

Represents the refund status of an order line

Enum"NotRefunded""Refunded"

order.items[].refundAvailabilityCompletedOrderLineRefundAvailability (object) or CompletedWeightBasedOrderLineRefundAvailability (object) or InProgressOrderLineRefundAvailability (object)required

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

order.items[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the order line can be refunded

order.items[].refundAvailability.unavailableReasonstring(OrderLineRefundUnavailableReason)required

Gets the reason the order line cannot be refunded

Enum"NotApplicable""NotEnabled""OrderNotCompleted""AlreadyCollected""AlreadyRefunded""ItemDeliveryPreparationStarted""ShowtimeRefundWindowEnded""VoucherRedeemed""RedeemableItemIssued""OrderExpired"

order.items[].rewardIdinteger or null(int32)

order.items[].discountIdstring or nullread-only

order.items[].dealIdstring or null

order.itemDeliveriesArray of OrderItemDeliveryBase (object) or CompletedOrderItemCounterPickup (object) or CompletedOrderItemCustomLocationDelivery (object) or CompletedOrderItemElectronicDelivery (object) or CompletedOrderItemInSeatDelivery (object) or CompletedOrderItemPostalDelivery (object) or CompletedOrderItemServiceAreaPickup (object)required

Gets the list of order item delivery base entities for the standard order Items

One of:

Represents an order item delivery base for items that can be picked up by the patron from the counter at any time, as they do not require preparation

order.itemDeliveries[].methodstring(ItemDeliveryMethod)required

Gets the delivery method

Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

order.itemDeliveries[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the delivery within the standard order

order.paymentsArray of OrderRedirectPayment (object) or OrderMemberBalancePayment (object) or OrderGiftCardPayment (object) or OrderExternallyProcessedPayment (object) or OrderEmbeddedPayment (object) or OrderCinemaProcessedPayment (object)required

Gets the list of order payment base entities

One of:

Represents a redirect payment that has been added to an order base

order.payments[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the payment within the order base

order.payments[].typestring(OrderPaymentType)required

Gets the type

Enum"CinemaProcessed""Embedded""GiftCard""Redirect""MemberBalance""ExternallyProcessed"

order.payments[].valuenumber(double)required

Gets the monetary value

order.payments[].statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"

order.vouchersArray of objects(OrderVoucher)required

Gets the list of order voucher entities

order.vouchers[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the voucher within the order base

order.vouchers[].typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"

order.vouchers[].maskedBarcodestringnon-emptyrequired

Gets a masked representation of the barcode

Example: "12.......6789"

order.vouchers[].voucherTypeCodestringnon-emptyrequired

Gets the unique identifier of the voucher type

order.vouchers[].voucherTypeDescriptionobject(Translatable)

Gets the voucher type description text, and its translations

order.dealsArray of objects(OrderDeal)required

Gets the list of order deal entities

order.deals[].idstringnon-emptyread-onlyrequired

Gets the identifier that can be used to uniquely identify the deal within the order base

order.deals[].dealIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the deal base used

order.deals[].voucherIdstring or null

Gets the unique identifier of the order voucher used, if applicable

order.ticketRedemptionCardsArray of TicketRedemptionCardBase (object)required

Gets the list of order ticket redemption card base entities

One of:

Represents a member subscription card that has been added to a standard order

order.ticketRedemptionCards[].typestring(TicketRedemptionCardType)required

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"

order.ticketRedemptionCards[].idstring(uuid)required

Gets the unique identifier that can be used to uniquely identify the card within the standard order

order.ticketRedemptionCards[].subscriptionIdinteger(int32)required

Gets the unique identifier of the subscription the card is linked to

order.ticketRedemptionCards[].maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

Example: "12.......6789"

order.ticketRedemptionCards[].memberNameobject(PersonName)

Gets the name of the person that owns the card, if known

order.expiresAtstring(date-time)required

Gets the date and time that the order is set to expire

order.siteIdstringnon-emptyrequired

Gets the unique identifier of the site

order.hasCustomerbooleanrequired

Gets a value indicating whether the order customer has been set

order.amountSavedobject(MonetaryValue)required

Gets the monetary amount saved via discounted prices

order.amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.tipobject(OrderTip)

Gets the tip

order.parentOrderIdstring or null

Gets the unique identifier of the linked parent completed standard order, if applicable

order.siteOrderLocationIdstring or null

Gets the unique identifier of the site order location, if applicable.
Will equal null if items are ordered from the default site item profile

relatedDataobject(OrderRelatedData)required

Gets the related data for the in progress order base entity

relatedData.filmsArray of objects(OrderRelatedFilm)required

Gets the list of related order related film entities

relatedData.films[].idstringnon-emptyrequired

relatedData.films[].titleobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.films[].externalIdsobject(FilmExternalIds)required

Represents the external identifiers linked to a film

relatedData.films[].externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].censorRatingIdstring or null

relatedData.films[].censorRatingNoteobject(Translatable)

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.ticketTypesArray of objects(OrderRelatedTicketType)required

Gets the list of related order related ticket type entities

relatedData.ticketTypes[].idstringnon-emptyread-onlyrequired

relatedData.ticketTypes[].descriptionobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.ticketTypes[].description.textstringnon-emptyrequired

Gets the text in the default language

relatedData.ticketTypes[].description.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.ticketTypes[].description.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.ticketTypes[].description.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.ticketTypes[].longDescriptionobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.ticketTypes[].longDescription.textstringnon-emptyrequired

Gets the text in the default language

relatedData.ticketTypes[].longDescription.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.ticketTypes[].longDescription.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.ticketTypes[].longDescription.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemsArray of objects(OrderRelatedItem)required

Gets the list of related order related item entities

relatedData.items[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.items[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.items[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.items[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.items[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.items[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.items[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.items[].hopkstring or null

Gets the Head Office primary key

relatedData.items[].isSundryboolean

Gets a value indicating whether this is a sundry item

relatedData.items[].isPreparationRequiredboolean

Gets a value indicating whether the item requires preparation

relatedData.showtimesArray of objects(OrderRelatedShowtime)required

Gets the list of related order related showtime entities

relatedData.showtimes[].idstringnon-emptyread-onlyrequired

relatedData.showtimes[].scheduleobject(ShowtimeSchedule)required

Represents the dates and times relevant to a showtime, e.g. its start, end, film start, etc

relatedData.showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

relatedData.showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

relatedData.showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

relatedData.showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

relatedData.showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

relatedData.showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

relatedData.showtimes[].filmIdstringnon-emptyrequired

relatedData.showtimes[].siteIdstringnon-emptyrequired

relatedData.showtimes[].screenIdstringnon-emptyread-onlyrequired

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screens[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.itemServiceAreasArray of objects(ItemServiceArea)required

Gets the list of related item service area entities

relatedData.itemServiceAreas[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemServiceAreas[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemServiceAreas[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemServiceAreas[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemServiceAreas[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemServiceAreas[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemServiceAreas[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.itemServiceAreas[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemServiceAreas[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemServiceAreas[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemServiceAreas[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemShowtimeDeliveryWindowsArray of objects(ItemShowtimeDeliveryWindowBase)required

Gets the list of related item showtime delivery window base entities

relatedData.itemShowtimeDeliveryWindows[].minutesinteger(int32)required

Gets the targeted delivery time, as a number of minutes from showtime schedule StartsAt

relatedData.itemShowtimeDeliveryWindows[].typestring(ItemShowtimeDeliveryWindowType)required

Gets the type

Value"MinutesFromStart"

relatedData.itemShowtimeDeliveryWindows[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.itemShowtimeDeliveryWindows[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemShowtimeDeliveryWindows[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemShowtimeDeliveryWindows[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemShowtimeDeliveryWindows[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemShowtimeDeliveryWindows[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.subscriptionBillingOptionobject(OrderRelatedSubscriptionBillingOption)

Gets the related order related subscription billing option entity

relatedData.subscriptionobject(OrderRelatedSubscription)

Gets the related order related subscription entity

relatedData.balanceTypeobject(BalanceType)

Gets the related balance type entity, if applicable

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

relatedData.itemPostalDeliveryMethodsArray of objects(OrderRelatedItemPostalDeliveryMethod)required

Gets the list of related order related item postal delivery method entities

relatedData.itemPostalDeliveryMethods[].isDefaultbooleanrequired

Gets a value indicating whether this is the default delivery method

relatedData.itemPostalDeliveryMethods[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemPostalDeliveryMethods[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemPostalDeliveryMethods[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemPostalDeliveryMethods[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemPostalDeliveryMethods[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.itemPostalDeliveryMethods[].name.translations[].textstringnon-emptyrequired

Gets the translated text

Response

application/json

{
  "order": {
    "id": "string",
    "type": "Standard",
    "status": "InProgress",
    "totalPrice": { … },
    "booking": { … },
    "showtimes": [ … ],
    "items": [ … ],
    "itemDeliveries": [ … ],
    "payments": [ … ],
    "vouchers": [ … ],
    "deals": [ … ],
    "ticketRedemptionCards": [ … ],
    "expiresAt": "2019-08-24T14:15:22Z",
    "siteId": "string",
    "hasCustomer": true,
    "amountSaved": { … },
    "tip": { … },
    "parentOrderId": "string",
    "siteOrderLocationId": "string"
  },
  "relatedData": {
    "films": [ … ],
    "ticketTypes": [ … ],
    "items": [ … ],
    "showtimes": [ … ],
    "sites": [ … ],
    "screens": [ … ],
    "censorRatings": [ … ],
    "itemServiceAreas": [ … ],
    "itemShowtimeDeliveryWindows": [ … ],
    "subscriptionBillingOption": { … },
    "subscription": { … },
    "balanceType": { … },
    "areaCategories": [ … ],
    "itemPostalDeliveryMethods": [ … ]
  }
}

Gets the current list of showtime availability entities

Request

Licenses Required

Vista.Ocapi

Query

siteIdsArray of stringsunique

Site filter

filmIdsArray of strings

Film filter

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/availability?siteIds=string&filmIds=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

showtimeAvailabilitiesArray of objects(ShowtimeAvailability)required

showtimeAvailabilities[].showtimeIdstringnon-emptyread-onlyrequired

showtimeAvailabilities[].isSoldOutbooleanrequired

showtimeAvailabilities[].seatSummaryAreaCategorySeatAvailabilitySummary (object) or SeatAvailabilitySummary (object)required

Represents a seat availability summary for a list of seat entities

One of:

Represents a seat availability summary for an area category

showtimeAvailabilities[].seatSummary.areaCategoryIdstringnon-emptyrequired

showtimeAvailabilities[].seatSummary.totalCountinteger(int32)required

showtimeAvailabilities[].seatSummary.availableCountinteger(int32)required

showtimeAvailabilities[].areaCategorySeatSummariesArray of objects(AreaCategorySeatAvailabilitySummary)required

showtimeAvailabilities[].areaCategorySeatSummaries[].areaCategoryIdstringnon-emptyrequired

showtimeAvailabilities[].areaCategorySeatSummaries[].totalCountinteger(int32)required

showtimeAvailabilities[].areaCategorySeatSummaries[].availableCountinteger(int32)required

Response

application/json

{
  "showtimeAvailabilities": [
    { … }
  ]
}

Gets the current showtime availability of a particular showtime

Request

Licenses Required

Vista.Ocapi

Path

showtimeIdstringrequired

The unique identifier of the showtime

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/{showtimeId}/availability' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

showtimeAvailabilityobject(ShowtimeAvailability)required

Represents the current availability of a showtime

showtimeAvailability.showtimeIdstringnon-emptyread-onlyrequired

showtimeAvailability.isSoldOutbooleanrequired

showtimeAvailability.seatSummaryAreaCategorySeatAvailabilitySummary (object) or SeatAvailabilitySummary (object)required

Represents a seat availability summary for a list of seat entities

One of:

Represents a seat availability summary for an area category

showtimeAvailability.seatSummary.areaCategoryIdstringnon-emptyrequired

showtimeAvailability.seatSummary.totalCountinteger(int32)required

showtimeAvailability.seatSummary.availableCountinteger(int32)required

showtimeAvailability.areaCategorySeatSummariesArray of objects(AreaCategorySeatAvailabilitySummary)required

showtimeAvailability.areaCategorySeatSummaries[].areaCategoryIdstringnon-emptyrequired

showtimeAvailability.areaCategorySeatSummaries[].totalCountinteger(int32)required

showtimeAvailability.areaCategorySeatSummaries[].availableCountinteger(int32)required

Response

application/json

{
  "showtimeAvailability": {
    "showtimeId": "string",
    "isSoldOut": true,
    "seatSummary": { … },
    "areaCategorySeatSummaries": [ … ]
  }
}

Gets a list of showtime entities for the first business date with showtimes

Request

Useful when filtering by site or film where showtimes may only be in the future.

Licenses Required

Vista.Ocapi

Query

siteIdsArray of stringsunique

Site filter

filmIdsArray of strings

Film filter

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/by-business-date/first?siteIds=string&filmIds=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

showtimesArray of objects(Showtime)required

Gets the list of showtime entities

showtimes[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

showtimes[].scheduleobject(ShowtimeSchedule)required

Gets the timing schedule

showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

showtimes[].isSoldOutbooleanrequired

Gets a value indicating whether the showtime is currently sold out

showtimes[].seatLayoutIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the seat layout of the screen

showtimes[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film that is being screened

showtimes[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site that is screening the film

showtimes[].screenIdstringnon-emptyrequired

Gets the unique identifier of the screen that the film will be played on

showtimes[].areaCategoriesArray of objects(ShowtimeAreaCategory)required

Gets the list of showtime area category entities

showtimes[].areaCategories[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category entity

showtimes[].areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].attributeIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned attribute entities

showtimes[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].requires3dGlassesbooleanrequired

Gets a value indicating whether this showtime requires 3D glasses to be viewed

showtimes[].eventIdstring or null

Gets the unique identifier of the event the showtime is assigned to, if applicable

showtimes[].restrictionsArray of strings(ShowtimeRestriction)required

Gets the list of restrictions that apply

Items Value"FilmAdvanceBookingRule"

showtimes[].filmAdvanceBookingRuleIdstring or null

Gets the unique identifier of the film advance booking rule that the showtime is restricted to

relatedDataobject(ShowtimeListRelatedData)required

Gets the related data for the showtime entities

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.filmsArray of objects(Film)required

Gets the list of related film entities

relatedData.films[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.films[].titleobject(Translatable)required

Gets the title text, and its translations

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.films[].synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

relatedData.films[].shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

relatedData.films[].censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

relatedData.films[].censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

relatedData.films[].releaseDatestring(date-time)required

Gets the release date of the film

relatedData.films[].runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

relatedData.films[].trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

relatedData.films[].trailers[].providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"

relatedData.films[].trailers[].uristring(uri)required

Gets the address used for retrieving the trailer

relatedData.films[].trailerUrlstring or null(uri)

Gets the trailer video URL

relatedData.films[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.films[].castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required

relatedData.films[].castAndCrew[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].castAndCrew[].rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"

relatedData.films[].actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].actors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].directors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].producers[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

relatedData.films[].externalIdsobject(FilmExternalIds)required

Gets the external identifiers

relatedData.films[].externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].hopkstring or null

Gets the Head Office primary key

relatedData.films[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.films[].eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

relatedData.films[].distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedData.castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.castAndCrew[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.castAndCrew[].nameobject(PersonName)required

Gets the person's name

relatedData.castAndCrew[].name.givenNamestring or null

Gets the given name

relatedData.castAndCrew[].name.familyNamestring or null

Gets the family name

relatedData.castAndCrew[].name.middleNamestring or null

Gets the middle or any additional name

relatedData.genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.genres[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.genres[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.genres[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.genres[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.genres[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.genres[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.genres[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.attributes[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.attributes[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.attributes[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.attributes[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.attributes[].importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.attributes[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.attributes[].isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screens[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.eventsArray of objects(Event)required

Gets the list of related event entities

relatedData.events[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.events[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.events[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.events[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.events[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.events[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.events[].shortNameobject(Translatable)

Gets the short name text, and its translations

relatedData.events[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.events[].scheduleobject(EventSchedule)required

Gets the schedule

relatedData.events[].schedule.startDatestring or null(date-time)

Gets the start date, if applicable

relatedData.events[].schedule.endDatestring or null(date-time)

Gets the end date, if applicable

relatedData.events[].siteIdsArray of stringsrequired

Gets the list of unique identifiers of the site entities screening the event

relatedData.filmAdvanceBookingRulesArray of objects(FilmAdvanceBookingRule)required

Gets the list of related film advance booking rule entities

relatedData.filmAdvanceBookingRules[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.filmAdvanceBookingRules[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film

relatedData.filmAdvanceBookingRules[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

relatedData.filmAdvanceBookingRules[].bookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

relatedData.filmAdvanceBookingRules[].bookingPeriods[].startsAtstring(date-time)required

Gets the date and time that the booking period starts

relatedData.filmAdvanceBookingRules[].bookingPeriods[].orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

businessDatestring(date-time)required

Gets the business date of the showtime entities

Response

application/json

{
  "showtimes": [
    { … }
  ],
  "relatedData": {
    "sites": [ … ],
    "films": [ … ],
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRatings": [ … ],
    "attributes": [ … ],
    "screens": [ … ],
    "events": [ … ],
    "filmAdvanceBookingRules": [ … ],
    "areaCategories": [ … ]
  },
  "businessDate": "2019-08-24T14:15:22Z"
}

Gets a list of showtime entities for a business date

Request

Returns an empty list of showtime entities if no showtimes are scheduled.

Licenses Required

Vista.Ocapi

Path

businessDatestring(date-time)required

Date of requested showtimes in 'yyyy-MM-dd' format

Query

siteIdsArray of stringsunique

Site filter

filmIdsArray of strings

Film filter

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/by-business-date/{businessDate}?siteIds=string&filmIds=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

showtimesArray of objects(Showtime)required

Gets the list of showtime entities

showtimes[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

showtimes[].scheduleobject(ShowtimeSchedule)required

Gets the timing schedule

showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

showtimes[].isSoldOutbooleanrequired

Gets a value indicating whether the showtime is currently sold out

showtimes[].seatLayoutIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the seat layout of the screen

showtimes[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film that is being screened

showtimes[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site that is screening the film

showtimes[].screenIdstringnon-emptyrequired

Gets the unique identifier of the screen that the film will be played on

showtimes[].areaCategoriesArray of objects(ShowtimeAreaCategory)required

Gets the list of showtime area category entities

showtimes[].areaCategories[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category entity

showtimes[].areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].attributeIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned attribute entities

showtimes[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].requires3dGlassesbooleanrequired

Gets a value indicating whether this showtime requires 3D glasses to be viewed

showtimes[].eventIdstring or null

Gets the unique identifier of the event the showtime is assigned to, if applicable

showtimes[].restrictionsArray of strings(ShowtimeRestriction)required

Gets the list of restrictions that apply

Items Value"FilmAdvanceBookingRule"

showtimes[].filmAdvanceBookingRuleIdstring or null

Gets the unique identifier of the film advance booking rule that the showtime is restricted to

relatedDataobject(ShowtimeListRelatedData)required

Gets the related data for the showtime entities

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.filmsArray of objects(Film)required

Gets the list of related film entities

relatedData.films[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.films[].titleobject(Translatable)required

Gets the title text, and its translations

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.films[].synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

relatedData.films[].shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

relatedData.films[].censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

relatedData.films[].censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

relatedData.films[].releaseDatestring(date-time)required

Gets the release date of the film

relatedData.films[].runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

relatedData.films[].trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

relatedData.films[].trailers[].providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"

relatedData.films[].trailers[].uristring(uri)required

Gets the address used for retrieving the trailer

relatedData.films[].trailerUrlstring or null(uri)

Gets the trailer video URL

relatedData.films[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.films[].castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required

relatedData.films[].castAndCrew[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].castAndCrew[].rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"

relatedData.films[].actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].actors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].directors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].producers[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

relatedData.films[].externalIdsobject(FilmExternalIds)required

Gets the external identifiers

relatedData.films[].externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].hopkstring or null

Gets the Head Office primary key

relatedData.films[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.films[].eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

relatedData.films[].distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedData.castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.castAndCrew[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.castAndCrew[].nameobject(PersonName)required

Gets the person's name

relatedData.castAndCrew[].name.givenNamestring or null

Gets the given name

relatedData.castAndCrew[].name.familyNamestring or null

Gets the family name

relatedData.castAndCrew[].name.middleNamestring or null

Gets the middle or any additional name

relatedData.genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.genres[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.genres[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.genres[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.genres[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.genres[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.genres[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.genres[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.attributes[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.attributes[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.attributes[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.attributes[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.attributes[].importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.attributes[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.attributes[].isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screens[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.eventsArray of objects(Event)required

Gets the list of related event entities

relatedData.events[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.events[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.events[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.events[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.events[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.events[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.events[].shortNameobject(Translatable)

Gets the short name text, and its translations

relatedData.events[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.events[].scheduleobject(EventSchedule)required

Gets the schedule

relatedData.events[].schedule.startDatestring or null(date-time)

Gets the start date, if applicable

relatedData.events[].schedule.endDatestring or null(date-time)

Gets the end date, if applicable

relatedData.events[].siteIdsArray of stringsrequired

Gets the list of unique identifiers of the site entities screening the event

relatedData.filmAdvanceBookingRulesArray of objects(FilmAdvanceBookingRule)required

Gets the list of related film advance booking rule entities

relatedData.filmAdvanceBookingRules[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.filmAdvanceBookingRules[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film

relatedData.filmAdvanceBookingRules[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

relatedData.filmAdvanceBookingRules[].bookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

relatedData.filmAdvanceBookingRules[].bookingPeriods[].startsAtstring(date-time)required

Gets the date and time that the booking period starts

relatedData.filmAdvanceBookingRules[].bookingPeriods[].orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

businessDatestring(date-time)required

Gets the business date of the showtime entities

Response

application/json

{
  "showtimes": [
    { … }
  ],
  "relatedData": {
    "sites": [ … ],
    "films": [ … ],
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRatings": [ … ],
    "attributes": [ … ],
    "screens": [ … ],
    "events": [ … ],
    "filmAdvanceBookingRules": [ … ],
    "areaCategories": [ … ]
  },
  "businessDate": "2019-08-24T14:15:22Z"
}

Gets a list of showtime entities for today and tomorrow for a screen

Request

This endpoint is currently used to find an in-progress or imminent showtime given a screen ID, which can then be used as the showtime context for an in-seat delivery order.

showtime entities for the 48 hours from the beginning (i.e. 00:00) of today's calendar date up to the end of the next calendar day are returned. This is to cater for the scenario where this endpoint is called close to the end of the day, such that the next day's showtimes are needed as well.

showtime entities that started on the previous calendar date, but finish on today's calendar date are included.

showtime entities that do not support or are not yet available for in-seat delivery are still included so that this can be communicated to patrons.

Unlike endpoints based on business date, the cutoff for each calendar day is always midnight.

Licenses Required

Vista.Ocapi

Path

screenIdstringrequired

The unique identifier of the screen

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/by-screen/{screenId}' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

One of:

Represents a list of showtime entities for a particular business day, and their related data

showtimesArray of objects(Showtime)required

Gets the list of showtime entities

showtimes[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

showtimes[].scheduleobject(ShowtimeSchedule)required

Gets the timing schedule

showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

showtimes[].isSoldOutbooleanrequired

Gets a value indicating whether the showtime is currently sold out

showtimes[].seatLayoutIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the seat layout of the screen

showtimes[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film that is being screened

showtimes[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site that is screening the film

showtimes[].screenIdstringnon-emptyrequired

Gets the unique identifier of the screen that the film will be played on

showtimes[].areaCategoriesArray of objects(ShowtimeAreaCategory)required

Gets the list of showtime area category entities

showtimes[].areaCategories[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category entity

showtimes[].areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].attributeIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned attribute entities

showtimes[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtimes[].requires3dGlassesbooleanrequired

Gets a value indicating whether this showtime requires 3D glasses to be viewed

showtimes[].eventIdstring or null

Gets the unique identifier of the event the showtime is assigned to, if applicable

showtimes[].restrictionsArray of strings(ShowtimeRestriction)required

Gets the list of restrictions that apply

Items Value"FilmAdvanceBookingRule"

showtimes[].filmAdvanceBookingRuleIdstring or null

Gets the unique identifier of the film advance booking rule that the showtime is restricted to

relatedDataobject(ShowtimeListRelatedData)required

Gets the related data for the showtime entities

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.filmsArray of objects(Film)required

Gets the list of related film entities

relatedData.films[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.films[].titleobject(Translatable)required

Gets the title text, and its translations

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.films[].synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

relatedData.films[].shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

relatedData.films[].censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

relatedData.films[].censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

relatedData.films[].releaseDatestring(date-time)required

Gets the release date of the film

relatedData.films[].runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

relatedData.films[].trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

relatedData.films[].trailers[].providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"

relatedData.films[].trailers[].uristring(uri)required

Gets the address used for retrieving the trailer

relatedData.films[].trailerUrlstring or null(uri)

Gets the trailer video URL

relatedData.films[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.films[].castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required

relatedData.films[].castAndCrew[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].castAndCrew[].rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"

relatedData.films[].actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].actors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].directors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.films[].producers[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.films[].genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

relatedData.films[].externalIdsobject(FilmExternalIds)required

Gets the external identifiers

relatedData.films[].externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].hopkstring or null

Gets the Head Office primary key

relatedData.films[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.films[].eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

relatedData.films[].distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedData.castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.castAndCrew[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.castAndCrew[].nameobject(PersonName)required

Gets the person's name

relatedData.castAndCrew[].name.givenNamestring or null

Gets the given name

relatedData.castAndCrew[].name.familyNamestring or null

Gets the family name

relatedData.castAndCrew[].name.middleNamestring or null

Gets the middle or any additional name

relatedData.genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.genres[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.genres[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.genres[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.genres[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.genres[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.genres[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.genres[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.attributes[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.attributes[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.attributes[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.attributes[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.attributes[].importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.attributes[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.attributes[].isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screens[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.eventsArray of objects(Event)required

Gets the list of related event entities

relatedData.events[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.events[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.events[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.events[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.events[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.events[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.events[].shortNameobject(Translatable)

Gets the short name text, and its translations

relatedData.events[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.events[].scheduleobject(EventSchedule)required

Gets the schedule

relatedData.events[].schedule.startDatestring or null(date-time)

Gets the start date, if applicable

relatedData.events[].schedule.endDatestring or null(date-time)

Gets the end date, if applicable

relatedData.events[].siteIdsArray of stringsrequired

Gets the list of unique identifiers of the site entities screening the event

relatedData.filmAdvanceBookingRulesArray of objects(FilmAdvanceBookingRule)required

Gets the list of related film advance booking rule entities

relatedData.filmAdvanceBookingRules[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.filmAdvanceBookingRules[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film

relatedData.filmAdvanceBookingRules[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

relatedData.filmAdvanceBookingRules[].bookingPeriodsArray of objects(FilmAdvanceBookingPeriod)required

Gets the list of film advance booking period entities

relatedData.filmAdvanceBookingRules[].bookingPeriods[].startsAtstring(date-time)required

Gets the date and time that the booking period starts

relatedData.filmAdvanceBookingRules[].bookingPeriods[].orderBookingModesArray of strings(OrderBookingMode)required

Gets the order booking modes that the booking period applies to

Items Enum"Paid""Unpaid""UnpaidConfirmed"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].restrictionstring(FilmAdvanceBookingPeriodRestriction)required

Gets the restriction

Enum"None""MemberReward"

relatedData.filmAdvanceBookingRules[].bookingPeriods[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward that the booking period is restricted to

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

businessDatestring(date-time)required

Gets the business date of the showtime entities

Response

application/json

{
  "showtimes": [
    { … }
  ],
  "relatedData": {
    "sites": [ … ],
    "films": [ … ],
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRatings": [ … ],
    "attributes": [ … ],
    "screens": [ … ],
    "events": [ … ],
    "filmAdvanceBookingRules": [ … ],
    "areaCategories": [ … ]
  },
  "businessDate": "2019-08-24T14:15:22Z"
}

Gets a showtime by its unique identifier

Request

Licenses Required

Vista.Ocapi

Path

showtimeIdstringrequired

The unique identifier of the showtime

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/{showtimeId}' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

showtimeobject(Showtime)required

Gets the showtime entity

showtime.idstringnon-emptyread-onlyrequired

Gets the unique identifier

showtime.scheduleobject(ShowtimeSchedule)required

Gets the timing schedule

showtime.schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

showtime.schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

showtime.schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

showtime.schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

showtime.schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

showtime.schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

showtime.isSoldOutbooleanrequired

Gets a value indicating whether the showtime is currently sold out

showtime.seatLayoutIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the seat layout of the screen

showtime.filmIdstringnon-emptyrequired

Gets the unique identifier of the film that is being screened

showtime.siteIdstringnon-emptyrequired

Gets the unique identifier of the site that is screening the film

showtime.screenIdstringnon-emptyrequired

Gets the unique identifier of the screen that the film will be played on

showtime.areaCategoriesArray of objects(ShowtimeAreaCategory)required

Gets the list of showtime area category entities

showtime.areaCategories[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category entity

showtime.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtime.attributeIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned attribute entities

showtime.isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

showtime.requires3dGlassesbooleanrequired

Gets a value indicating whether this showtime requires 3D glasses to be viewed

showtime.eventIdstring or null

Gets the unique identifier of the event the showtime is assigned to, if applicable

showtime.restrictionsArray of strings(ShowtimeRestriction)required

Gets the list of restrictions that apply

Items Value"FilmAdvanceBookingRule"

showtime.filmAdvanceBookingRuleIdstring or null

Gets the unique identifier of the film advance booking rule that the showtime is restricted to

relatedDataobject(ShowtimeRelatedData)required

Gets the related data for the showtime entity

relatedData.siteLoyaltySite (object) or Site (object)required

Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities

One of:

Represents a site in Vista Loyalty

relatedData.site.locationobject(GeographicLocation)

Gets the geographic location

relatedData.site.contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.site.contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.site.contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.site.contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.site.contactDetails.emailstring or null

Gets the email address

relatedData.site.contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.site.ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.site.idstringnon-emptyrequired

Gets the unique identifier

relatedData.site.nameobject(Translatable)required

Gets the name text, and its translations

relatedData.site.name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.site.name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.site.name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.site.name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.site.hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.site.allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.filmobject(Film)required

Gets the related film entity

relatedData.film.idstringnon-emptyrequired

Gets the unique identifier

relatedData.film.titleobject(Translatable)required

Gets the title text, and its translations

relatedData.film.title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.film.title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.film.title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.film.title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.film.synopsisobject(Translatable)

Gets the plot/synopsis text, and its translations

relatedData.film.shortSynopsisobject(Translatable)

Gets the short plot/synopsis text, and its translations

relatedData.film.censorRatingIdstring or null

Gets the unique identifier of the censor rating, if applicable

relatedData.film.censorRatingNoteobject(Translatable)

Gets a description of the content in the film that qualifies it for its censor rating, if applicable

relatedData.film.releaseDatestring(date-time)required

Gets the release date of the film

relatedData.film.runtimeInMinutesinteger(int32)required

Gets the runtime duration in minutes

relatedData.film.trailersArray of objects(FilmTrailer)required

Gets the list of film trailer entities

relatedData.film.trailers[].providerstring(FilmTrailerProvider)required

Gets the provider

Enum"Moviexchange""External"

relatedData.film.trailers[].uristring(uri)required

Gets the address used for retrieving the trailer

relatedData.film.trailerUrlstring or null(uri)

Gets the trailer video URL

relatedData.film.displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.film.castAndCrewArray of objects(FilmCastAndCrewMemberWithRoles)required

relatedData.film.castAndCrew[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.castAndCrew[].rolesArray of strings(CastAndCrewMemberRole)required

Gets the list of roles

Items Enum"Actor""Director""Producer"

relatedData.film.actorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that acted in the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.film.actors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.directorsArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that directed the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.film.directors[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.producersArray of FilmCastAndCrewMember (object) or FilmCastAndCrewMemberWithRoles (object)required

Gets the list of film cast and crew member entities that produced the film, sorted by billing order

One of:

Represents a cast and crew member in the context of a particular film

relatedData.film.producers[].castAndCrewMemberIdstringnon-emptyrequired

Gets the unique identifier of the cast and crew member

relatedData.film.genreIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned genre entities

relatedData.film.externalIdsobject(FilmExternalIds)required

Gets the external identifiers

relatedData.film.externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.film.externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.film.hopkstring or null

Gets the Head Office primary key

relatedData.film.hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.film.eventIdstring or null

Gets the unique identifier of the event the film is assigned to, if applicable

relatedData.film.distributorNamestringnon-emptyrequired

Gets the name of the distributor

relatedData.screenobject(Screen)required

Gets the related screen entity

relatedData.screen.idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screen.nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screen.name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.screen.name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.screen.name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.screen.name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.castAndCrewArray of objects(CastAndCrewMember)required

Gets the list of related cast and crew member entities

relatedData.castAndCrew[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.castAndCrew[].nameobject(PersonName)required

Gets the person's name

relatedData.castAndCrew[].name.givenNamestring or null

Gets the given name

relatedData.castAndCrew[].name.familyNamestring or null

Gets the family name

relatedData.castAndCrew[].name.middleNamestring or null

Gets the middle or any additional name

relatedData.genresArray of objects(Genre)required

Gets the list of related genre entities

relatedData.genres[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.genres[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.genres[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.genres[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.genres[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.genres[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.genres[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.censorRatingobject(CensorRating)

Gets the related censor rating, if applicable

relatedData.attributesArray of objects(Attribute)required

Gets the list of related attribute entities

relatedData.attributes[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.attributes[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.attributes[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.attributes[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.attributes[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.attributes[].shortName.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.attributes[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.attributes[].descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.attributes[].importantMessageobject(Translatable)

Gets the important message text, and its translations

relatedData.attributes[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

relatedData.attributes[].isPromotedbooleanrequired

Gets a value indicating whether the attribute should be displayed with prominence

relatedData.eventobject(Event)

Gets the related event, if applicable

relatedData.filmAdvanceBookingRuleobject(FilmAdvanceBookingRule)

Gets the related film advance booking rule, if applicable

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.areaCategories[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

Response

application/json

{
  "showtime": {
    "id": "string",
    "schedule": { … },
    "isSoldOut": true,
    "seatLayoutId": "string",
    "filmId": "string",
    "siteId": "string",
    "screenId": "string",
    "areaCategories": [ … ],
    "attributeIds": [ … ],
    "isAllocatedSeating": true,
    "requires3dGlasses": true,
    "eventId": "string",
    "restrictions": [ … ],
    "filmAdvanceBookingRuleId": "string"
  },
  "relatedData": {
    "site": { … },
    "film": { … },
    "screen": { … },
    "castAndCrew": [ … ],
    "genres": [ … ],
    "censorRating": { … },
    "attributes": [ … ],
    "event": { … },
    "filmAdvanceBookingRule": { … },
    "areaCategories": [ … ]
  }
}

Films

Operations

Gift Cards

Operations

Items

Operations

Journeys

Operations

Third Party Passes

Operations

Loyalty

Operations

Authentication

Operations

Members

Operations

Member Completed Orders

Operations

Friends

Operations

Password Reset

Operations

Payments

Operations

Member Rewards

Operations

Subscriptions

Operations

Ticket Redemption Cards

Operations

Credentials

Operations

Watched Films

Operations

Watchlist Films

Operations

Completion

Operations

Gift shop

Operations

Vouchers

Operations

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations

Vista Digital Platform (V1)

Completed Order Assets

Completed Orders

Orders

Seats

Discounts

Events

Showtimes

Gets a list of showtime entities for an event

Request

Licenses Required

Responses

Gets a list of showtime entities for a film

Request

Licenses Required

Responses

Sets the requested tickets and/or seats for an order showtime within an in progress standard order

RequestExpand all

Specifying Tickets without Seats (Ticket-first Ordering)

Specifying Seats (Ticket-first and seat-first Ordering)

Auto-Allocation

Licenses Required

Responses

Gets the current list of showtime availability entities

Request

Licenses Required

Responses

Gets the current showtime availability of a particular showtime

Request

Licenses Required

Responses

Gets a list of showtime entities for the first business date with showtimes

Request

Licenses Required

Responses

Gets a list of showtime entities for a business date

Request

Licenses Required

Responses

Gets a list of showtime entities for today and tomorrow for a screen

Request

Licenses Required

Responses

Gets a showtime by its unique identifier

Request

Licenses Required

Responses

Films

Gift Cards

Items

Journeys

Third Party Passes

Loyalty

Authentication

Members

Member Completed Orders

Friends

Password Reset

Payments

Member Rewards

Subscriptions

Ticket Redemption Cards

Credentials

Watched Films

Watchlist Films

Completion

Gift shop

Vouchers

Refunds

Seating

Browsing

Sites

Surveys

Third-Party Member Schemes

Ticket Prices

Tracking Events

Tips

Request