The unique identifier of the showtime
Vista Digital Platform (V1)
Download OpenAPI description
Languages
Servers
Mock server
https://developer.vista.co/_mock/openapi/digital-platform/openapi
Request
Returns a list of ticket price entities for a showtime with related data.
Some ticket prices have restrictions that limit their availability. These restrictions are returned in the restrictions property. If a restriction is returned that a client does not understand, the price must be hidden until the client has implemented handling for said requirement.
Current ticket price restrictions include:
Member- A Loyalty membership is required.MemberReward- Redemption of member reward with the specifiedRewardIdis required.MemberSubscriptionCard- A subscription for the specifiedThirdPartyMemberSchemeIdis required.ThirdPartyMemberCard- A third-party membership card belonging to the specifiedThirdPartyMemberSchemeIdis required.Voucher- Redemption of a voucher, valid for the ticket type, is required.Discount- Redemption of discount with the specifiedDiscountIdis required.
Ticket prices for Loyalty-based non-subscription third party member schemes will be returned twice:
- Once with a
ThirdPartyMemberCardrestriction intended for legacy clients adding these tickets viaAddTicketRedemptionCard. - Once with a
MemberRewardrestriction intended for clients using theGetMemberRewardAvailabilitiesForShowtimeendpoint and adding these tickets directly using theRewardId.
- The quantity limits of each ticket price available to the customer is complex.
- Due to quantity limits potentially applying across multiple ticket prices, these rules are best calculated on the client.
- The client must keep track of various ticket properties to correctly restrict quantity. These properties include:
- A client-side max-tickets-per-order setting (this does not exist as omnichannel config yet)
- The
AvailableQuantityof the member reward if applicable. - The
BalanceCostof the reward if applicable (checked against member balance + other ticket selections). - Member ticket
QuantityLimitreturned from third-party member card validation.
Discounted ticket price entities are automatically filtered based on the discount restriction Availability for the showtime
- Vista.Ocapi
- Vista.Ocapi.TicketPricesForShowtime
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/{showtimeId}/ticket-prices
- cURL
- JavaScript
- Node.js
curl -i -X GET \
'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/showtimes/{showtimeId}/ticket-prices' \
-H 'Connect-Region-Code: string'Success
Gets the list of ticket price entities
Gets the unique identifier of the ticket type base
Gets the price to be displayed to the customer
Gets the booking fee that will be incurred, if applicable
Gets the restrictions that apply
Items Enum"Member""ThirdPartyMemberCard""Voucher""MemberReward""MemberSubscriptionCard""Discount"
Gets the unique identifier of the reward that the price is restricted to
Gets the list of unique identifiers of the voucher types that the price is restricted to
Gets the unique identifier of the third party member scheme that the price is restricted to
Gets a value indicating whether this price should be previewed to the user if it is not available for purchase due to some unmet restriction
Gets the unique identifier of the subscription that the price is restricted to
Gets the unique identifier of the discount that the price is restricted to
Gets the related data for the ticket price entities
Gets the list of related ticket type base entities
One of:
Represents a ticket type base that has package contents
Gets the list of package ticket type content ticket entities
Gets the list of package ticket type content item entities
Gets the description text, and its translations.
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the long description text, and its translations.
Gets the unique identifier of the area category the ticket type belongs to
Gets a value indicating whether this ticket type is restricted to member entities
Gets the display priority used for sorting
Gets a value indicating whether this ticket is intended for children and may be subject to sale restrictions based on film and/or censor rating rules
Gets the list of related item base entities for any package ticket type entities
One of:
Represents an item base that is sold by weight, e.g. bulk candies
Represents the type of an item base entity
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the short name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the description text, and its translations
Gets the restrictions that apply
Items Enum"Member""AvailableHours"
Gets the unique identifier of the item class the item belongs to, if applicable
Gets a value indicating whether the item requires preparation
Gets the list of allowed item delivery method entities
Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Gets the unique identifier of the available hours entity
Gets the list of related discount entities
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the restriction
Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the restrictions
Items Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the list of unique identifiers of the reward entities that the discount is restricted to
Gets the list of unique identifiers of the voucher types that the discount is restricted to
Response
application/json
{ "ticketPrices": [ { … } ], "relatedData": { "ticketTypes": [ … ], "items": [ … ], "discounts": [ … ] } }