Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Ticket Prices

Gets a list of tickets prices for a specified showtime

Returns a list of ticket price entities for a showtime with related data.

Restrictions

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 specified RewardId is required.
  • MemberSubscriptionCard - A subscription for the specified ThirdPartyMemberSchemeId is required.
  • ThirdPartyMemberCard - A third-party membership card belonging to the specified ThirdPartyMemberSchemeId is required.
  • Voucher - Redemption of a voucher, valid for the ticket type, is required.
  • Discount - Redemption of discount with the specified DiscountId is required.

Loyalty-based third-party member schemes

Ticket prices for Loyalty-based non-subscription third party member schemes will be returned twice:

  • Once with a ThirdPartyMemberCard restriction intended for legacy clients adding these tickets via AddTicketRedemptionCard.
  • Once with a MemberReward restriction intended for clients using the GetMemberRewardAvailabilitiesForShowtime endpoint and adding these tickets directly using the RewardId.

Quantity limits

  • 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 AvailableQuantity of the member reward if applicable.
  • The BalanceCost of the reward if applicable (checked against member balance + other ticket selections).
  • Member ticket QuantityLimit returned from third-party member card validation.

Discounted ticket price entities are automatically filtered based on the discount restriction Availability for the showtime

Licenses Required

  • Vista.Ocapi
  • Vista.Ocapi.TicketPricesForShowtime
get/ocapi/v1/showtimes/{showtimeId}/ticket-prices

Path parameters

showtimeIdstring required

The unique identifier of the showtime

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "relatedData": {
    "ticketTypes": [
      {
        "description": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "longDescription": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "items": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "shortName": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "description": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "discounts": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ]
  }
}