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

Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order

Request

Can be used to create an 'Add to Google Wallet' button for a completed standard order

Opening the Google Wallet Pass on a supported device will prompt the patron to add the passes to their Google Wallet.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the completed standard order

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/assets/google-wallet-pass' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
jwtstringnon-emptyrequired

Gets the encoded and signed JSON Web Token (JWT)

Example: "eyJhbGci6IkpXVCJ9.eyJhdWQiO...6EkC1Ahp6A"
urlstring(uri)required

Gets the URL that can be used to create an 'Add to Google Wallet' link for web, email, or SMS

Example: "https://pay.google.com/gp/v/save/eyJhbGci6IkpXVCJ9.eyJhdWQiO...6EkC1Ahp6A"
Response
application/json
{
  "jwt": "eyJhbGci6IkpXVCJ9.eyJhdWQiO...6EkC1Ahp6A",
  "url": "https://pay.google.com/gp/v/save/eyJhbGci6IkpXVCJ9.eyJhdWQiO...6EkC1Ahp6A"
}

Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order

Request

Can be used to create an 'Add to Calendar' button for a completed standard order

Opening the iCalendar file on a supported device will prompt the patron to add the calendar events to their calendar application.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the completed standard order

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/assets/calendar-event' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
string(byte)
Response
application/json
"string"

Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order

Request

Can be used to create an 'Add to Apple Wallet' button for a completed standard order

Opening the Apple Wallet Pass bundle on a supported Apple device will prompt the patron to add the passes to their Apple Wallet.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the completed standard order

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/assets/apple-wallet-pass' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
string(byte)
Response
application/json
"string"

Gets the list of completed order redeemable item base entities for a completed gift shop order

Request

This endpoint will only return redeemable items for completed gift shop order entities. For other types of completed orders, such as completed standard order, this endpoint will return an empty array.

Redeemable item details are intentionally separated from completed gift shop order to avoid exposing sensitive voucher and gift card information.

Returning these details via a dedicated endpoint reduces the attack surface and helps prevent unauthorized access to redeemable items that could have direct financial value.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the completed gift shop order

Headers
Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/enterprise/orders/completed/{orderId}/redeemable-items' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
redeemableItemsArray of CompletedOrderGiftCardItem (object) or CompletedOrderVoucherItem (object)required

Gets the list of completed order redeemable item base entities

One of:

Represents the details of a gift card purchased via an order item line base

redeemableItems[].​orderLineIdstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the order item line base within the completed gift shop order

redeemableItems[].​typestring(CompletedOrderRedeemableItemType)required

Gets the type

Enum"Voucher""GiftCard"
redeemableItems[].​giftCardobject(GiftCard)required

Gets the gift card that was issued

redeemableItems[].​giftCard.​credentialsOrderGiftCardPaymentCreate (object) or GiftCardCredentials (object)required

Represents the credentials required to validate a gift card

One of:

Represents the values required to create an order gift card payment

redeemableItems[].​giftCard.​credentials.​cardNumberstringnon-emptyrequired

Gets the card number

redeemableItems[].​giftCard.​credentials.​pinstring or null

Gets the PIN

redeemableItems[].​giftCard.​expiryDatestring or null(date-time)

Gets the expiry date, or null if the gift card never expires

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

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

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations