Seats

Completed Order Assets

Operations

Completed Orders

Operations

Orders

Operations

Seats

Operations

Gets the order showtime seats details for the provided barcode

Request

Can return seats for orders that were not made by Connect, e.g. POS.

Only seats for showtimes that are currently available for purchase will be returned.

Licenses Required

Vista.Ocapi

Path

siteIdstringrequired

The unique identifier of the site

barcodestringrequired

An ambiguous reference that can be used to identify a booking or a ticket in a completed order. WQ9LJTK (booking ID)B10000044294 (booking barcode)S100044294 (short booking barcode)B100000442940001 (booking ticket barcode)S1000442940001 (short booking ticket barcode)T10000041793 (transaction barcode)T100000417930001 (transaction ticket barcode)U100041793 (short transaction barcode)U1000417930001 (short transaction ticket barcode)

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

showtimeSeatsArray of objects(OrderShowtimeSeats)required

Gets the list of order showtime seats entities

showtimeSeats[].showtimeIdstringnon-emptyrequired

Gets the unique identifier of the showtime

showtimeSeats[].seatsArray of objects(OrderSeat)required

Gets the list of order seat entities

showtimeSeats[].seats[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

showtimeSeats[].seats[].seatLabelstring or null

Gets the label/physical name of the seat

Example: "5"

showtimeSeats[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

showtimeSeats[].seats[].areaNameobject(Translatable)required

Gets the area name text, and its translations

showtimeSeats[].seats[].areaName.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

showtimeSeats[].seats[].areaName.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

showtimeSeats[].seats[].areaName.translations[].textstringnon-emptyrequired

Gets the translated text

showtimeSeats[].seats[].areaCategoryIdstringnon-emptyrequired

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

showtimeSeats[].seats[].positionobject(SeatPosition)required

Gets the seat position

showtimeSeats[].seats[].position.areaNumberinteger(int32)required

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

showtimeSeats[].seats[].position.columnNumberinteger(int32)required

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

showtimeSeats[].seats[].position.rowNumberinteger(int32)required

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

relatedDataobject(OrderShowtimeSeatsRelatedData)required

Gets the related data for the order showtime seats

relatedData.showtimesArray of objects(Showtime)required

Gets the list of related showtime entities

relatedData.showtimes[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.showtimes[].scheduleobject(ShowtimeSchedule)required

Gets the timing schedule

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[].isSoldOutbooleanrequired

Gets a value indicating whether the showtime is currently sold out

relatedData.showtimes[].seatLayoutIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the seat layout of the screen

relatedData.showtimes[].filmIdstringnon-emptyrequired

Gets the unique identifier of the film that is being screened

relatedData.showtimes[].siteIdstringnon-emptyrequired

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

relatedData.showtimes[].screenIdstringnon-emptyrequired

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

relatedData.showtimes[].areaCategoriesArray of objects(ShowtimeAreaCategory)required

Gets the list of showtime area category entities

relatedData.showtimes[].areaCategories[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category entity

relatedData.showtimes[].areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.showtimes[].attributeIdsArray of stringsrequired

Gets the list of unique identifiers of the assigned attribute entities

relatedData.showtimes[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.showtimes[].requires3dGlassesbooleanrequired

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

relatedData.showtimes[].eventIdstring or null

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

relatedData.showtimes[].restrictionsArray of strings(ShowtimeRestriction)required

Gets the list of restrictions that apply

Items Value"FilmAdvanceBookingRule"

relatedData.showtimes[].filmAdvanceBookingRuleIdstring or null

Gets the unique identifier of the film advance booking rule that the showtime 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

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.censorRatingsArray of objects(CensorRating)required

Gets the 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.sitesArray of LoyaltySite (object) or Site (object)required

Gets the 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 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.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.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.filmAdvanceBookingRulesArray of objects(FilmAdvanceBookingRule)required

Gets the 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.eventsArray of objects(Event)required

Gets the 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

Response

application/json

{
  "showtimeSeats": [
    { … }
  ],
  "relatedData": {
    "showtimes": [ … ],
    "areaCategories": [ … ],
    "films": [ … ],
    "castAndCrew": [ … ],
    "censorRatings": [ … ],
    "sites": [ … ],
    "screens": [ … ],
    "genres": [ … ],
    "attributes": [ … ],
    "filmAdvanceBookingRules": [ … ],
    "events": [ … ]
  }
}

Discounts

Operations

Events

Operations

Showtimes

Operations

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

Gets the order showtime seats details for the provided barcode

Request

Licenses Required

Responses

Discounts

Events

Showtimes

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