Journeys

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

Gets a journey details

Request

Gets a journey which represents, from start to finish, a customer's interactions with Vista software in relation to one or multiple visits to the cinema initiated by a single sale.

Licenses Required

Vista.Ocapi

Path

journeyIdstringrequired

The unique identifier of the journey to be retrieved

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/journeys/{journeyId}' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

journeyobject(Journey)required

Gets the journey entity

journey.idstringnon-emptyrequired

Gets the unique identifier

journey.siteIdstringnon-emptyrequired

Gets the unique identifier of the site

journey.ordersArray of objects(CompletedStandardOrder)required

Gets the list of completed standard order entities

journey.orders[].idstring or null

Gets the unique identifier

journey.orders[].typestring(OrderType)required

Gets the type

Enum"Standard""GiftShop""Subscription"

journey.orders[].statusstring(OrderStatus)required

Gets the status

Enum"InProgress""Completed"

journey.orders[].totalPriceobject(MonetaryValue)required

Gets the total price to be displayed to the customer

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

journey.orders[].originalPriceobject(MonetaryValue)required

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

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

journey.orders[].bookingobject(CompletedOrderBooking)

Gets the booking details

journey.orders[].transactionobject(OrderTransaction)

Gets the transaction details, if applicable

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

Gets the list of order voucher entities

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

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

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

Gets the type

Enum"Ticket""Subscription""Deal"

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

Gets a masked representation of the barcode

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

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

Gets the unique identifier of the voucher type

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

Gets the voucher type description text, and its translations

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

Gets the list of order deal entities

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

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

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

Gets the unique identifier of the deal base used

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

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

journey.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

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

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

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

Gets the type

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

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

Gets the monetary value

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

Gets the status

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

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

Gets the list of order showtime entities

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

Gets the unique identifier of the showtime

journey.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

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

Gets the type

Enum"Normal""Package"

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

Gets the list of order package ticket content ticket entities

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

Gets the list of order package ticket content item entities

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

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

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

Gets the collection status

Enum"NotCollected""Collected"

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

Gets the refund status

Enum"NotRefunded""Refunded"

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

Gets the unique identifier of the ticket type base

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

Gets the price to be displayed to the customer

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

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

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

Gets the booking fee incurred for the ticket, if applicable

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

Gets the unique identifier of the reward used, if applicable

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

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

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

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

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

Gets the unique identifier of the discount used, if applicable

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

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

journey.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

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

Gets the list of order seat entities

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

Gets the unique identifier of the seat

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

Gets the label/physical name of the seat

Example: "5"

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

Gets the label/physical name of the row

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

Gets the area name text, and its translations

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

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

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

Gets the seat position

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

Gets the seat swap status

journey.orders[].showtimes[].seatSwapStatus.isAvailablebooleanrequired

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

journey.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"

journey.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

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

Gets the list of order item modifier group entities

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

Gets the unique identifier of the item modifier group

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

Gets the list of order item modifier entities

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

Gets the list of order package item content item base entities

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

Gets the unique identifier of the item base

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

Gets the item type

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

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

Gets the price to be displayed to the customer

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

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

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

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

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

Gets the list of order item modifier group entities

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

Gets the components of the recipe item

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

Gets the unique identifier of the order item delivery base

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

Gets the patron's comment, if applicable

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

Gets the components of the recipe item

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

Gets the unique identifier of the item base

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

Gets the item type

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

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

Gets the price to be displayed to the customer

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

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

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

Gets the modification

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

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

Gets the list of order item modifier group entities

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

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

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

Gets the unique identifier of the order item delivery base

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

Gets the patron's comment, if applicable

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

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

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

Represents the type of an item base entity

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

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

Represents a monetary value, and its related tax value

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

Represents a monetary value, and its related tax value

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

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

Represents the collection status of an order line

Enum"NotCollected""Collected"

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

Represents the refund status of an order line

Enum"NotRefunded""Refunded"

journey.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

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

Gets a value indicating whether the order line can be refunded

journey.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"

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

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

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

journey.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

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

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

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

Gets the delivery method

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

journey.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

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

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"

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

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

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

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

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

Gets a masked representation of the card number

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

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

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

journey.orders[].siteIdstringnon-emptyrequired

Gets the unique identifier of the site

journey.orders[].preparationobject(OrderPreparation)

Gets the preparation and collection details

journey.orders[].amountSavedobject(MonetaryValue)required

Gets the monetary amount saved via discounted prices

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

journey.orders[].journeyReferencestring or null

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

journey.orders[].tipobject(OrderTip)

Gets the tip

journey.orders[].refundAvailabilityobject(OrderRefundAvailability)required

Gets the current refund availability

journey.orders[].refundAvailability.isAvailablebooleanread-onlyrequired

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

journey.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"

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

Gets the list of available refund methods

Items Enum"Full""Partial"

journey.orders[].refundAvailability.isBookingFeeRefundablebooleanrequired

Gets a value indicating whether the booking fee can be refunded

journey.orders[].totalRefundedobject(MonetaryValue)required

Gets the total amount already refunded to the patron

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

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

journey.orders[].parentOrderIdstring or null

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

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

Gets the date and time that the order was completed

journey.orders[].surveyStatusstring(CompletedOrderSurveyStatus)required

Gets the survey status

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

journey.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

journey.createdAtstring(date-time)required

Gets the date and time that the journey was created

relatedDataobject(OrderRelatedData)required

Gets the related data for the journey entity

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

{
  "journey": {
    "id": "string",
    "siteId": "string",
    "orders": [ … ],
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "relatedData": {
    "films": [ … ],
    "ticketTypes": [ … ],
    "items": [ … ],
    "showtimes": [ … ],
    "sites": [ … ],
    "screens": [ … ],
    "censorRatings": [ … ],
    "itemServiceAreas": [ … ],
    "itemShowtimeDeliveryWindows": [ … ],
    "subscriptionBillingOption": { … },
    "subscription": { … },
    "balanceType": { … },
    "areaCategories": [ … ],
    "itemPostalDeliveryMethods": [ … ]
  }
}

Gets a journey details by its reference

Request

Gets a journey which represents, from start to finish, a customer's interactions with Vista software in relation to one or multiple visits to the cinema initiated by a single sale.

A journey reference is generated when the asynchronous journey service is started so that it's possible to distinguish between a valid journey that hasn't been prepared by the service and one that doesn't exist.

Licenses Required

Vista.Ocapi

Path

journeyReferencestringrequired

A reference for the journey to be retrieved

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/journeys/by-reference/{journeyReference}' \
  -H 'Connect-Region-Code: string'