Skip to content

Vista Digital Platform (V1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.vista.co/_mock/openapi/digital-platform/openapi

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

Browsing

Operations

Sites

Operations

Gets a detailed site list details including related data

Request

Licenses Required

  • Vista.Ocapi
Headers
Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json
sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of site entities

One of:

Represents a site in Vista Loyalty

sites[].​locationobject(GeographicLocation)

Gets the geographic location

sites[].​contactDetailsobject(SiteContactDetails)required

Gets the contact details

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

Gets the list of phone number entities

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

Gets the type

Enum"Home""Mobile""Work""Business""Fax"
sites[].​contactDetails.​phoneNumbers[].​numberstringnon-emptyrequired

Gets the phone number

sites[].​contactDetails.​emailstring or null

Gets the email address

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

Represents the physical address of a site

sites[].​ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"
sites[].​idstringnon-emptyrequired

Gets the unique identifier

sites[].​nameobject(Translatable)required

Gets the name text, and its translations

sites[].​name.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"
sites[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

sites[].​hasSellableItemsbooleanrequired

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

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

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Response
application/json
{
  "sites": [
    { … }
  ]
}

Gets a Site

Request

Returns a detailed site and its related data based on the provided siteId.

Licenses Required

  • Vista.Ocapi
Path
siteIdstringrequired

The unique identifier of site

Headers
Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json
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

site.​locationobject(GeographicLocation)

Gets the geographic location

site.​contactDetailsobject(SiteContactDetails)required

Gets the contact details

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

Gets the list of phone number entities

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

Gets the type

Enum"Home""Mobile""Work""Business""Fax"
site.​contactDetails.​phoneNumbers[].​numberstringnon-emptyrequired

Gets the phone number

site.​contactDetails.​emailstring or null

Gets the email address

site.​contactDetails.​addressobject(SiteAddress)

Represents the physical address of a site

site.​ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"
site.​idstringnon-emptyrequired

Gets the unique identifier

site.​nameobject(Translatable)required

Gets the name text, and its translations

site.​name.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"
site.​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

site.​hasSellableItemsbooleanrequired

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

site.​allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Response
application/json
{
  "site": {
    "location": { … },
    "contactDetails": { … },
    "ianaTimeZoneName": "America/New_York",
    "id": "string",
    "name": { … },
    "hasSellableItems": true,
    "allowedItemDeliveryMethods": [ … ]
  }
}

Gets a detailed site list details for a film

Request

Licenses Required

  • Vista.Ocapi
Path
filmIdstringrequired

The unique identifier of the film

Headers
Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json
sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of site entities

One of:

Represents a site in Vista Loyalty

sites[].​locationobject(GeographicLocation)

Gets the geographic location

sites[].​contactDetailsobject(SiteContactDetails)required

Gets the contact details

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

Gets the list of phone number entities

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

Gets the type

Enum"Home""Mobile""Work""Business""Fax"
sites[].​contactDetails.​phoneNumbers[].​numberstringnon-emptyrequired

Gets the phone number

sites[].​contactDetails.​emailstring or null

Gets the email address

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

Represents the physical address of a site

sites[].​ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"
sites[].​idstringnon-emptyrequired

Gets the unique identifier

sites[].​nameobject(Translatable)required

Gets the name text, and its translations

sites[].​name.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"
sites[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

sites[].​hasSellableItemsbooleanrequired

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

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

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Response
application/json
{
  "sites": [
    { … }
  ]
}

Gets the list of third party member scheme entities for a specified site

Request

This endpoint excludes any third-party member schemes that are validated against Vista Loyalty.

Loyalty schemes are handled as "member reward tickets with an availability restriction" via the GetMemberRewardAvailabilitiesForShowtime endpoint.

Licenses Required

  • Vista.Ocapi
Path
siteIdstringrequired

The unique identifier of the site

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/third-party-member-schemes' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
thirdPartyMemberSchemesArray of objects(ThirdPartyMemberScheme)required

Gets the list of third party member scheme entities

thirdPartyMemberSchemes[].​idstringnon-emptyrequired

Gets the unique identifier

thirdPartyMemberSchemes[].​nameobject(Translatable)required

Gets the name text, and its translations

thirdPartyMemberSchemes[].​name.​textstringnon-emptyrequired

Gets the text in the default language

thirdPartyMemberSchemes[].​name.​translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

thirdPartyMemberSchemes[].​name.​translations[].​languageTagstringnon-emptyrequired

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

Example: "en-US"
thirdPartyMemberSchemes[].​name.​translations[].​textstringnon-emptyrequired

Gets the translated text

thirdPartyMemberSchemes[].​cardNumberFormatobject(ThirdPartyMemberSchemeCardNumberFormat)required

Gets the card number format

thirdPartyMemberSchemes[].​cardNumberFormat.​partialFormatstringnon-emptyrequired

Gets the regular expression that can be used to determine whether a partially-entered card number matches the format

thirdPartyMemberSchemes[].​cardNumberFormat.​fullFormatstringnon-emptyrequired

Gets the regular expression that can be used to determine whether a full card number matches the format

thirdPartyMemberSchemes[].​cardNumberFormat.​prefixLengthinteger(int32)required

Gets the prefix length

thirdPartyMemberSchemes[].​seatLimitPerCardobject(Quantity)required

Gets the maximum number of seats across all ticket types for the scheme that can be ordered for an individual order ticket redemption card base for a specific showtime

thirdPartyMemberSchemes[].​seatLimitPerCard.​isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

thirdPartyMemberSchemes[].​seatLimitPerCard.​valueinteger or null(int32)

Gets the value

Response
application/json
{
  "thirdPartyMemberSchemes": [
    { … }
  ]
}

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations