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

Gets the list of member ticket redemption card base entities for the currently authenticated member

Request

Includes ticket redemption cards which have been shared to the member by their friends.

Licenses Required

  • Vista.Ocapi
Headers
loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

curl -i -X GET \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/ticket-redemption-cards \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Success

Bodyapplication/json
ticketRedemptionCardsArray of objects(TicketRedemptionCardBase)required

Gets the list of member ticket redemption card base entities

ticketRedemptionCards[].​typestring(TicketRedemptionCardType)required

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"
ticketRedemptionCards[].​idstring(uuid)required

Gets the unique identifier

ticketRedemptionCards[].​subscriptionIdinteger(int32)required

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

ticketRedemptionCards[].​friendIdstring or null(uuid)

Gets the unique identifier of the member friend that the card belongs to

ticketRedemptionCards[].​statusstring(MemberSubscriptionTicketRedemptionCardStatus)required

Gets the current status

Enum"Active""Frozen""OnHold"
ticketRedemptionCards[].​maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

Example: "12.......6789"
ticketRedemptionCards[].​memberNameobject(PersonName)

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

relatedDataobject(MemberTicketRedemptionCardsRelatedData)required

Gets the related data for the member ticket redemption card base entities

relatedData.​subscriptionsArray of objects(Subscription)required

Gets the subscriptions

relatedData.​subscriptions[].​idinteger(int32)required

Gets the unique identifier

relatedData.​subscriptions[].​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​subscriptions[].​name.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.​subscriptions[].​name.​translations[].​languageTagstringnon-emptyrequired

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

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

Gets the translated text

relatedData.​subscriptions[].​clubIdinteger(int32)required

Gets the unique identifier of the club

relatedData.​subscriptions[].​minimumTermInMonthsinteger(int32)required

Gets the minimum number of number of months required for the subscription term

relatedData.​subscriptions[].​minimumTermBeforeCanPurchaseFutureSubscriptionInMonthsinteger(int32)required

Gets the minimum number of months that must be completed before purchase of another subscription will be allowed

Response
application/json
{
  "ticketRedemptionCards": [
    { … }
  ],
  "relatedData": {
    "subscriptions": [ … ]
  }
}

Adds a ticket redemption card to an in progress standard order

Request

This endpoint validates the provided third party member card credentials or member ticket redemption card base and stores a successfully validated card against the order for later use.

For third party member card entities belonging to a third party member scheme that supports partial approvals, an arbitrarily large number of tickets will be requested to determine how many redemptions are actually available.

For third party member card entities belonging to a third party member scheme that does not support partial approvals, the number of tickets requested will depend on a preconfigured quantity per showtime, or only one ticket if no quantity has been configured.

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

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress standard order being modified

Headers
loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Body
required

The details of the ticket redemption card to be added

One of:

Represents the information required to add a member ticket redemption card base to an in progress standard order

memberTicketRedemptionCardIdstring(uuid)required

Gets the unique identifier of the member ticket redemption card base

typestring(OrderTicketRedemptionCardRequestType)required

Gets the type

Enum"ThirdPartyMemberCard""MemberTicketRedemptionCard"
showtimeIdstringnon-emptyrequired

Gets the unique identifier of the showtime that the ticket redemption card will be validated for

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/ticket-redemption-cards' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "credentials": {
      "cardNumber": "string",
      "thirdPartyMemberSchemeId": "string"
    },
    "type": "ThirdPartyMemberCard",
    "ticketTypeId": "string",
    "showtimeId": "string"
  }'

Responses

Success

Bodyapplication/json
ticketRedemptionCardTicketRedemptionCardBase (object)required

Represents the base properties of a ticket redemption card base that has been added to a standard order

One of:

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

ticketRedemptionCard.​typestring(TicketRedemptionCardType)required

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"
ticketRedemptionCard.​idstring(uuid)required

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

ticketRedemptionCard.​subscriptionIdinteger(int32)required

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

ticketRedemptionCard.​maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

Example: "12.......6789"
ticketRedemptionCard.​memberNameobject(PersonName)

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

redemptionLimitobject(QuantityLimit)required

Gets the maximum number of tickets that can be redeemed for the particular showtime

redemptionLimit.​isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

redemptionLimit.​maximuminteger or null(int32)

Gets the maximum quantity allowed

redemptionLimit.​minimuminteger(int32)required

Gets the minimum quantity allowed (0 by default)

ticketTypeAvailabilitiesArray of objects(OrderTicketRedemptionCardTicketTypeAvailability)required

Gets the list of order ticket redemption card ticket type availability entities

ticketTypeAvailabilities[].​ticketTypeIdstringnon-emptyrequired
ticketTypeAvailabilities[].​isAvailablebooleanrequired
ticketTypeAvailabilities[].​availableQuantityobject(Quantity)required

Represents a limited or unlimited quantity

ticketTypeAvailabilities[].​availableQuantity.​isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

ticketTypeAvailabilities[].​availableQuantity.​valueinteger or null(int32)

Gets the value

ticketTypeAvailabilities[].​unavailableMessageobject(Translatable)

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

Response
application/json
{
  "ticketRedemptionCard": {
    "type": "MemberSubscriptionCard",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "subscriptionId": 0,
    "maskedCardNumber": "12.......6789",
    "memberName": { … }
  },
  "redemptionLimit": {
    "isUnlimited": true,
    "maximum": 0,
    "minimum": 0
  },
  "ticketTypeAvailabilities": [
    { … }
  ]
}

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