Gets the seat availability for a showtime

Completed Order Assets

Operations

Completed Orders

Operations

Orders

Operations

Seats

Operations

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

Gets the seat availability for a showtime

Request

The response is output cached for a maximum duration depending on preview.

If the underlying showtime is unallocated, showtime seat availability SeatAvailabilities will be set to an empty seat availability[]

Bad request response

Seat availability for showtime response returns 400 status when seat allocation for the showtime is disabled. When there are seats for a showtime that are sold out or the showtime is marked as sold out at Cinema, seat availability for showtime returns a 200 response with sold status for all seats.

Licenses Required

Vista.Ocapi

Path

showtimeIdstringrequired

The unique identifier of the showtime

Query

previewboolean

Indicates whether the seat availability is being shown in a preview context, i.e. can be slightly outdated

Default false

Headers

Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json

seatAvailabilitiesArray of objects(SeatAvailability)required

seatAvailabilities[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

seatAvailabilities[].statusstring(SeatAvailabilityStatus)required

Gets the availability status

Enum"Available""Sold""Broken""House"

isSoldOutbooleanrequired

summaryAreaCategorySeatAvailabilitySummary (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

summary.areaCategoryIdstringnon-emptyrequired

summary.totalCountinteger(int32)required

summary.availableCountinteger(int32)required

areaCategorySummariesArray of objects(AreaCategorySeatAvailabilitySummary)required

areaCategorySummaries[].areaCategoryIdstringnon-emptyrequired

areaCategorySummaries[].totalCountinteger(int32)required

areaCategorySummaries[].availableCountinteger(int32)required

Response

application/json

{
  "seatAvailabilities": [
    { … }
  ],
  "isSoldOut": true,
  "summary": {
    "areaCategoryId": "string",
    "totalCount": 0,
    "availableCount": 0
  },
  "areaCategorySummaries": [
    { … }
  ]
}

Gets the seat availability for a showtime in the context of a standard order

Request

Using this endpoint over GetSeatAvailabilityForShowtime enables order-specific seat availability information and the pre-blocking of social distance seats.

If the underlying showtime is unallocated, showtime seat availability SeatAvailabilities will be set to an empty seat availability[]

This endpoint cannot be used for orders that do not support ticket selection.

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the standard order

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/orders/{orderId}/showtimes/{showtimeId}/seat-availability' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

seatAvailabilitiesArray of objects(SeatAvailability)required

seatAvailabilities[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

seatAvailabilities[].statusstring(SeatAvailabilityStatus)required

Gets the availability status

Enum"Available""Sold""Broken""House"

isSoldOutbooleanrequired

summaryAreaCategorySeatAvailabilitySummary (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

summary.areaCategoryIdstringnon-emptyrequired

summary.totalCountinteger(int32)required

summary.availableCountinteger(int32)required

areaCategorySummariesArray of objects(AreaCategorySeatAvailabilitySummary)required

areaCategorySummaries[].areaCategoryIdstringnon-emptyrequired

areaCategorySummaries[].totalCountinteger(int32)required

areaCategorySummaries[].availableCountinteger(int32)required

Response

application/json

{
  "seatAvailabilities": [
    { … }
  ],
  "isSoldOut": true,
  "summary": {
    "areaCategoryId": "string",
    "totalCount": 0,
    "availableCount": 0
  },
  "areaCategorySummaries": [
    { … }
  ]
}

Gets a seat layout by its unique identifier

Request

Licenses Required

Vista.Ocapi

Path

seatLayoutIdstringrequired

The unique identifier of the seat layout

Headers

Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json

seatLayoutobject(SeatLayout)required

Gets the seat layout entity

seatLayout.idstringnon-emptyread-onlyrequired

Gets the unique identifier

seatLayout.screenIdstringnon-emptyrequired

Gets the unique identifier of the screen

seatLayout.boundaryobject(SeatLayoutBoundary)required

Gets the boundary

seatLayout.boundary.rightnumber(double)required

Gets the rightmost coordinate, in grid units

seatLayout.boundary.leftnumber(double)required

Gets the leftmost coordinate, in grid units

seatLayout.boundary.topnumber(double)required

Gets the topmost coordinate, in grid units

seatLayout.screenBoundaryobject(ScreenBoundary)required

Gets the screen boundary

seatLayout.screenBoundary.leftnumber(double)required

Gets the leftmost coordinate, in grid units

seatLayout.screenBoundary.rightnumber(double)required

Gets the rightmost coordinate, in grid units

seatLayout.areasArray of objects(Area)required

Gets the list area entities

seatLayout.areas[].numberinteger(int32)required

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

seatLayout.areas[].areaCategoryIdstringnon-emptyrequired

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

seatLayout.areas[].nameobject(Translatable)required

Gets the name text, and its translations

seatLayout.areas[].name.textstringnon-emptyrequired

Gets the text in the default language

seatLayout.areas[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

seatLayout.areas[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

seatLayout.areas[].name.translations[].textstringnon-emptyrequired

Gets the translated text

seatLayout.areas[].boundaryobject(AreaBoundary)required

Gets the boundary

seatLayout.areas[].boundary.leftnumber(double)required

Gets the leftmost coordinate, in grid units

seatLayout.areas[].boundary.topnumber(double)required

Gets the topmost coordinate, in grid units

seatLayout.areas[].boundary.rightnumber(double)required

Gets the rightmost coordinate, in grid units

seatLayout.areas[].boundary.bottomnumber(double)required

Gets the bottommost coordinate, in grid units

seatLayout.areas[].columnCountinteger(int32)required

Gets the number of columns

seatLayout.areas[].rowCountinteger(int32)required

Gets the number of rows

seatLayout.areas[].rowsArray of objects(Row)required

Gets the list of row entities

seatLayout.areas[].rows[].numberinteger(int32)required

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

seatLayout.areas[].rows[].labelstringnon-emptyrequired

Gets the label/physical name

Example: "G"

seatLayout.areas[].rows[].seatsArray of objects(Seat)required

Gets the list of seat entities

seatLayout.areas[].rows[].seats[].idstringnon-emptyrequired

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

seatLayout.areas[].rows[].seats[].positionobject(SeatPosition)required

Gets the position

seatLayout.areas[].rows[].seats[].seatGroupIdsArray of stringsrequired

Gets the list of unique identifiers of the seat entities that share the same group

seatLayout.areas[].rows[].seats[].labelstring or null

Gets the label/physical name of the seat

Example: "5"

seatLayout.areas[].rows[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

Example: "G"

seatLayout.areas[].rows[].seats[].areaCategoryIdstringnon-emptyrequired

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

seatLayout.areas[].rows[].seats[].typestring(SeatType)required

Gets the type

Enum"Normal""Wheelchair""Companion""SofaLeft""SofaMiddle""SofaRight"

relatedDataobject(SeatLayoutRelatedData)required

Gets the related data for the seat layout entity

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.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

{
  "seatLayout": {
    "id": "string",
    "screenId": "string",
    "boundary": { … },
    "screenBoundary": { … },
    "areas": [ … ]
  },
  "relatedData": {
    "screen": { … },
    "areaCategories": [ … ]
  }
}

Gets the seat layout for a showtime
Deprecated

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}/seat-layout' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

seatLayoutobject(SeatLayout)required

Gets the seat layout entity

seatLayout.idstringnon-emptyread-onlyrequired

Gets the unique identifier

seatLayout.screenIdstringnon-emptyrequired

Gets the unique identifier of the screen

seatLayout.boundaryobject(SeatLayoutBoundary)required

Gets the boundary

seatLayout.boundary.rightnumber(double)required

Gets the rightmost coordinate, in grid units

seatLayout.boundary.leftnumber(double)required

Gets the leftmost coordinate, in grid units

seatLayout.boundary.topnumber(double)required

Gets the topmost coordinate, in grid units

seatLayout.screenBoundaryobject(ScreenBoundary)required

Gets the screen boundary

seatLayout.screenBoundary.leftnumber(double)required

Gets the leftmost coordinate, in grid units

seatLayout.screenBoundary.rightnumber(double)required

Gets the rightmost coordinate, in grid units

seatLayout.areasArray of objects(Area)required

Gets the list area entities

seatLayout.areas[].numberinteger(int32)required

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

seatLayout.areas[].areaCategoryIdstringnon-emptyrequired

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

seatLayout.areas[].nameobject(Translatable)required

Gets the name text, and its translations

seatLayout.areas[].name.textstringnon-emptyrequired

Gets the text in the default language

seatLayout.areas[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

seatLayout.areas[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

seatLayout.areas[].name.translations[].textstringnon-emptyrequired

Gets the translated text

seatLayout.areas[].boundaryobject(AreaBoundary)required

Gets the boundary

seatLayout.areas[].boundary.leftnumber(double)required

Gets the leftmost coordinate, in grid units

seatLayout.areas[].boundary.topnumber(double)required

Gets the topmost coordinate, in grid units

seatLayout.areas[].boundary.rightnumber(double)required

Gets the rightmost coordinate, in grid units

seatLayout.areas[].boundary.bottomnumber(double)required

Gets the bottommost coordinate, in grid units

seatLayout.areas[].columnCountinteger(int32)required

Gets the number of columns

seatLayout.areas[].rowCountinteger(int32)required

Gets the number of rows

seatLayout.areas[].rowsArray of objects(Row)required

Gets the list of row entities

seatLayout.areas[].rows[].numberinteger(int32)required

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

seatLayout.areas[].rows[].labelstringnon-emptyrequired

Gets the label/physical name

Example: "G"

seatLayout.areas[].rows[].seatsArray of objects(Seat)required

Gets the list of seat entities

seatLayout.areas[].rows[].seats[].idstringnon-emptyrequired

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

seatLayout.areas[].rows[].seats[].positionobject(SeatPosition)required

Gets the position

seatLayout.areas[].rows[].seats[].seatGroupIdsArray of stringsrequired

Gets the list of unique identifiers of the seat entities that share the same group

seatLayout.areas[].rows[].seats[].labelstring or null

Gets the label/physical name of the seat

Example: "5"

seatLayout.areas[].rows[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

Example: "G"

seatLayout.areas[].rows[].seats[].areaCategoryIdstringnon-emptyrequired

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

seatLayout.areas[].rows[].seats[].typestring(SeatType)required

Gets the type

Enum"Normal""Wheelchair""Companion""SofaLeft""SofaMiddle""SofaRight"

relatedDataobject(SeatLayoutRelatedData)required

Gets the related data for the seat layout entity

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.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

{
  "seatLayout": {
    "id": "string",
    "screenId": "string",
    "boundary": { … },
    "screenBoundary": { … },
    "areas": [ … ]
  },
  "relatedData": {
    "screen": { … },
    "areaCategories": [ … ]
  }
}

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

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

Gets the seat availability for a showtime

Request

Bad request response

Licenses Required

Responses

Gets the seat availability for a showtime in the context of a standard order

Request

Licenses Required

Responses

Gets a seat layout by its unique identifier

Request

Licenses Required

Responses

Gets the seat layout for a showtimeDeprecated

Request

Licenses Required

Responses

Browsing

Sites

Surveys

Third-Party Member Schemes

Ticket Prices

Tracking Events

Tips

Gets the seat layout for a showtime
Deprecated