Gets a list of current journey entities for the currently authenticated member

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

Sets the order member balance payment for an in progress order base

Request

The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment.

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the in progress order base that the payment is for

Headers

loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Body

required

The member balance payment request

valuenumber or null(double)

Gets the monetary value, if applicable

curl -i -X PUT \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/member-balance' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "value": 0.1
  }'

Responses

Success

Bodyapplication/json

idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the payment within the order base

typestring(OrderPaymentType)required

Gets the type

Enum"CinemaProcessed""Embedded""GiftCard""Redirect""MemberBalance""ExternallyProcessed"

valuenumber(double)required

Gets the monetary value

statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"

balanceTypeIdinteger(int32)required

Gets the unique identifier of the balance type

unitsnumber(double)required

Gets the value in balance type units

Response

application/json

{
  "id": "string",
  "type": "CinemaProcessed",
  "value": 0.1,
  "status": "NotStarted",
  "balanceTypeId": 0,
  "units": 0.1
}

Gets a list of current journey entities for the currently authenticated member
Deprecated

Request

Current journeys are defined as journeys that:

Either contain a showtime that has yet to finish or no showtimes and uncollected items.
Have not been fully refunded.

Sort order is by showtime date or date of order (if no showtime present) with earliest first.

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

Responses

Success

Bodyapplication/json

journeysArray of objects(Journey)required

Gets the list of journey entities

journeys[].idstringnon-emptyrequired

Gets the unique identifier

