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

Gets the list of member reward entities for the currently authenticated member

Request

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/rewards \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Success

Bodyapplication/json
memberRewardsArray of objects(MemberReward)required

Gets the list of member reward entities

memberRewards[].​rewardIdinteger(int32)required

Gets the unique identifier of the reward

memberRewards[].​instanceNumberinteger(int32)required

Gets the instance number

memberRewards[].​availableQuantityobject(Quantity)required

Gets the quantity available to the member

memberRewards[].​availableQuantity.​isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

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

Gets the value

memberRewards[].​expiresAtstring or null(date-time)

Gets the date and time that the reward expires

relatedDataobject(MemberRewardListRelatedData)required

Gets the related data for the member reward entities

relatedData.​rewardsArray of objects(Reward)required

Gets the list of related reward entities

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

Gets the unique identifier

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

Gets the name text, and its translations

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

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

relatedData.​rewards[].​descriptionobject(Translatable)

Gets the description text, and its translations

relatedData.​rewards[].​balanceCostobject(RewardBalanceCost)

Gets the balance cost of redeeming the reward

relatedData.​rewards[].​typeobject(RewardType)required

Gets the type

relatedData.​rewards[].​type.​nameobject(Translatable)required

Gets the name text, and its translations

relatedData.​rewards[].​type.​name.​textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.​rewards[].​itemIdstring or null

Gets the unique identifier of the associated loyalty item

relatedData.​rewards[].​limitPerOrderinteger or null(int32)

Gets the maximum quantity available to a member per order base

relatedData.​rewards[].​limitPerShowtimeinteger or null(int32)

Gets the maximum quantity available to a member per showtime

relatedData.​rewards[].​discountCalculationPercentageOffDiscountCalculation (object) or PriceOffDiscountCalculation (object) or SpecialPriceDiscountCalculation (object)

Represents the base properties that describe the calculation of a discount

One of:

Represents a percentage-off type of discount calculation base

relatedData.​rewards[].​restrictionsArray of strings(RewardRestriction)required

Gets the restrictions that apply

Items Value"MemberRewardAvailability"
relatedData.​itemsArray of objects(LoyaltyItem)required

Gets the list of related loyalty item entities

relatedData.​items[].​idstringnon-emptyrequired

Gets the unique identifier

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

Gets the name text, and its translations

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

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

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

Gets the translated text

relatedData.​items[].​itemClassobject(LoyaltyItemClass)

Gets the item class

Response
application/json
{
  "memberRewards": [
    { … }
  ],
  "relatedData": {
    "rewards": [ … ],
    "items": [ … ]
  }
}

Gets the list of member reward availability entities for the currently authenticated member and a particular showtime

Request

member reward availability entities are returned only for reward entities where reward Restrictions includes reward restriction MemberRewardAvailability

The number of member reward availability entities returned are subject to a configured limit. If exceeded, the member reward availability entities returned are automatically truncated to the configured limit.

Licenses Required

  • Vista.Ocapi
Path
showtimeIdstringrequired

The unique identifier of the showtime

Query
rewardIdsArray of integers(int32)unique

Optional. The unique identifier of the reward entities to get member availabilty for

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/reward-availability/by-showtime/{showtimeId}?rewardIds=0' \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Success

Bodyapplication/json
memberRewardAvailabilitiesArray of objects(MemberRewardAvailability)required

Gets the list of member reward availability entities

memberRewardAvailabilities[].​rewardIdinteger(int32)required

Gets the unique identifier of the reward

memberRewardAvailabilities[].​ticketTypesArray of objects(MemberRewardTicketTypeAvailability)required

Gets the list of member reward ticket type availability entities

memberRewardAvailabilities[].​ticketTypes[].​ticketTypeIdstringnon-emptyrequired

Gets the unique identifier of the ticket type base

memberRewardAvailabilities[].​ticketTypes[].​isAvailablebooleanread-onlyrequired

Gets a value indicating whether the member reward is available for the ticket type base

memberRewardAvailabilities[].​ticketTypes[].​availableQuantityobject(Quantity)required

Gets the quantity available to the member for the ticket type base

memberRewardAvailabilities[].​ticketTypes[].​availableQuantity.​isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

memberRewardAvailabilities[].​ticketTypes[].​availableQuantity.​valueinteger or null(int32)

Gets the value

memberRewardAvailabilities[].​ticketTypes[].​unavailableMessageobject(Translatable)

Gets the message to display when the member reward is unavailable for the ticket type base

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

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