journeys[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

journeys[].ordersArray of objects(CompletedStandardOrder)required

Gets the list of completed standard order entities

journeys[].orders[].idstring or null

Gets the unique identifier

journeys[].orders[].typestring(OrderType)required

Gets the type

Enum"Standard""GiftShop""Subscription"

journeys[].orders[].statusstring(OrderStatus)required

Gets the status

Enum"InProgress""Completed"

journeys[].orders[].totalPriceobject(MonetaryValue)required

Gets the total price to be displayed to the customer

journeys[].orders[].totalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

journeys[].orders[].totalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

journeys[].orders[].totalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

journeys[].orders[].originalPriceobject(MonetaryValue)required

Gets the total price the customer paid for the order at the time the order was initially completed

journeys[].orders[].originalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

journeys[].orders[].originalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

journeys[].orders[].originalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

journeys[].orders[].bookingobject(CompletedOrderBooking)

Gets the booking details

journeys[].orders[].transactionobject(OrderTransaction)

Gets the transaction details, if applicable

journeys[].orders[].vouchersArray of objects(OrderVoucher)required

Gets the list of order voucher entities

journeys[].orders[].vouchers[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the voucher within the order base

journeys[].orders[].vouchers[].typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"

journeys[].orders[].vouchers[].maskedBarcodestringnon-emptyrequired

Gets a masked representation of the barcode

Example: "12.......6789"

journeys[].orders[].vouchers[].voucherTypeCodestringnon-emptyrequired

Gets the unique identifier of the voucher type

journeys[].orders[].vouchers[].voucherTypeDescriptionobject(Translatable)

Gets the voucher type description text, and its translations

journeys[].orders[].dealsArray of objects(OrderDeal)required

Gets the list of order deal entities

journeys[].orders[].deals[].idstringnon-emptyread-onlyrequired

Gets the identifier that can be used to uniquely identify the deal within the order base

journeys[].orders[].deals[].dealIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the deal base used

journeys[].orders[].deals[].voucherIdstring or null

Gets the unique identifier of the order voucher used, if applicable

journeys[].orders[].paymentsArray of OrderRedirectPayment (object) or OrderMemberBalancePayment (object) or OrderGiftCardPayment (object) or OrderExternallyProcessedPayment (object) or OrderEmbeddedPayment (object) or OrderCinemaProcessedPayment (object)required

Gets the list of order payment base entities

One of:

Represents a redirect payment that has been added to an order base

journeys[].orders[].payments[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the payment within the order base

journeys[].orders[].payments[].typestring(OrderPaymentType)required

Gets the type

Enum"CinemaProcessed""Embedded""GiftCard""Redirect""MemberBalance""ExternallyProcessed"

journeys[].orders[].payments[].valuenumber(double)required

Gets the monetary value

journeys[].orders[].payments[].statusstring(OrderPaymentStatus)required

Gets the status

Enum"NotStarted""Pending""Declined""Completed"

journeys[].orders[].showtimesArray of objects(OrderShowtime)required

Gets the list of order showtime entities

journeys[].orders[].showtimes[].showtimeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the showtime

journeys[].orders[].showtimes[].ticketsArray of OrderTicketLineBase (object)required

Gets the list of order ticket line base entities

One of:

Represents an order ticket line base for an instance of a package ticket type

journeys[].orders[].showtimes[].tickets[].typestring(TicketTypeType)required

Gets the type

Enum"Normal""Package"

journeys[].orders[].showtimes[].tickets[].ticketsArray of objects(OrderPackageTicketContentTicket)required

Gets the list of order package ticket content ticket entities

journeys[].orders[].showtimes[].tickets[].itemsArray of objects(OrderPackageTicketContentItem)required

Gets the list of order package ticket content item entities

journeys[].orders[].showtimes[].tickets[].idstringnon-emptyrequired

Gets the identifier that can be used to uniquely identify the line within the order base

journeys[].orders[].showtimes[].tickets[].collectionStatusstring(OrderLineCollectionStatus)required

Gets the collection status

Enum"NotCollected""Collected"

journeys[].orders[].showtimes[].tickets[].refundStatusstring(OrderLineRefundStatus)required

Gets the refund status

Enum"NotRefunded""Refunded"

journeys[].orders[].showtimes[].tickets[].ticketTypeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the ticket type base

journeys[].orders[].showtimes[].tickets[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

journeys[].orders[].showtimes[].tickets[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the ticket due to all discounts and deals

journeys[].orders[].showtimes[].tickets[].bookingFeeobject(OrderBookingFeeLine)

Gets the booking fee incurred for the ticket, if applicable

journeys[].orders[].showtimes[].tickets[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward used, if applicable

journeys[].orders[].showtimes[].tickets[].ticketRedemptionCardIdstring or null(uuid)

Gets the unique identifier of the order ticket redemption card base used, if applicable

journeys[].orders[].showtimes[].tickets[].voucherIdstring or null

Gets the unique identifier of the order voucher used, if applicable

journeys[].orders[].showtimes[].tickets[].discountIdstring or nullread-only

Gets the unique identifier of the discount used, if applicable

journeys[].orders[].showtimes[].tickets[].dealIdstring or null

Gets the unique identifier of the order deal used, if applicable

journeys[].orders[].showtimes[].tickets[].refundAvailabilityCompletedOrderLineRefundAvailability (object) or CompletedWeightBasedOrderLineRefundAvailability (object) or InProgressOrderLineRefundAvailability (object)required

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

journeys[].orders[].showtimes[].seatsArray of objects(OrderSeat)required

Gets the list of order seat entities

journeys[].orders[].showtimes[].seats[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

journeys[].orders[].showtimes[].seats[].seatLabelstring or null

Gets the label/physical name of the seat

Example: "5"

journeys[].orders[].showtimes[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

journeys[].orders[].showtimes[].seats[].areaNameobject(Translatable)required

Gets the area name text, and its translations

journeys[].orders[].showtimes[].seats[].areaCategoryIdstringnon-emptyrequired

Gets the unique identifier of the area category the seat belongs to

journeys[].orders[].showtimes[].seats[].positionobject(SeatPosition)required

Gets the seat position

journeys[].orders[].showtimes[].seatSwapStatusobject(OrderShowtimeSeatSwapStatus)required

Gets the seat swap status

journeys[].orders[].showtimes[].seatSwapStatus.isAvailablebooleanrequired

Gets a value indicating whether the order showtime Seats can be swapped

journeys[].orders[].showtimes[].seatSwapStatus.unavailableReasonstring(OrderShowtimeSeatSwapUnavailableReason)required

Gets the reason the seats cannot be swapped

Enum"NotApplicable""NotEnabled""UnallocatedSeating""NoSeats""PackageTickets""InSeatDeliveryItems""OrderNotCompleted""OrderRefunded""UnpaidBooking""ShowtimeEnded"

journeys[].orders[].itemsArray of OrderItemLineBase (object)required

Gets the list of order item line base entities

One of:

Represents the base properties of an order line for a top-level instance of an item base within a standard order or gift shop order

journeys[].orders[].items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

journeys[].orders[].items[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

journeys[].orders[].items[].modifierGroups[].modifiersArray of objects(OrderItemModifier)required

Gets the list of order item modifier entities

journeys[].orders[].items[].itemsArray of objects(OrderPackageItemContentItem)required

Gets the list of order package item content item base entities

journeys[].orders[].items[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

journeys[].orders[].items[].items[].typestring(ItemType)required

Gets the item type

Enum"Normal""ParentSales""Package""Recipe""WeightBased"

journeys[].orders[].items[].items[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

journeys[].orders[].items[].items[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the item due to all discounts and deals

journeys[].orders[].items[].items[].parentSalesItemIdstring or null

Gets the unique identifier of the parent sales item this item is an option for

journeys[].orders[].items[].items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

journeys[].orders[].items[].items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

journeys[].orders[].items[].items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

journeys[].orders[].items[].items[].commentstring or null

Gets the patron's comment, if applicable

journeys[].orders[].items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

journeys[].orders[].items[].components[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

journeys[].orders[].items[].components[].typestring(ItemType)required

Gets the item type

Enum"Normal""ParentSales""Package""Recipe""WeightBased"

journeys[].orders[].items[].components[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

journeys[].orders[].items[].components[].amountSavedobject(MonetaryValue)required

Gets the total amount saved on the item due to all discounts and deals

journeys[].orders[].items[].components[].modificationstring(OrderRecipeItemComponentModification)required

Gets the modification

Enum"None""Remove""Extra""OnTheSide""ExtraOnTheSide"

journeys[].orders[].items[].components[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

journeys[].orders[].items[].components[].parentSalesItemIdstring or nullread-only

Gets the unique identifier of the parent sales item this item is an option for

journeys[].orders[].items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

journeys[].orders[].items[].commentstring or null

Gets the patron's comment, if applicable

journeys[].orders[].items[].itemIdstringnon-emptyrequired

journeys[].orders[].items[].idstringnon-emptyrequired

journeys[].orders[].items[].typestring(ItemType)required

Represents the type of an item base entity

Enum"Normal""ParentSales""Package""Recipe""WeightBased"

journeys[].orders[].items[].priceobject(MonetaryValue)required

Represents a monetary value, and its related tax value

journeys[].orders[].items[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

journeys[].orders[].items[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

journeys[].orders[].items[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

journeys[].orders[].items[].amountSavedobject(MonetaryValue)required

Represents a monetary value, and its related tax value

journeys[].orders[].items[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

journeys[].orders[].items[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

journeys[].orders[].items[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

journeys[].orders[].items[].parentSalesItemIdstring or nullread-only

journeys[].orders[].items[].collectionStatusstring(OrderLineCollectionStatus)required

Represents the collection status of an order line

Enum"NotCollected""Collected"

journeys[].orders[].items[].refundStatusstring(OrderLineRefundStatus)required

Represents the refund status of an order line

Enum"NotRefunded""Refunded"

journeys[].orders[].items[].refundAvailabilityCompletedOrderLineRefundAvailability (object) or CompletedWeightBasedOrderLineRefundAvailability (object) or InProgressOrderLineRefundAvailability (object)required

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

journeys[].orders[].items[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the order line can be refunded

journeys[].orders[].items[].refundAvailability.unavailableReasonstring(OrderLineRefundUnavailableReason)required

Gets the reason the order line cannot be refunded

Enum"NotApplicable""NotEnabled""OrderNotCompleted""AlreadyCollected""AlreadyRefunded""ItemDeliveryPreparationStarted""ShowtimeRefundWindowEnded""VoucherRedeemed""RedeemableItemIssued""OrderExpired"

journeys[].orders[].items[].rewardIdinteger or null(int32)

journeys[].orders[].items[].discountIdstring or nullread-only

journeys[].orders[].items[].dealIdstring or null

journeys[].orders[].itemDeliveriesArray of CompletedOrderItemCounterPickup (object) or CompletedOrderItemCustomLocationDelivery (object) or CompletedOrderItemElectronicDelivery (object) or CompletedOrderItemInSeatDelivery (object) or CompletedOrderItemPostalDelivery (object) or CompletedOrderItemServiceAreaPickup (object)required

Gets the list of completed order item delivery base entities for the standard order Items

One of:

Represents an order item counter pickup for a completed standard order

journeys[].orders[].itemDeliveries[].idstringnon-emptyrequired

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

journeys[].orders[].itemDeliveries[].methodstring(ItemDeliveryMethod)required

Gets the delivery method

Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

journeys[].orders[].ticketRedemptionCardsArray of TicketRedemptionCardBase (object)required

Gets the list of order ticket redemption card base entities

One of:

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

journeys[].orders[].ticketRedemptionCards[].typestring(TicketRedemptionCardType)required

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"

journeys[].orders[].ticketRedemptionCards[].idstring(uuid)required

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

journeys[].orders[].ticketRedemptionCards[].subscriptionIdinteger(int32)required

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

journeys[].orders[].ticketRedemptionCards[].maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

Example: "12.......6789"

journeys[].orders[].ticketRedemptionCards[].memberNameobject(PersonName)

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

journeys[].orders[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

journeys[].orders[].preparationobject(OrderPreparation)

Gets the preparation and collection details

journeys[].orders[].amountSavedobject(MonetaryValue)required

Gets the monetary amount saved via discounted prices

journeys[].orders[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

journeys[].orders[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

journeys[].orders[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

journeys[].orders[].journeyReferencestring or null

Gets the identifier created on order completion that will be linked to a journey entity

journeys[].orders[].tipobject(OrderTip)

Gets the tip

journeys[].orders[].refundAvailabilityobject(OrderRefundAvailability)required

Gets the current refund availability

journeys[].orders[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the refundable completed order base can be refunded

journeys[].orders[].refundAvailability.unavailableReasonstring(OrderRefundUnavailableReason)required

Gets the reason the refundable completed order base cannot be refunded

Enum"NotApplicable""NotEnabled""AlreadyRefunded""UnsupportedPaymentMethod""NoRefundableOrderLines""UnpaidBooking""OrderExpired""ActiveChildOrders"

journeys[].orders[].refundAvailability.availableMethodsArray of strings(OrderRefundMethod)required

Gets the list of available refund methods

Items Enum"Full""Partial"

journeys[].orders[].refundAvailability.isBookingFeeRefundablebooleanrequired

Gets a value indicating whether the booking fee can be refunded

journeys[].orders[].totalRefundedobject(MonetaryValue)required

Gets the total amount already refunded to the patron

journeys[].orders[].totalRefunded.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

journeys[].orders[].totalRefunded.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

journeys[].orders[].totalRefunded.taxnumber(double)read-onlyrequired

Gets the amount of tax

journeys[].orders[].expiresAtstring(date-time)required

Gets the date and time that the order is set to expire

journeys[].orders[].parentOrderIdstring or null

Gets the unique identifier of the linked parent completed standard order, if applicable

journeys[].orders[].createdAtstring(date-time)required

Gets the date and time that the order was completed

journeys[].orders[].surveyStatusstring(CompletedOrderSurveyStatus)required

Gets the survey status

Enum"NotApplicable""NotReady""Ready""Started""Completed""Expired""NotEnabled"

journeys[].orders[].siteOrderLocationIdstring or null

Gets the unique identifier of the site order location, if applicable.
Will equal null if items are ordered from the default site item profile

journeys[].createdAtstring(date-time)required

Gets the date and time that the journey was created

relatedDataobject(OrderRelatedData)required

Gets the related data for the journey entities

relatedData.filmsArray of objects(OrderRelatedFilm)required

Gets the list of related order related film entities

relatedData.films[].idstringnon-emptyrequired

relatedData.films[].titleobject(Translatable)required

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

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.films[].externalIdsobject(FilmExternalIds)required

Represents the external identifiers linked to a film

relatedData.films[].externalIds.moviexchangeReleaseIdstring or null(uuid)

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].censorRatingIdstring or null

relatedData.films[].censorRatingNoteobject(Translatable)

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

relatedData.ticketTypesArray of objects(OrderRelatedTicketType)required

Gets the list of related order related ticket type entities

relatedData.ticketTypes[].idstringnon-emptyread-onlyrequired

relatedData.ticketTypes[].descriptionobject(Translatable)required

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

relatedData.ticketTypes[].description.textstringnon-emptyrequired

Gets the text in the default language

relatedData.ticketTypes[].description.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.ticketTypes[].description.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.ticketTypes[].description.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.ticketTypes[].longDescriptionobject(Translatable)required

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

relatedData.ticketTypes[].longDescription.textstringnon-emptyrequired

Gets the text in the default language

relatedData.ticketTypes[].longDescription.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.ticketTypes[].longDescription.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.ticketTypes[].longDescription.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemsArray of objects(OrderRelatedItem)required

Gets the list of related order related item entities

relatedData.items[].idstringnon-emptyread-onlyrequired

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[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.items[].hopkstring or null

Gets the Head Office primary key

relatedData.items[].isSundryboolean

Gets a value indicating whether this is a sundry item

relatedData.items[].isPreparationRequiredboolean

Gets a value indicating whether the item requires preparation

relatedData.showtimesArray of objects(OrderRelatedShowtime)required

Gets the list of related order related showtime entities

relatedData.showtimes[].idstringnon-emptyread-onlyrequired

relatedData.showtimes[].scheduleobject(ShowtimeSchedule)required

Represents the dates and times relevant to a showtime, e.g. its start, end, film start, etc

relatedData.showtimes[].schedule.businessDatestring(date-time)required

Gets the showtime entity's business date

relatedData.showtimes[].schedule.startsAtstring(date-time)required

Gets the date and time that the showtime starts

relatedData.showtimes[].schedule.endsAtstring(date-time)required

Gets the date and time that the showtime ends

relatedData.showtimes[].schedule.filmStartsAtstring(date-time)required

Gets the date and time that the film screening starts

relatedData.showtimes[].schedule.filmEndsAtstring(date-time)required

Gets the date and time that the film screening ends

relatedData.showtimes[].schedule.inSeatItemDeliveryobject(ShowtimeInSeatItemDeliverySchedule)

Gets the showtime in seat item delivery schedule entity, if applicable

relatedData.showtimes[].filmIdstringnon-emptyrequired

relatedData.showtimes[].siteIdstringnon-emptyrequired

relatedData.showtimes[].screenIdstringnon-emptyread-onlyrequired

relatedData.sitesArray of LoyaltySite (object) or Site (object)required

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.screens[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.screens[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

relatedData.censorRatings[].classification.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.censorRatings[].classification.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.censorRatings[].classification.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.itemServiceAreasArray of objects(ItemServiceArea)required

Gets the list of related item service area entities

relatedData.itemServiceAreas[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemServiceAreas[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemServiceAreas[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.itemServiceAreas[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.itemServiceAreas[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemServiceAreas[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.itemServiceAreas[].shortName.textstringnon-emptyrequired

Gets the text in the default language

relatedData.itemServiceAreas[].shortName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.itemServiceAreas[].shortName.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.itemServiceAreas[].shortName.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemShowtimeDeliveryWindowsArray of objects(ItemShowtimeDeliveryWindowBase)required

Gets the list of related item showtime delivery window base entities

relatedData.itemShowtimeDeliveryWindows[].minutesinteger(int32)required

Gets the targeted delivery time, as a number of minutes from showtime schedule StartsAt

relatedData.itemShowtimeDeliveryWindows[].typestring(ItemShowtimeDeliveryWindowType)required

Gets the type

Value"MinutesFromStart"

relatedData.itemShowtimeDeliveryWindows[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.itemShowtimeDeliveryWindows[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemShowtimeDeliveryWindows[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.itemShowtimeDeliveryWindows[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.itemShowtimeDeliveryWindows[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.subscriptionBillingOptionobject(OrderRelatedSubscriptionBillingOption)

Gets the related order related subscription billing option entity

relatedData.subscriptionobject(OrderRelatedSubscription)

Gets the related order related subscription entity

relatedData.balanceTypeobject(BalanceType)

Gets the related balance type entity, if applicable

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.areaCategories[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.areaCategories[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category

relatedData.itemPostalDeliveryMethodsArray of objects(OrderRelatedItemPostalDeliveryMethod)required

Gets the list of related order related item postal delivery method entities

relatedData.itemPostalDeliveryMethods[].isDefaultbooleanrequired

Gets a value indicating whether this is the default delivery method

relatedData.itemPostalDeliveryMethods[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemPostalDeliveryMethods[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemPostalDeliveryMethods[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

relatedData.itemPostalDeliveryMethods[].name.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

relatedData.itemPostalDeliveryMethods[].name.translations[].textstringnon-emptyrequired

Gets the translated text

Response

application/json

{
  "journeys": [
    { … }
  ],
  "relatedData": {
    "films": [ … ],
    "ticketTypes": [ … ],
    "items": [ … ],
    "showtimes": [ … ],
    "sites": [ … ],
    "screens": [ … ],
    "censorRatings": [ … ],
    "itemServiceAreas": [ … ],
    "itemShowtimeDeliveryWindows": [ … ],
    "subscriptionBillingOption": { … },
    "subscription": { … },
    "balanceType": { … },
    "areaCategories": [ … ],
    "itemPostalDeliveryMethods": [ … ]
  }
}

Gets a list of past journey entities for the currently authenticated member
Deprecated

Request

Past journeys are journeys that are not considered current (see GetCurrentJourneysForMember).

Pagination is supported as potentially large amounts of historical data is in scope of query.

Sort order is by showtime date or date of order (if no showtime present) with earliest first.

Licenses Required

Vista.Ocapi

Query

limitinteger(int32)

The maximum number of journeys to return in the result set

Default 10

offsetinteger(int32)

The index of the first journey to return in the result set

Default 0

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/journeys/past?limit=10&offset=0' \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'