{"items":[{"type":"link","fsPath":"digital-platform/index.md","metadata":{"type":"markdown"},"label":"Digital Platform","link":"/digital-platform","routeSlug":"/digital-platform"},{"type":"group","label":"Getting Started","items":[{"type":"link","fsPath":"digital-platform/getting-started/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/getting-started","routeSlug":"/digital-platform/getting-started"},{"type":"link","fsPath":"digital-platform/getting-started/security.md","metadata":{"type":"markdown"},"label":"Security","link":"/digital-platform/getting-started/security","routeSlug":"/digital-platform/getting-started/security"},{"type":"link","fsPath":"digital-platform/getting-started/rate-limiting.md","metadata":{"type":"markdown"},"label":"Rate limiting","link":"/digital-platform/getting-started/rate-limiting","routeSlug":"/digital-platform/getting-started/rate-limiting"},{"type":"link","fsPath":"digital-platform/getting-started/api-urls.md","metadata":{"type":"markdown"},"label":"API URLs","link":"/digital-platform/getting-started/api-urls","routeSlug":"/digital-platform/getting-started/api-urls"},{"type":"link","fsPath":"digital-platform/getting-started/conventions.md","metadata":{"type":"markdown"},"label":"Conventions","link":"/digital-platform/getting-started/conventions","routeSlug":"/digital-platform/getting-started/conventions"},{"type":"link","fsPath":"digital-platform/getting-started/example-queries.md","metadata":{"type":"markdown"},"label":"Example queries","link":"/digital-platform/getting-started/example-queries","routeSlug":"/digital-platform/getting-started/example-queries"},{"type":"link","fsPath":"digital-platform/getting-started/terms-and-concepts.md","metadata":{"type":"markdown"},"label":"Terminology and concepts","link":"/digital-platform/getting-started/terms-and-concepts","routeSlug":"/digital-platform/getting-started/terms-and-concepts"}]},{"type":"group","label":"Orders","items":[{"type":"link","fsPath":"digital-platform/orders/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/orders","routeSlug":"/digital-platform/orders"},{"type":"link","fsPath":"digital-platform/orders/order-flows.md","metadata":{"type":"markdown"},"label":"Order flows","link":"/digital-platform/orders/order-flows","routeSlug":"/digital-platform/orders/order-flows"},{"type":"group","label":"Standard orders","items":[{"type":"link","fsPath":"digital-platform/orders/standard-orders/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/orders/standard-orders","routeSlug":"/digital-platform/orders/standard-orders"},{"type":"link","fsPath":"digital-platform/orders/standard-orders/ordering-tickets.md","metadata":{"type":"markdown"},"label":"Ordering tickets","link":"/digital-platform/orders/standard-orders/ordering-tickets","routeSlug":"/digital-platform/orders/standard-orders/ordering-tickets"},{"type":"link","fsPath":"digital-platform/orders/standard-orders/booking-fees.md","metadata":{"type":"markdown"},"label":"Booking fees","link":"/digital-platform/orders/standard-orders/booking-fees","routeSlug":"/digital-platform/orders/standard-orders/booking-fees"},{"type":"link","fsPath":"digital-platform/orders/standard-orders/item-delivery-fees.md","metadata":{"type":"markdown"},"label":"Item delivery fees","link":"/digital-platform/orders/standard-orders/item-delivery-fees","routeSlug":"/digital-platform/orders/standard-orders/item-delivery-fees"},{"type":"link","fsPath":"digital-platform/orders/standard-orders/ticket-vouchers.md","metadata":{"type":"markdown"},"label":"Ticket vouchers","link":"/digital-platform/orders/standard-orders/ticket-vouchers","routeSlug":"/digital-platform/orders/standard-orders/ticket-vouchers"},{"type":"link","fsPath":"digital-platform/orders/standard-orders/third-party-member-tickets.md","metadata":{"type":"markdown"},"label":"Third-party member tickets","link":"/digital-platform/orders/standard-orders/third-party-member-tickets","routeSlug":"/digital-platform/orders/standard-orders/third-party-member-tickets"},{"type":"link","fsPath":"digital-platform/orders/standard-orders/subscription-tickets.md","metadata":{"type":"markdown"},"label":"Subscription tickets","link":"/digital-platform/orders/standard-orders/subscription-tickets","routeSlug":"/digital-platform/orders/standard-orders/subscription-tickets"},{"type":"link","fsPath":"digital-platform/orders/standard-orders/linked-orders.md","metadata":{"type":"markdown"},"label":"Linked orders","link":"/digital-platform/orders/standard-orders/linked-orders","routeSlug":"/digital-platform/orders/standard-orders/linked-orders"}],"expanded":"true"},{"type":"link","fsPath":"digital-platform/orders/gift-shop-orders.md","metadata":{"type":"markdown"},"label":"Gift shop orders","link":"/digital-platform/orders/gift-shop-orders","routeSlug":"/digital-platform/orders/gift-shop-orders"},{"type":"link","fsPath":"digital-platform/orders/subscription-orders.md","metadata":{"type":"markdown"},"label":"Subscription orders","link":"/digital-platform/orders/subscription-orders","routeSlug":"/digital-platform/orders/subscription-orders"},{"type":"link","fsPath":"digital-platform/orders/expiry.md","metadata":{"type":"markdown"},"label":"Order expiry","link":"/digital-platform/orders/expiry","routeSlug":"/digital-platform/orders/expiry"},{"type":"link","fsPath":"digital-platform/orders/ordering-items.md","metadata":{"type":"markdown"},"label":"Ordering items","link":"/digital-platform/orders/ordering-items","routeSlug":"/digital-platform/orders/ordering-items"},{"type":"link","fsPath":"digital-platform/orders/item-deliveries.md","metadata":{"type":"markdown"},"label":"Item deliveries","link":"/digital-platform/orders/item-deliveries","routeSlug":"/digital-platform/orders/item-deliveries"},{"type":"link","fsPath":"digital-platform/orders/deals.md","metadata":{"type":"markdown"},"label":"Deals","link":"/digital-platform/orders/deals","routeSlug":"/digital-platform/orders/deals"},{"type":"link","fsPath":"digital-platform/orders/tax.md","metadata":{"type":"markdown"},"label":"Tax","link":"/digital-platform/orders/tax","routeSlug":"/digital-platform/orders/tax"}]},{"type":"group","label":"Seating","items":[{"type":"link","fsPath":"digital-platform/seating/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/seating","routeSlug":"/digital-platform/seating"}]},{"type":"group","label":"Loyalty","items":[{"type":"link","fsPath":"digital-platform/loyalty/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/loyalty","routeSlug":"/digital-platform/loyalty"},{"type":"link","fsPath":"digital-platform/loyalty/member-authentication.md","metadata":{"type":"markdown"},"label":"Member authentication","link":"/digital-platform/loyalty/member-authentication","routeSlug":"/digital-platform/loyalty/member-authentication"},{"type":"link","fsPath":"digital-platform/loyalty/member-creation.md","metadata":{"type":"markdown"},"label":"Member creation","link":"/digital-platform/loyalty/member-creation","routeSlug":"/digital-platform/loyalty/member-creation"},{"type":"link","fsPath":"digital-platform/loyalty/member-updates.md","metadata":{"type":"markdown"},"label":"Member updates","link":"/digital-platform/loyalty/member-updates","routeSlug":"/digital-platform/loyalty/member-updates"},{"type":"link","fsPath":"digital-platform/loyalty/member-password-reset.md","metadata":{"type":"markdown"},"label":"Member password reset","link":"/digital-platform/loyalty/member-password-reset","routeSlug":"/digital-platform/loyalty/member-password-reset"},{"type":"link","fsPath":"digital-platform/loyalty/member-password-rules.md","metadata":{"type":"markdown"},"label":"Member password rules","link":"/digital-platform/loyalty/member-password-rules","routeSlug":"/digital-platform/loyalty/member-password-rules"},{"type":"link","fsPath":"digital-platform/loyalty/member-rewards.md","metadata":{"type":"markdown"},"label":"Member rewards","link":"/digital-platform/loyalty/member-rewards","routeSlug":"/digital-platform/loyalty/member-rewards"},{"type":"link","fsPath":"digital-platform/loyalty/member-subscriptions.md","metadata":{"type":"markdown"},"label":"Member subscriptions","link":"/digital-platform/loyalty/member-subscriptions","routeSlug":"/digital-platform/loyalty/member-subscriptions"},{"type":"link","fsPath":"digital-platform/loyalty/member-pricing.md","metadata":{"type":"markdown"},"label":"Member pricing","link":"/digital-platform/loyalty/member-pricing","routeSlug":"/digital-platform/loyalty/member-pricing"},{"type":"link","fsPath":"digital-platform/loyalty/member-friends.md","metadata":{"type":"markdown"},"label":"Member friends","link":"/digital-platform/loyalty/member-friends","routeSlug":"/digital-platform/loyalty/member-friends"},{"type":"link","fsPath":"digital-platform/loyalty/member-photos.md","metadata":{"type":"markdown"},"label":"Member photos","link":"/digital-platform/loyalty/member-photos","routeSlug":"/digital-platform/loyalty/member-photos"},{"type":"link","fsPath":"digital-platform/loyalty/member-payment-cards.md","metadata":{"type":"markdown"},"label":"Member payment cards","link":"/digital-platform/loyalty/member-payment-cards","routeSlug":"/digital-platform/loyalty/member-payment-cards"},{"type":"link","fsPath":"digital-platform/loyalty/member-balances.md","metadata":{"type":"markdown"},"label":"Member balances","link":"/digital-platform/loyalty/member-balances","routeSlug":"/digital-platform/loyalty/member-balances"},{"type":"link","fsPath":"digital-platform/loyalty/member-bookings-and-transactions.md","metadata":{"type":"markdown"},"label":"Member bookings & transactions","link":"/digital-platform/loyalty/member-bookings-and-transactions","routeSlug":"/digital-platform/loyalty/member-bookings-and-transactions"},{"type":"link","fsPath":"digital-platform/loyalty/member-film-watchlist.md","metadata":{"type":"markdown"},"label":"Member film watchlist","link":"/digital-platform/loyalty/member-film-watchlist","routeSlug":"/digital-platform/loyalty/member-film-watchlist"},{"type":"link","fsPath":"digital-platform/loyalty/member-watched-films.md","metadata":{"type":"markdown"},"label":"Member watched films","link":"/digital-platform/loyalty/member-watched-films","routeSlug":"/digital-platform/loyalty/member-watched-films"}]},{"type":"group","label":"Subscriptions","items":[{"type":"link","fsPath":"digital-platform/subscriptions/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/subscriptions","routeSlug":"/digital-platform/subscriptions"},{"type":"link","fsPath":"digital-platform/subscriptions/benefits.md","metadata":{"type":"markdown"},"label":"Benefits","link":"/digital-platform/subscriptions/benefits","routeSlug":"/digital-platform/subscriptions/benefits"},{"type":"group","label":"Purchase","items":[{"type":"link","fsPath":"digital-platform/subscriptions/purchase/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/subscriptions/purchase","routeSlug":"/digital-platform/subscriptions/purchase"},{"type":"link","fsPath":"digital-platform/subscriptions/purchase/billing-options.md","metadata":{"type":"markdown"},"label":"Billing options","link":"/digital-platform/subscriptions/purchase/billing-options","routeSlug":"/digital-platform/subscriptions/purchase/billing-options"},{"type":"link","fsPath":"digital-platform/subscriptions/purchase/contracted-terms.md","metadata":{"type":"markdown"},"label":"Contracted terms","link":"/digital-platform/subscriptions/purchase/contracted-terms","routeSlug":"/digital-platform/subscriptions/purchase/contracted-terms"},{"type":"link","fsPath":"digital-platform/subscriptions/purchase/future-subscriptions.md","metadata":{"type":"markdown"},"label":"Future subscriptions","link":"/digital-platform/subscriptions/purchase/future-subscriptions","routeSlug":"/digital-platform/subscriptions/purchase/future-subscriptions"}]},{"type":"group","label":"Recurring subscriptions","items":[{"type":"link","fsPath":"digital-platform/subscriptions/recurring/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/subscriptions/recurring","routeSlug":"/digital-platform/subscriptions/recurring"},{"type":"link","fsPath":"digital-platform/subscriptions/recurring/payment-cards.md","metadata":{"type":"markdown"},"label":"Payment cards","link":"/digital-platform/subscriptions/recurring/payment-cards","routeSlug":"/digital-platform/subscriptions/recurring/payment-cards"},{"type":"link","fsPath":"digital-platform/subscriptions/recurring/billing-errors.md","metadata":{"type":"markdown"},"label":"Billing errors","link":"/digital-platform/subscriptions/recurring/billing-errors","routeSlug":"/digital-platform/subscriptions/recurring/billing-errors"},{"type":"link","fsPath":"digital-platform/subscriptions/recurring/reactivation.md","metadata":{"type":"markdown"},"label":"Reactivation","link":"/digital-platform/subscriptions/recurring/reactivation","routeSlug":"/digital-platform/subscriptions/recurring/reactivation"},{"type":"link","fsPath":"digital-platform/subscriptions/recurring/cancellation.md","metadata":{"type":"markdown"},"label":"Cancellation","link":"/digital-platform/subscriptions/recurring/cancellation","routeSlug":"/digital-platform/subscriptions/recurring/cancellation"},{"type":"link","fsPath":"digital-platform/subscriptions/recurring/third-party-payment-providers.md","metadata":{"type":"markdown"},"label":"Third-party payment providers","link":"/digital-platform/subscriptions/recurring/third-party-payment-providers","routeSlug":"/digital-platform/subscriptions/recurring/third-party-payment-providers"}]},{"type":"group","label":"Non-recurring subscriptions","items":[{"type":"link","fsPath":"digital-platform/subscriptions/non-recurring/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/subscriptions/non-recurring","routeSlug":"/digital-platform/subscriptions/non-recurring"}]},{"type":"link","fsPath":"digital-platform/subscriptions/hold-periods.md","metadata":{"type":"markdown"},"label":"Hold periods","link":"/digital-platform/subscriptions/hold-periods","routeSlug":"/digital-platform/subscriptions/hold-periods"}]},{"type":"group","label":"Payments","items":[{"type":"link","fsPath":"digital-platform/payments/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/payments","routeSlug":"/digital-platform/payments"},{"type":"link","fsPath":"digital-platform/payments/redirect-payments.md","metadata":{"type":"markdown"},"label":"Redirect payments","link":"/digital-platform/payments/redirect-payments","routeSlug":"/digital-platform/payments/redirect-payments"},{"type":"link","fsPath":"digital-platform/payments/embedded-payments.md","metadata":{"type":"markdown"},"label":"Embedded payments","link":"/digital-platform/payments/embedded-payments","routeSlug":"/digital-platform/payments/embedded-payments"},{"type":"link","fsPath":"digital-platform/payments/member-balance-payments.md","metadata":{"type":"markdown"},"label":"Member balance payments","link":"/digital-platform/payments/member-balance-payments","routeSlug":"/digital-platform/payments/member-balance-payments"},{"type":"link","fsPath":"digital-platform/payments/error-handling.md","metadata":{"type":"markdown"},"label":"Error handling","link":"/digital-platform/payments/error-handling","routeSlug":"/digital-platform/payments/error-handling"}]},{"type":"group","label":"Completed Orders","items":[{"type":"link","fsPath":"digital-platform/completed-orders/index.md","metadata":{"type":"markdown"},"label":"Overview","link":"/digital-platform/completed-orders","routeSlug":"/digital-platform/completed-orders"},{"type":"link","fsPath":"digital-platform/completed-orders/collection.md","metadata":{"type":"markdown"},"label":"Collection","link":"/digital-platform/completed-orders/collection","routeSlug":"/digital-platform/completed-orders/collection"},{"type":"link","fsPath":"digital-platform/completed-orders/refunds.md","metadata":{"type":"markdown"},"label":"Refunds","link":"/digital-platform/completed-orders/refunds","routeSlug":"/digital-platform/completed-orders/refunds"},{"type":"link","fsPath":"digital-platform/completed-orders/seat-swaps.md","metadata":{"type":"markdown"},"label":"Seat swaps","link":"/digital-platform/completed-orders/seat-swaps","routeSlug":"/digital-platform/completed-orders/seat-swaps"},{"type":"link","fsPath":"digital-platform/completed-orders/item-delivery-preparation.md","metadata":{"type":"markdown"},"label":"Item delivery preparation","link":"/digital-platform/completed-orders/item-delivery-preparation","routeSlug":"/digital-platform/completed-orders/item-delivery-preparation"},{"type":"link","fsPath":"digital-platform/completed-orders/expiry.md","metadata":{"type":"markdown"},"label":"Expiry","link":"/digital-platform/completed-orders/expiry","routeSlug":"/digital-platform/completed-orders/expiry"},{"type":"link","fsPath":"digital-platform/completed-orders/updates.md","metadata":{"type":"markdown"},"label":"Updates","link":"/digital-platform/completed-orders/updates","routeSlug":"/digital-platform/completed-orders/updates"},{"type":"group","label":"Assets","items":[{"type":"link","fsPath":"digital-platform/completed-orders/assets/apple-wallet-passes.md","metadata":{"type":"markdown"},"label":"Apple Wallet passes","link":"/digital-platform/completed-orders/assets/apple-wallet-passes","routeSlug":"/digital-platform/completed-orders/assets/apple-wallet-passes"},{"type":"link","fsPath":"digital-platform/completed-orders/assets/google-wallet-passes.md","metadata":{"type":"markdown"},"label":"Google Wallet passes","link":"/digital-platform/completed-orders/assets/google-wallet-passes","routeSlug":"/digital-platform/completed-orders/assets/google-wallet-passes"},{"type":"link","fsPath":"digital-platform/completed-orders/assets/calendar-events.md","metadata":{"type":"markdown"},"label":"Calendar events","link":"/digital-platform/completed-orders/assets/calendar-events","routeSlug":"/digital-platform/completed-orders/assets/calendar-events"}],"expanded":"true"}]},{"type":"link","fsPath":"digital-platform/surveys/surveys.md","metadata":{"type":"markdown"},"label":"React (Post-showtime surveys)","link":"/digital-platform/surveys/surveys","routeSlug":"/digital-platform/surveys/surveys"},{"type":"group","label":"API Reference","items":[{"type":"link","label":"Vista Digital Platform","link":"/openapi/digital-platform/openapi","routeSlug":"/openapi/digital-platform/openapi"},{"type":"group","label":"Completed Order Assets","link":"/openapi/digital-platform/openapi/completed-order-assets","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets","items":[{"label":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getgooglewalletpassfororder","metadata":{"seo":{"title":"Gets a google wallet pass containing an 'event ticket' pass for each order showtime within a completed standard order","description":"Can be used to create an 'Add to Google Wallet' button for a completed standard order"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/assets/google-wallet-pass"},{"label":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getcalendareventfororder","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getcalendareventfororder","metadata":{"seo":{"title":"Gets an iCalendar (iCal) file containing a calendar event for each order showtime within a completed standard order","description":"Can be used to create an 'Add to Calendar' button for a completed standard order"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/assets/calendar-event"},{"label":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapicompletedorderassets_getapplewalletpassfororder","metadata":{"seo":{"title":"Gets an Apple Wallet Pass bundle containing an 'event ticket' pass for each order showtime within a completed standard order","description":"Can be used to create an 'Add to Apple Wallet' button for a completed standard order"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/assets/apple-wallet-pass"},{"label":"Gets the list of completed order redeemable item base entities for a completed gift shop order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems","routeSlug":"/openapi/digital-platform/openapi/completed-order-assets/ocapienterprisecompletedorders_getcompletedorderredeemableitems","metadata":{"seo":{"title":"Gets the list of completed order redeemable item base entities for a completed gift shop order","description":"This endpoint will only return redeemable items for completed gift shop order entities. For other types of completed orders,such as completed standard order, this endpoint will return an empty array."}},"httpPath":"/ocapi/v1/enterprise/orders/completed/{orderId}/redeemable-items"}]},{"type":"group","label":"Completed Orders","link":"/openapi/digital-platform/openapi/completed-orders","routeSlug":"/openapi/digital-platform/openapi/completed-orders","items":[{"label":"Gets the customer set on a completed standard order or completed gift shop order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedordercustomer_getcustomer","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedordercustomer_getcustomer","metadata":{"seo":{"title":"Gets the customer set on a completed standard order or completed gift shop order","description":"As order customer contains Personally Identifiable Information (PII),the client is responsible for storing this data securely and for as little time as possible."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/customer"},{"label":"Gets the details of a completed order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorder","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorder","metadata":{"seo":{"title":"Gets the details of a completed order base","description":"This endpoint does not currently support tab order entities."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}"},{"label":"Gets the details of a completed standard order by its completed standard order JourneyReference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbyjourneyreference","metadata":{"seo":{"title":"Gets the details of a completed standard order by its completed standard order JourneyReference","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}"},{"label":"Gets the details of a completed standard order by its completed order booking Id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbybookingid","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getcompletedorderbybookingid","metadata":{"seo":{"title":"Gets the details of a completed standard order by its completed order booking Id","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/completed/sites/{siteId}/by-booking-id/{bookingId}"},{"label":"Swaps the seats for an order showtime within a completed standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_swapseats","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_swapseats","metadata":{"seo":{"title":"Swaps the seats for an order showtime within a completed standard order","description":"This endpoint can only be used for completed orders. To change the seats in a in progress standard order, use SetShowtime instead."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/showtimes/{showtimeId}/seats"},{"label":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveriesasrequested","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveriesasrequested","metadata":{"seo":{"title":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status","description":"Calling this endpoint will update the preparation status of all completed order item delivery base entities with an completed order item delivery preparation status OnHoldstatus that are available for preparation to completed order item delivery preparation status Requested"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation-status/requested"},{"label":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveryasrequested","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setitemdeliveryasrequested","metadata":{"seo":{"title":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","description":"This endpoint can only be used for completed order item delivery base entities with an order item delivery schedule type OnRequest schedule."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation-status/requested"},{"label":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getorderidentifiersbyjourneyreference","metadata":{"seo":{"title":"Gets the completed standard order identifiers for a completed standard order\r\nby its completed standard order JourneyReference","description":"Gets a set of identifiers that can be used to call other OCAPI endpoints in a consistent manner."}},"httpPath":"/ocapi/v1/orders/completed/by-journey-reference/{journeyReference}/identifiers"},{"label":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getprintstreams","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_getprintstreams","metadata":{"seo":{"title":"Gets the print streams of an uncollected completed order base that are compatible with the requested printer","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/print-streams"},{"label":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setorderascollected","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_setorderascollected","metadata":{"seo":{"title":"Sets the order line collection status of all lines in a completed standard order to order line collection status Collected","description":"Calling this endpoint confirms that all completed order print streams have been printed and will prevent any further calls to GetPrintStreams."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/collection-status/collected"},{"label":"Creates an in progress standard order that is a child of a completed standard order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_createchildorder","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_createchildorder","metadata":{"seo":{"title":"Creates an in progress standard order that is a child of a completed standard order","description":"This endpoint can only be used for completed standard order entities that are not children themselves."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/child-orders"},{"label":"Gets the order showtime seats details for the provided barcode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorderseats_getorderseatsbybarcode","metadata":{"seo":{"title":"Gets the order showtime seats details for the provided barcode","description":"Can return seats for orders that were not made by Connect, e.g. POS."}},"httpPath":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats"},{"label":"Gets a journey details for a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapijourneys_getjourneyforcompletedorder","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapijourneys_getjourneyforcompletedorder","metadata":{"seo":{"title":"Gets a journey details for a completed standard order","description":"Gets a journey which represents, from start to finish, a customer's interactions withVista software in relation to one or multiple visits to the cinema initiated by asingle sale."}},"httpPath":"/ocapi/v1/journeys/by-order-id/{orderId}"},{"label":"Gets a list of active member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberactivecompletedorders","metadata":{"seo":{"title":"Gets a list of active member completed order base entities for the currently authenticated member","description":"Active orders are defined as member completed order base entities that have not expired (see member completed order base ExpiresAt)"}},"httpPath":"/ocapi/v1/members/current/completed-orders/active"},{"label":"Gets a list of expired member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapimembercompletedorders_getmemberexpiredcompletedorders","metadata":{"seo":{"title":"Gets a list of expired member completed order base entities for the currently authenticated member","description":"Expired completed orders are member completed order base entities that have expired (see member completed order base ExpiresAt)"}},"httpPath":"/ocapi/v1/members/current/completed-orders/expired"},{"label":"Gets the survey for a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_getordersurvey","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_getordersurvey","metadata":{"seo":{"title":"Gets the survey for a completed standard order","description":"Only standard orders with a single showtime are applicable for a survey."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey"},{"label":"Updates the survey responses for completed standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_setordersurveyresponses","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapisurveys_setordersurveyresponses","metadata":{"seo":{"title":"Updates the survey responses for completed standard order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey/responses"},{"label":"Starts preparation of items in a completed standard order","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_startorderpreparation","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_startorderpreparation","metadata":{"seo":{"title":"Starts preparation of items in a completed standard order","description":"Calling this endpoint will also set the CollectionStatus of the items to Collected."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/preparation"},{"label":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareallitemdeliveries","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareallitemdeliveries","metadata":{"seo":{"title":"Requests the preparation of all completed order item delivery base entities in a completed standard order\r\nwith an completed order item delivery preparation status OnHold status that are available for preparation to\r\ncompleted order item delivery preparation status Requested","description":"Calling this endpoint will also set the collectable order line CollectionStatus of all items in thecompleted standard order to order line collection status Collected"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/preparation"},{"label":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareitemdelivery","routeSlug":"/openapi/digital-platform/openapi/completed-orders/ocapicompletedorders_prepareitemdelivery","metadata":{"seo":{"title":"Requests the preparation of a completed order item delivery base with an completed order item delivery preparation status OnHold status","description":"This endpoint can only be used for completed order item delivery base entities with an order item delivery schedule type OnRequest schedule."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/item-deliveries/{itemDeliveryId}/preparation"}]},{"type":"group","label":"Orders","link":"/openapi/digital-platform/openapi/orders","routeSlug":"/openapi/digital-platform/openapi/orders","items":[{"label":"Creates an in progress standard order that is a child of a completed standard order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapicompletedorders_createchildorder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapicompletedorders_createchildorder","metadata":{"seo":{"title":"Creates an in progress standard order that is a child of a completed standard order","description":"This endpoint can only be used for completed standard order entities that are not children themselves."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/child-orders"},{"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapimemberorders_getmembertabordersforsite","routeSlug":"/openapi/digital-platform/openapi/orders/ocapimemberorders_getmembertabordersforsite","metadata":{"seo":{"title":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}"},{"label":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_setcustomer","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_setcustomer","metadata":{"seo":{"title":"Sets the customer for an in progress standard order, in progress gift shop order,\r\nor in progress tab order","description":"This endpoint is not available for in progress subscription order entities, as the order customer isautomatically set based on the details of the authenticated member"}},"httpPath":"/ocapi/v1/orders/{orderId}/customer"},{"label":"Gets the customer set on an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_getcustomer","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordercustomer_getcustomer","metadata":{"seo":{"title":"Gets the customer set on an in progress order base","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/customer"},{"label":"Adds items to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderitems_additems","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderitems_additems","metadata":{"seo":{"title":"Adds items to an in progress tab order","description":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."}},"httpPath":"/ocapi/v1/orders/{orderId}/items"},{"label":"Assigns an in progress tab order to the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordermember_setordermember","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordermember_setordermember","metadata":{"seo":{"title":"Assigns an in progress tab order to the currently authenticated member","description":"This endpoint is not available for in progress standard order,in progress gift shop order or in progress subscription order entities, as theauthenticated member is automatically set when the order is created or modified."}},"httpPath":"/ocapi/v1/orders/{orderId}/member/current"},{"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_createorderembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/embedded"},{"label":"Gets the current order payment card for an in progress tab order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpaymentcard_getcurrentorderpaymentcard","metadata":{"seo":{"title":"Gets the current order payment card for an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/current"},{"label":"Removes an order payment base from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_removepayment","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_removepayment","metadata":{"seo":{"title":"Removes an order payment base from an in progress order base","description":"Only order gift card payment and order member balance payment entities can be removed at this time."}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/{paymentId}"},{"label":"Creates an order payment card payment and completes the in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_createpaymentcardpayment","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorderpayments_createpaymentcardpayment","metadata":{"seo":{"title":"Creates an order payment card payment and completes the in progress tab order","description":"The order must have an assigned in progress tab order PaymentCard and an unpaid balancein order to create an order payment card payment"}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/payment-card"},{"label":"Creates an in progress standard order as a booking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_createstandardorderasbooking","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_createstandardorderasbooking","metadata":{"seo":{"title":"Creates an in progress standard order as a booking","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/standard/booking"},{"label":"Gets the details of a in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_getorder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_getorder","metadata":{"seo":{"title":"Gets the details of a in progress order base","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}"},{"label":"Cancels an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_cancelorder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_cancelorder","metadata":{"seo":{"title":"Cancels an in progress order base","description":"This endpoint is not available for in progress tab order entities, as any items in the orderhave already been processed and confirmed for the patron."}},"httpPath":"/ocapi/v1/orders/{orderId}"},{"label":"Resets the expiry of an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiorders_resetorderexpiry","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiorders_resetorderexpiry","metadata":{"seo":{"title":"Resets the expiry of an in progress order base","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/expiry/reset"},{"label":"Removes a voucher from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_removevoucher","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_removevoucher","metadata":{"seo":{"title":"Removes a voucher from an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}"},{"label":"Adds a voucher to an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_addvoucher","routeSlug":"/openapi/digital-platform/openapi/orders/ocapiordervouchers_addvoucher","metadata":{"seo":{"title":"Adds a voucher to an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers"},{"label":"Creates an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapitaborders_createtaborder","routeSlug":"/openapi/digital-platform/openapi/orders/ocapitaborders_createtaborder","metadata":{"seo":{"title":"Creates an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/tab"},{"label":"Gets an in progress tab order by its in progress tab order AccessCode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ocapitaborders_gettaborderbyaccesscode","routeSlug":"/openapi/digital-platform/openapi/orders/ocapitaborders_gettaborderbyaccesscode","metadata":{"seo":{"title":"Gets an in progress tab order by its in progress tab order AccessCode","description":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,generated from a restricted character set designed to avoid visually ambiguous characters."}},"httpPath":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}"},{"label":"Adds a tip to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/orders/ordertips_addordertip","routeSlug":"/openapi/digital-platform/openapi/orders/ordertips_addordertip","metadata":{"seo":{"title":"Adds a tip to an in progress tab order","description":"For in progress standard order entities, use SetOrderTip instead."}},"httpPath":"/ocapi/v1/orders/{orderId}/tips"}]},{"type":"group","label":"Seats","link":"/openapi/digital-platform/openapi/seats","routeSlug":"/openapi/digital-platform/openapi/seats","items":[{"label":"Gets the order showtime seats details for the provided barcode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seats/ocapicompletedorderseats_getorderseatsbybarcode","routeSlug":"/openapi/digital-platform/openapi/seats/ocapicompletedorderseats_getorderseatsbybarcode","metadata":{"seo":{"title":"Gets the order showtime seats details for the provided barcode","description":"Can return seats for orders that were not made by Connect, e.g. POS."}},"httpPath":"/ocapi/v1/sites/{siteId}/orders/by-barcode/{barcode}/seats"}]},{"type":"group","label":"Dining","link":"/openapi/digital-platform/openapi/dining","routeSlug":"/openapi/digital-platform/openapi/dining","items":[{"label":"Gets the dining layout for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/dining/ocapidininglayouts_getdininglayoutforsite","routeSlug":"/openapi/digital-platform/openapi/dining/ocapidininglayouts_getdininglayoutforsite","metadata":{"seo":{"title":"Gets the dining layout for a site","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites/{siteId}/dining-layout"},{"label":"Gets the dining location tab availability for a dining location base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/dining/ocapitablocationavailability_getdininglocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/dining/ocapitablocationavailability_getdininglocationtabavailability","metadata":{"seo":{"title":"Gets the dining location tab availability for a dining location base","description":"Licenses Required"}},"httpPath":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability"}]},{"type":"group","label":"Sites","link":"/openapi/digital-platform/openapi/sites","routeSlug":"/openapi/digital-platform/openapi/sites","items":[{"label":"Gets the dining layout for a site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapidininglayouts_getdininglayoutforsite","routeSlug":"/openapi/digital-platform/openapi/sites/ocapidininglayouts_getdininglayoutforsite","metadata":{"seo":{"title":"Gets the dining layout for a site","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites/{siteId}/dining-layout"},{"label":"Gets a detailed site list details including related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapisites_getsites","routeSlug":"/openapi/digital-platform/openapi/sites/ocapisites_getsites","metadata":{"seo":{"title":"Gets a detailed site list details including related data","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites"},{"label":"Gets a Site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapisites_getsite","routeSlug":"/openapi/digital-platform/openapi/sites/ocapisites_getsite","metadata":{"seo":{"title":"Gets a Site","description":"Returns a detailed site and its related data based on the provided siteId."}},"httpPath":"/ocapi/v1/sites/{siteId}"},{"label":"Gets a detailed site list details for a film","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapisites_getsitesforfilm","routeSlug":"/openapi/digital-platform/openapi/sites/ocapisites_getsitesforfilm","metadata":{"seo":{"title":"Gets a detailed site list details for a film","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites/for-film/{filmId}"},{"label":"Creates an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapitaborders_createtaborder","routeSlug":"/openapi/digital-platform/openapi/sites/ocapitaborders_createtaborder","metadata":{"seo":{"title":"Creates an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/tab"},{"label":"Gets an in progress tab order by its in progress tab order AccessCode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapitaborders_gettaborderbyaccesscode","routeSlug":"/openapi/digital-platform/openapi/sites/ocapitaborders_gettaborderbyaccesscode","metadata":{"seo":{"title":"Gets an in progress tab order by its in progress tab order AccessCode","description":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,generated from a restricted character set designed to avoid visually ambiguous characters."}},"httpPath":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}"},{"label":"Gets the list of third party member scheme entities for a specified site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","routeSlug":"/openapi/digital-platform/openapi/sites/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","metadata":{"seo":{"title":"Gets the list of third party member scheme entities for a specified site","description":"This endpoint excludes any third-party member schemes that are validated against Vista Loyalty."}},"httpPath":"/ocapi/v1/sites/{siteId}/third-party-member-schemes"}]},{"type":"group","label":"Discounts","link":"/openapi/digital-platform/openapi/discounts","routeSlug":"/openapi/digital-platform/openapi/discounts","items":[{"label":"Gets the current list of discount availability entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite","routeSlug":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsite","metadata":{"seo":{"title":"Gets the current list of discount availability entities for a particular site","description":"This endpoint returns availabilities for discount entities configured for the site with respect to thesite's current local time."}},"httpPath":"/ocapi/v1/sites/{siteId}/discount-availability"},{"label":"Gets the current list of discount availability entities for a particular site and site order location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation","routeSlug":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforsiteorderlocation","metadata":{"seo":{"title":"Gets the current list of discount availability entities for a particular site and site order location","description":"This endpoint returns availabilities for discount entities configured for the site and site order location with respect to thesite's current local time."}},"httpPath":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/discount-availability"},{"label":"Gets the current list of discount availability entities for a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime","routeSlug":"/openapi/digital-platform/openapi/discounts/ocapidiscountavailability_getdiscountavailabilitiesforshowtime","metadata":{"seo":{"title":"Gets the current list of discount availability entities for a particular showtime","description":"This endpoint returns availabilities for discount entities with respect to the time of the showtime"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/discount-availability"}]},{"type":"group","label":"Events","link":"/openapi/digital-platform/openapi/events","routeSlug":"/openapi/digital-platform/openapi/events","items":[{"label":"Gets a list of event entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/events/ocapievents_getevents","routeSlug":"/openapi/digital-platform/openapi/events/ocapievents_getevents","metadata":{"seo":{"title":"Gets a list of event entities","description":"Only Head Office defined events are returned."}},"httpPath":"/ocapi/v1/events"},{"label":"Gets an event entity by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/events/ocapievents_getevent","routeSlug":"/openapi/digital-platform/openapi/events/ocapievents_getevent","metadata":{"seo":{"title":"Gets an event entity by its unique identifier","description":"Only Head Office defined events can be returned."}},"httpPath":"/ocapi/v1/events/{eventId}"}]},{"type":"group","label":"Showtimes","link":"/openapi/digital-platform/openapi/showtimes","routeSlug":"/openapi/digital-platform/openapi/showtimes","items":[{"label":"Gets a list of showtime entities for an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapievents_getshowtimesforevent","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapievents_getshowtimesforevent","metadata":{"seo":{"title":"Gets a list of showtime entities for an event","description":"Licenses Required"}},"httpPath":"/ocapi/v1/events/{eventId}/showtimes"},{"label":"Gets a list of showtime entities for a film","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapifilms_getshowtimesforfilm","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapifilms_getshowtimesforfilm","metadata":{"seo":{"title":"Gets a list of showtime entities for a film","description":"Returns an empty list of showtime entities if no showtimes are scheduled for that film"}},"httpPath":"/ocapi/v1/films/{filmId}/showtimes"},{"label":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapiordershowtimes_setshowtime","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapiordershowtimes_setshowtime","metadata":{"seo":{"title":"Sets the requested tickets and/or seats for an order showtime within an in progress standard order","description":"This endpoint cannot be used for orders that have a parent order (see standard order ParentOrderId)"}},"httpPath":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}"},{"label":"Gets the current list of showtime availability entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailabilities","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailabilities","metadata":{"seo":{"title":"Gets the current list of showtime availability entities","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/availability"},{"label":"Gets the current showtime availability of a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailability","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimeavailability_getshowtimeavailability","metadata":{"seo":{"title":"Gets the current showtime availability of a particular showtime","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/availability"},{"label":"Gets a list of showtime entities for the first business date with showtimes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforfirstbusinessdate","metadata":{"seo":{"title":"Gets a list of showtime entities for the first business date with showtimes","description":"Useful when filtering by site or film where showtimes may only be in the future."}},"httpPath":"/ocapi/v1/showtimes/by-business-date/first"},{"label":"Gets a list of showtime entities for a business date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforbusinessdate","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforbusinessdate","metadata":{"seo":{"title":"Gets a list of showtime entities for a business date","description":"Returns an empty list of showtime entities if no showtimes are scheduled."}},"httpPath":"/ocapi/v1/showtimes/by-business-date/{businessDate}"},{"label":"Gets a list of showtime entities for today and tomorrow for a screen","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforscreen","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtimesforscreen","metadata":{"seo":{"title":"Gets a list of showtime entities for today and tomorrow for a screen","description":"This endpoint is currently used to find an in-progress or imminent showtime given a screen ID, which canthen be used as the showtime context for an in-seat delivery order."}},"httpPath":"/ocapi/v1/showtimes/by-screen/{screenId}"},{"label":"Gets a showtime by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtime","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapishowtimes_getshowtime","metadata":{"seo":{"title":"Gets a showtime by its unique identifier","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}"},{"label":"Gets the in seat location tab availability for a seat within a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/showtimes/ocapitablocationavailability_getinseatlocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/showtimes/ocapitablocationavailability_getinseatlocationtabavailability","metadata":{"seo":{"title":"Gets the in seat location tab availability for a seat within a showtime","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability"}]},{"type":"group","label":"Films","link":"/openapi/digital-platform/openapi/films","routeSlug":"/openapi/digital-platform/openapi/films","items":[{"label":"Gets a list of film entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilms","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilms","metadata":{"seo":{"title":"Gets a list of film entities","description":"Returns a list of film entities along with their related data."}},"httpPath":"/ocapi/v1/films"},{"label":"Gets a film entity by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilm","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilm","metadata":{"seo":{"title":"Gets a film entity by its unique identifier","description":"Returns a detailed film and its related data based on the provided filmId."}},"httpPath":"/ocapi/v1/films/{filmId}"},{"label":"Gets the current list of film availability entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailabilities","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailabilities","metadata":{"seo":{"title":"Gets the current list of film availability entities","description":"The details of each film availability is based on the collated data of every site that is screening the film."}},"httpPath":"/ocapi/v1/films/availability"},{"label":"Gets the current film availability of a particular film","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailability","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilms_getfilmavailability","metadata":{"seo":{"title":"Gets the current film availability of a particular film","description":"Licenses Required"}},"httpPath":"/ocapi/v1/films/{filmId}/availability"},{"label":"Gets Screening Dates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilmscreeningdates_getfilmscreeningdates","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilmscreeningdates_getfilmscreeningdates","metadata":{"seo":{"title":"Gets Screening Dates","description":"Returns a list of dates that have upcoming showtimes, along with details about which films are playing at each site on each day."}},"httpPath":"/ocapi/v1/film-screening-dates"},{"label":"Gets the list of film entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmsforsite","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmsforsite","metadata":{"seo":{"title":"Gets the list of film entities for a particular site","description":"Returns a list of film entities along with their related data."}},"httpPath":"/ocapi/v1/sites/{siteId}/films"},{"label":"Gets the current list of film availability entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmavailabilitiesforsite","routeSlug":"/openapi/digital-platform/openapi/films/ocapifilmsforsite_getfilmavailabilitiesforsite","metadata":{"seo":{"title":"Gets the current list of film availability entities for a particular site","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites/{siteId}/films/availability"}]},{"type":"group","label":"Gift Cards","link":"/openapi/digital-platform/openapi/gift-cards","routeSlug":"/openapi/digital-platform/openapi/gift-cards","items":[{"label":"Gets the details of a gift card (available balance and expiry date)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/gift-cards/ocapigiftcard_getgiftcarddetails","routeSlug":"/openapi/digital-platform/openapi/gift-cards/ocapigiftcard_getgiftcarddetails","metadata":{"seo":{"title":"Gets the details of a gift card (available balance and expiry date)","description":"Introduced"}},"httpPath":"/ocapi/v1/gift-cards/details"},{"label":"Adds an order gift card payment to an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/gift-cards/ocapiorderpayments_addgiftcardpayment","routeSlug":"/openapi/digital-platform/openapi/gift-cards/ocapiorderpayments_addgiftcardpayment","metadata":{"seo":{"title":"Adds an order gift card payment to an in progress order base","description":"Payment details are stored against order and processed when order is complete."}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/gift-cards"}]},{"type":"group","label":"Items","link":"/openapi/digital-platform/openapi/items","routeSlug":"/openapi/digital-platform/openapi/items","items":[{"label":"Gets the current list of item availability entities for a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsite","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsite","metadata":{"seo":{"title":"Gets the current list of item availability entities for a particular site","description":"Use GetItemAvailabilitiesForSiteOrderLocation to get the site item availability list details for a particular site order location"}},"httpPath":"/ocapi/v1/sites/{siteId}/item-availability"},{"label":"Gets the current list of item availability entities for a particular site and site order location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforsiteorderlocation","metadata":{"seo":{"title":"Gets the current list of item availability entities for a particular site and site order location","description":"Use GetItemAvailabilitiesForSite to get the default site item availability list details for the site"}},"httpPath":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-availability"},{"label":"Gets the current list of item availability entities for the Gift Shop","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforgiftshop","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemavailability_getitemavailabilitiesforgiftshop","metadata":{"seo":{"title":"Gets the current list of item availability entities for the Gift Shop","description":"Licenses Required"}},"httpPath":"/ocapi/v1/gift-shop/item-availability"},{"label":"Gets the site item profile and its related data for a specified site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsite","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsite","metadata":{"seo":{"title":"Gets the site item profile and its related data for a specified site","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites/{siteId}/item-profile"},{"label":"Gets the site item profile and its related data for a specified site and site order location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsiteorderlocation","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforsiteorderlocation","metadata":{"seo":{"title":"Gets the site item profile and its related data for a specified site and site order location","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-profile"},{"label":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getsellableitembyhopkforsite","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getsellableitembyhopkforsite","metadata":{"seo":{"title":"Gets a sellable item for an item base with a specified head office entity Hopk for a specified site, and its related data","description":"Licenses Required"}},"httpPath":"/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}"},{"label":"Gets the item profile and it's related data for the Gift Shop","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforgiftshop","routeSlug":"/openapi/digital-platform/openapi/items/ocapiitemprofiles_getitemprofileforgiftshop","metadata":{"seo":{"title":"Gets the item profile and it's related data for the Gift Shop","description":"Licenses Required"}},"httpPath":"/ocapi/v1/gift-shop/item-profile"},{"label":"Sets the items for an in progress standard order or in progress gift shop order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiorderitems_setitems","routeSlug":"/openapi/digital-platform/openapi/items/ocapiorderitems_setitems","metadata":{"seo":{"title":"Sets the items for an in progress standard order or in progress gift shop order","description":"Existing items on the order will be replaced with the specified selections."}},"httpPath":"/ocapi/v1/orders/{orderId}/items"},{"label":"Adds items to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/items/ocapiorderitems_additems","routeSlug":"/openapi/digital-platform/openapi/items/ocapiorderitems_additems","metadata":{"seo":{"title":"Adds items to an in progress tab order","description":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."}},"httpPath":"/ocapi/v1/orders/{orderId}/items"}]},{"type":"group","label":"Journeys","link":"/openapi/digital-platform/openapi/journeys","routeSlug":"/openapi/digital-platform/openapi/journeys","items":[{"label":"Gets a journey details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourney","routeSlug":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourney","metadata":{"seo":{"title":"Gets a journey details","description":"Gets a journey which represents, from start to finish, a customer's interactions withVista software in relation to one or multiple visits to the cinema initiated by asingle sale."}},"httpPath":"/ocapi/v1/journeys/{journeyId}"},{"label":"Gets a journey details by its reference","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourneybyreference","routeSlug":"/openapi/digital-platform/openapi/journeys/ocapijourneys_getjourneybyreference","metadata":{"seo":{"title":"Gets a journey details by its reference","description":"Gets a journey which represents, from start to finish, a customer's interactions withVista software in relation to one or multiple visits to the cinema initiated by asingle sale."}},"httpPath":"/ocapi/v1/journeys/by-reference/{journeyReference}"}]},{"type":"group","label":"Third Party Passes","link":"/openapi/digital-platform/openapi/third-party-passes","routeSlug":"/openapi/digital-platform/openapi/third-party-passes","items":[{"label":"Gets an Apple Wallet pass for a journey","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney","routeSlug":"/openapi/digital-platform/openapi/third-party-passes/ocapijourneythirdpartypasses_getapplewalletpassforjourney","metadata":{"seo":{"title":"Gets an Apple Wallet pass for a journey","description":"Previously known as 'Apple Passbook' and renamed to 'Apple Wallet' by Apple Inc. in 2015."}},"httpPath":"/ocapi/v1/journeys/{journeyId}/third-party-passes/apple-wallet"}]},{"type":"group","label":"Loyalty","link":"/openapi/digital-platform/openapi/loyalty","routeSlug":"/openapi/digital-platform/openapi/loyalty","items":[{"label":"Returns reference master data required to build member management UIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapiloyaltymasterdata_getmasterdata","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapiloyaltymasterdata_getmasterdata","metadata":{"seo":{"title":"Returns reference master data required to build member management UIs","description":"Licenses Required"}},"httpPath":"/ocapi/v1/loyalty-master-data"},{"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapimemberauthentication_createworkstationauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","description":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."}},"httpPath":"/ocapi/v1/members/workstation-authentication-cookie"},{"label":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_setmemberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_setmemberpushnotificationtoken","metadata":{"seo":{"title":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","description":"Only one push notification token can be saved on a member entity. Updating the push notification tokenfrom a different mobile device will prevent the previous mobile device from receiving push notifications."}},"httpPath":"/ocapi/v1/members/current/push-notification-token"},{"label":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_removememberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/loyalty/ocapimemberupdate_removememberpushnotificationtoken","metadata":{"seo":{"title":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/push-notification-token"}]},{"type":"group","label":"Authentication","link":"/openapi/digital-platform/openapi/authentication","routeSlug":"/openapi/digital-platform/openapi/authentication","items":[{"label":"Authenticates a member and creates an member authentication token","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationtoken","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationtoken","metadata":{"seo":{"title":"Authenticates a member and creates an member authentication token","description":"This method of authentication is recommended for clients that can securely store the member authentication token access_tokenand member authentication token refresh_token locally."}},"httpPath":"/ocapi/v1/members/authentication-token"},{"label":"Authenticates a member and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member and returns an HTTP-only authentication cookie","description":"This method of authentication is recommended for clients that do not have access to secure storage, as the authentication token is stored in a secure HTTP-only cookie."}},"httpPath":"/ocapi/v1/members/authentication-cookie"},{"label":"Expires the current authentication cookie","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_expireauthenticationcookie","metadata":{"seo":{"title":"Expires the current authentication cookie","description":"Expires the current authentication cookie created by the CreateAuthenticationCookie or the CreateWorkstationAuthenticationCookie method."}},"httpPath":"/ocapi/v1/members/authentication-cookie"},{"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createworkstationauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/authentication/ocapimemberauthentication_createworkstationauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","description":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."}},"httpPath":"/ocapi/v1/members/workstation-authentication-cookie"}]},{"type":"group","label":"Members","link":"/openapi/digital-platform/openapi/members","routeSlug":"/openapi/digital-platform/openapi/members","items":[{"label":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberauthentication_createworkstationauthenticationcookie","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberauthentication_createworkstationauthenticationcookie","metadata":{"seo":{"title":"Authenticates a member for authenticated devices and returns an HTTP-only authentication cookie","description":"The HTTP Authorization header must include a Central Identity Management device token (also known as a DIM token)."}},"httpPath":"/ocapi/v1/members/workstation-authentication-cookie"},{"label":"Gets a list of active member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberactivecompletedorders","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberactivecompletedorders","metadata":{"seo":{"title":"Gets a list of active member completed order base entities for the currently authenticated member","description":"Active orders are defined as member completed order base entities that have not expired (see member completed order base ExpiresAt)"}},"httpPath":"/ocapi/v1/members/current/completed-orders/active"},{"label":"Gets a list of expired member completed order base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberexpiredcompletedorders","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembercompletedorders_getmemberexpiredcompletedorders","metadata":{"seo":{"title":"Gets a list of expired member completed order base entities for the currently authenticated member","description":"Expired completed orders are member completed order base entities that have expired (see member completed order base ExpiresAt)"}},"httpPath":"/ocapi/v1/members/current/completed-orders/expired"},{"label":"Creates a friend code for the currently authenticated Loyalty member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_createfriendcode","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_createfriendcode","metadata":{"seo":{"title":"Creates a friend code for the currently authenticated Loyalty member","description":"A friend code can be redeemed by another member to create a member friend"}},"httpPath":"/ocapi/v1/members/current/friend-code"},{"label":"Adds a friend by creating a member friend using a friend code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_addfriendfromcode","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_addfriendfromcode","metadata":{"seo":{"title":"Adds a friend by creating a member friend using a friend code","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/friends/code"},{"label":"Removes a friend by deleting a member friend","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_removefriend","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_removefriend","metadata":{"seo":{"title":"Removes a friend by deleting a member friend","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/friends/{id}"},{"label":"Sets the subscription sharing details of a member friend","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberfriends_setsubscriptionsharing","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberfriends_setsubscriptionsharing","metadata":{"seo":{"title":"Sets the subscription sharing details of a member friend","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/friends/{id}/subscription-sharing"},{"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberorders_getmembertabordersforsite","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberorders_getmembertabordersforsite","metadata":{"seo":{"title":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}"},{"label":"Gets the list of member reward entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewards","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewards","metadata":{"seo":{"title":"Gets the list of member reward entities for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/rewards"},{"label":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","metadata":{"seo":{"title":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","description":"member reward availability entities are returned only for reward entities wherereward Restrictions includes reward restriction MemberRewardAvailability"}},"httpPath":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}"},{"label":"Gets the details of the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_getcurrentmember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_getcurrentmember","metadata":{"seo":{"title":"Gets the details of the currently authenticated member","description":"The member is always reloaded directly from Loyalty with no caching."}},"httpPath":"/ocapi/v1/members/current"},{"label":"Deletes the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_deletecurrentmember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_deletecurrentmember","metadata":{"seo":{"title":"Deletes the currently authenticated member","description":"The member can no longer be authenticated after this endpoint has been successfully called."}},"httpPath":"/ocapi/v1/members/current"},{"label":"Creates a member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_createmember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_createmember","metadata":{"seo":{"title":"Creates a member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members"},{"label":"Gets a list of member transaction entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembers_getmembertransactions","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembers_getmembertransactions","metadata":{"seo":{"title":"Gets a list of member transaction entities for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/transactions"},{"label":"Updates the member personal details of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpersonaldetails","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpersonaldetails","metadata":{"seo":{"title":"Updates the member personal details of the currently authenticated member","description":"Full personalDetails object from GetMember containing updated values must be sent to this endpoint.If field is not provided then it's considered that it must be cleared."}},"httpPath":"/ocapi/v1/members/current/personal-details"},{"label":"Updates the member photo of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberphoto","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberphoto","metadata":{"seo":{"title":"Updates the member photo of the currently authenticated member","description":"The photo is uploaded via a form-data key/value pair with type file and the key being \"MemberPhoto\"."}},"httpPath":"/ocapi/v1/members/current/photo"},{"label":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_setmemberpushnotificationtoken","metadata":{"seo":{"title":"Updates the push notification token of the currently authenticated member allowing\r\ntheir mobile device to receive push notifications","description":"Only one push notification token can be saved on a member entity. Updating the push notification tokenfrom a different mobile device will prevent the previous mobile device from receiving push notifications."}},"httpPath":"/ocapi/v1/members/current/push-notification-token"},{"label":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberupdate_removememberpushnotificationtoken","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberupdate_removememberpushnotificationtoken","metadata":{"seo":{"title":"Removes the push notification token of the currently authenticated member\r\npreventing push notification from being received on their mobile device","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/push-notification-token"},{"label":"Validates whether an email is available for a new member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimembervalidateemail_validateemailavailability","routeSlug":"/openapi/digital-platform/openapi/members/ocapimembervalidateemail_validateemailavailability","metadata":{"seo":{"title":"Validates whether an email is available for a new member","description":"This endpoint validates email correctly only if the ForceUniqueEmails system setting in Loyalty is set to true."}},"httpPath":"/ocapi/v1/members/email-availability"},{"label":"Assigns an in progress tab order to the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapiordermember_setordermember","routeSlug":"/openapi/digital-platform/openapi/members/ocapiordermember_setordermember","metadata":{"seo":{"title":"Assigns an in progress tab order to the currently authenticated member","description":"This endpoint is not available for in progress standard order,in progress gift shop order or in progress subscription order entities, as theauthenticated member is automatically set when the order is created or modified."}},"httpPath":"/ocapi/v1/orders/{orderId}/member/current"},{"label":"Gets the order maximum member balance payment for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapiorderpayments_getmaximummemberbalancepayment","routeSlug":"/openapi/digital-platform/openapi/members/ocapiorderpayments_getmaximummemberbalancepayment","metadata":{"seo":{"title":"Gets the order maximum member balance payment for an in progress order base","description":"The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment."}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/maximum-member-balance"},{"label":"Sets the order member balance payment for an in progress order base","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapiorderpayments_setmemberbalancepayment","routeSlug":"/openapi/digital-platform/openapi/members/ocapiorderpayments_setmemberbalancepayment","metadata":{"seo":{"title":"Sets the order member balance payment for an in progress order base","description":"The currently authenticated member must have a member card and a supported balance type in order to make a member balance payment."}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/member-balance"},{"label":"Gets a list of current journey entities for the currently authenticated member","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getcurrentjourneysformember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getcurrentjourneysformember","metadata":{"seo":{"title":"Gets a list of current journey entities for the currently authenticated member","description":"Current journeys are defined as journeys that:"}},"httpPath":"/ocapi/v1/members/current/journeys/current"},{"label":"Gets a list of past journey entities for the currently authenticated member","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getpastjourneysformember","routeSlug":"/openapi/digital-platform/openapi/members/ocapimemberjourneys_getpastjourneysformember","metadata":{"seo":{"title":"Gets a list of past journey entities for the currently authenticated member","description":"Past journeys are journeys that are not considered current (see GetCurrentJourneysForMember)."}},"httpPath":"/ocapi/v1/members/current/journeys/past"}]},{"type":"group","label":"Friends","link":"/openapi/digital-platform/openapi/friends","routeSlug":"/openapi/digital-platform/openapi/friends","items":[{"label":"Creates a friend code for the currently authenticated Loyalty member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_createfriendcode","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_createfriendcode","metadata":{"seo":{"title":"Creates a friend code for the currently authenticated Loyalty member","description":"A friend code can be redeemed by another member to create a member friend"}},"httpPath":"/ocapi/v1/members/current/friend-code"},{"label":"Adds a friend by creating a member friend using a friend code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_addfriendfromcode","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_addfriendfromcode","metadata":{"seo":{"title":"Adds a friend by creating a member friend using a friend code","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/friends/code"},{"label":"Removes a friend by deleting a member friend","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_removefriend","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_removefriend","metadata":{"seo":{"title":"Removes a friend by deleting a member friend","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/friends/{id}"},{"label":"Sets the subscription sharing details of a member friend","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_setsubscriptionsharing","routeSlug":"/openapi/digital-platform/openapi/friends/ocapimemberfriends_setsubscriptionsharing","metadata":{"seo":{"title":"Sets the subscription sharing details of a member friend","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/friends/{id}/subscription-sharing"}]},{"type":"group","label":"Tabs","link":"/openapi/digital-platform/openapi/tabs","routeSlug":"/openapi/digital-platform/openapi/tabs","items":[{"label":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapimemberorders_getmembertabordersforsite","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapimemberorders_getmembertabordersforsite","metadata":{"seo":{"title":"Gets a list of in progress tab order entities for the currently authenticated member\r\nand a particular site","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/orders/tab/by-site/{siteId}"},{"label":"Adds items to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderitems_additems","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderitems_additems","metadata":{"seo":{"title":"Adds items to an in progress tab order","description":"Items cannot be added to an in progress tab order when in progress tab order IsOpen equals false."}},"httpPath":"/ocapi/v1/orders/{orderId}/items"},{"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_createorderembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/embedded"},{"label":"Gets the current order payment card for an in progress tab order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderpaymentcard_getcurrentorderpaymentcard","metadata":{"seo":{"title":"Gets the current order payment card for an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/current"},{"label":"Creates an order payment card payment and completes the in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapiorderpayments_createpaymentcardpayment","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapiorderpayments_createpaymentcardpayment","metadata":{"seo":{"title":"Creates an order payment card payment and completes the in progress tab order","description":"The order must have an assigned in progress tab order PaymentCard and an unpaid balancein order to create an order payment card payment"}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/payment-card"},{"label":"Gets the in seat location tab availability for a seat within a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getinseatlocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getinseatlocationtabavailability","metadata":{"seo":{"title":"Gets the in seat location tab availability for a seat within a showtime","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability"},{"label":"Gets the dining location tab availability for a dining location base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getdininglocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitablocationavailability_getdininglocationtabavailability","metadata":{"seo":{"title":"Gets the dining location tab availability for a dining location base","description":"Licenses Required"}},"httpPath":"/ocapi/v1/dining-locations/{diningLocationId}/tab-availability"},{"label":"Creates an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitaborders_createtaborder","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitaborders_createtaborder","metadata":{"seo":{"title":"Creates an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/tab"},{"label":"Gets an in progress tab order by its in progress tab order AccessCode","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ocapitaborders_gettaborderbyaccesscode","routeSlug":"/openapi/digital-platform/openapi/tabs/ocapitaborders_gettaborderbyaccesscode","metadata":{"seo":{"title":"Gets an in progress tab order by its in progress tab order AccessCode","description":"The access code is a case-insensitive, human-readable, 5-character alphanumeric string,generated from a restricted character set designed to avoid visually ambiguous characters."}},"httpPath":"/ocapi/v1/sites/{siteId}/orders/tab/by-access-code/{accessCode}"},{"label":"Adds a tip to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tabs/ordertips_addordertip","routeSlug":"/openapi/digital-platform/openapi/tabs/ordertips_addordertip","metadata":{"seo":{"title":"Adds a tip to an in progress tab order","description":"For in progress standard order entities, use SetOrderTip instead."}},"httpPath":"/ocapi/v1/orders/{orderId}/tips"}]},{"type":"group","label":"Password Reset","link":"/openapi/digital-platform/openapi/password-reset","routeSlug":"/openapi/digital-platform/openapi/password-reset","items":[{"label":"Creates a password reset code for a member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_createpasswordresetcode","routeSlug":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_createpasswordresetcode","metadata":{"seo":{"title":"Creates a password reset code for a member","description":"Successful response returned regardless of the existence of the provided email/username in Loyalty."}},"httpPath":"/ocapi/v1/members/password-reset-code"},{"label":"Validates a password reset code","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_validatepasswordresetcode","routeSlug":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_validatepasswordresetcode","metadata":{"seo":{"title":"Validates a password reset code","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/password-reset-code/validate"},{"label":"Resets a member entity's password","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_resetpassword","routeSlug":"/openapi/digital-platform/openapi/password-reset/ocapimemberpasswordreset_resetpassword","metadata":{"seo":{"title":"Resets a member entity's password","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/password-reset"}]},{"type":"group","label":"Payments","link":"/openapi/digital-platform/openapi/payments","routeSlug":"/openapi/digital-platform/openapi/payments","items":[{"label":"Gets the list of member payment card entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcards","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcards","metadata":{"seo":{"title":"Gets the list of member payment card entities for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/payment-cards"},{"label":"Gets a member payment card for the currently authenticated member by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_getmemberpaymentcard","metadata":{"seo":{"title":"Gets a member payment card for the currently authenticated member by its unique identifier","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}"},{"label":"Removes a member payment card for the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_removememberpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_removememberpaymentcard","metadata":{"seo":{"title":"Removes a member payment card for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/payment-cards/{memberPaymentCardId}"},{"label":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_creatememberembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of a member payment card using an embedded UI for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/payment-cards/embedded"},{"label":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_createorderembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation of an order payment card using an embedded UI for an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/embedded"},{"label":"Gets the current order payment card for an in progress tab order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpaymentcard_getcurrentorderpaymentcard","metadata":{"seo":{"title":"Gets the current order payment card for an in progress tab order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/payment-card/current"},{"label":"Removes an order payment base from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_removepayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_removepayment","metadata":{"seo":{"title":"Removes an order payment base from an in progress order base","description":"Only order gift card payment and order member balance payment entities can be removed at this time."}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/{paymentId}"},{"label":"Creates a order embedded payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createembeddedpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createembeddedpayment","metadata":{"seo":{"title":"Creates a order embedded payment","description":"Initiates an order embedded payment with the connector so that the client can render a UI based on the returned order embedded payment client data"}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/embedded"},{"label":"Gets the current order embedded payment for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentembeddedpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentembeddedpayment","metadata":{"seo":{"title":"Gets the current order embedded payment for an in progress order base","description":"The payment considered current is the most recently created order embedded payment for the in progress order base"}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/embedded/current"},{"label":"Creates an order redirect payment for an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createredirectpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createredirectpayment","metadata":{"seo":{"title":"Creates an order redirect payment for an in progress order base","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/redirect"},{"label":"Gets the current order redirect payment for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentredirectpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_getcurrentredirectpayment","metadata":{"seo":{"title":"Gets the current order redirect payment for an in progress order base","description":"The payment considered current is the most recently created order redirect payment for the in progress order base"}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/redirect/current"},{"label":"Creates an order payment card payment and completes the in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createpaymentcardpayment","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiorderpayments_createpaymentcardpayment","metadata":{"seo":{"title":"Creates an order payment card payment and completes the in progress tab order","description":"The order must have an assigned in progress tab order PaymentCard and an unpaid balancein order to create an order payment card payment"}},"httpPath":"/ocapi/v1/orders/{orderId}/payments/payment-card"},{"label":"Gets the web payment method options for an in progress order base, based on the provided order type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapiwebpaymentmethods_getwebpaymentmethods","routeSlug":"/openapi/digital-platform/openapi/payments/ocapiwebpaymentmethods_getwebpaymentmethods","metadata":{"seo":{"title":"Gets the web payment method options for an in progress order base, based on the provided order type","description":"Licenses Required"}},"httpPath":"/ocapi/v1/web-payment-methods"},{"label":"Set the primary member payment card for the currently authenticated member","deprecated":true,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_setprimarymemberpaymentcard","routeSlug":"/openapi/digital-platform/openapi/payments/ocapimemberpaymentcards_setprimarymemberpaymentcard","metadata":{"seo":{"title":"Set the primary member payment card for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/payment-cards/primary"}]},{"type":"group","label":"Member Rewards","link":"/openapi/digital-platform/openapi/member-rewards","routeSlug":"/openapi/digital-platform/openapi/member-rewards","items":[{"label":"Gets the list of member reward entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewards","routeSlug":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewards","metadata":{"seo":{"title":"Gets the list of member reward entities for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/rewards"},{"label":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","routeSlug":"/openapi/digital-platform/openapi/member-rewards/ocapimemberrewards_getmemberrewardavailabilitiesforshowtime","metadata":{"seo":{"title":"Gets the list of member reward availability entities for the currently authenticated\r\nmember and a particular showtime","description":"member reward availability entities are returned only for reward entities wherereward Restrictions includes reward restriction MemberRewardAvailability"}},"httpPath":"/ocapi/v1/members/current/reward-availability/by-showtime/{showtimeId}"}]},{"type":"group","label":"Subscriptions","link":"/openapi/digital-platform/openapi/subscriptions","routeSlug":"/openapi/digital-platform/openapi/subscriptions","items":[{"label":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setvistaassubscriptionpaymentprovider","metadata":{"seo":{"title":"Sets Vista as the payment provider for the member subscription belonging to the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/subscriptions/current/billing/payment-provider/vista"},{"label":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createrecurringsubscriptionembeddedpaymentcard","metadata":{"seo":{"title":"Loads and initiates the creation or selection of a member payment card using an embedded UI for\r\nthe current or future recurring member subscription of the currently authenticated member","description":"The member payment card will be used for recurring subscription billing."}},"httpPath":"/ocapi/v1/members/current/subscriptions/recurring/payment-card/embedded"},{"label":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_createfuturerecurringsubscriptionpaymentcard","metadata":{"seo":{"title":"Initiates creation of a future recurring member subscription and also loads and initiates the\r\ncreation or selection of a member payment card using an embedded UI for the future recurring\r\nmember subscription","description":"Upon creating or selecting the member payment card, the member's recurringmember subscriptions Future will be set."}},"httpPath":"/ocapi/v1/members/current/subscriptions/future-recurring/payment-card/embedded"},{"label":"Gets the status of a created future recurring member subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_getfuturerecurringsubscriptioncreation","metadata":{"seo":{"title":"Gets the status of a created future recurring member subscription","description":"This endpoint may be polled to determine the creation status of the future recurring subscription after creating a future recurring subscription payment card."}},"httpPath":"/ocapi/v1/members/current/subscriptions/future-recurring/creation"},{"label":"Cancels the current member subscription for the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_cancelsubscription","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_cancelsubscription","metadata":{"seo":{"title":"Cancels the current member subscription for the currently authenticated member","description":"Members may cancel their member subscription if:"}},"httpPath":"/ocapi/v1/members/current/subscriptions/current"},{"label":"Creates an in progress subscription order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapiorders_createsubscriptionorder","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapiorders_createsubscriptionorder","metadata":{"seo":{"title":"Creates an in progress subscription order","description":"If no subscription order action is provided, the subscription order Action will be defaulted to subscription order action Purchase"}},"httpPath":"/ocapi/v1/orders/subscription"},{"label":"Sets the subscription for an in progress subscription order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapiordersubscriptions_setsubscriptionfororder","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapiordersubscriptions_setsubscriptionfororder","metadata":{"seo":{"title":"Sets the subscription for an in progress subscription order","description":"This endpoint cannot be used for an in progress subscription order withsubscription order Action equal to subscription order action Reactivate"}},"httpPath":"/ocapi/v1/orders/{orderId}/subscription"},{"label":"Gets a list of subscription billing options and related data from active subscriptions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapisubscriptionbillingoptions_getsubscriptionbillingoptions","metadata":{"seo":{"title":"Gets a list of subscription billing options and related data from active subscriptions","description":"Billing options of inactive subscriptions are not returned, as they can not be purchased."}},"httpPath":"/ocapi/v1/subscription-billing-options"},{"label":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setfuturerecurringsubscription","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_setfuturerecurringsubscription","metadata":{"seo":{"title":"Sets the member subscriptions Future recurring subscription billing option for the currently authenticated member","description":"Members may select a future recurring subscription billing option regardless of their member subscriptions Current subscription, allowing them tochange subscription or extend existing."}},"httpPath":"/ocapi/v1/members/current/subscriptions/future-recurring"},{"label":"Reactivates the current member subscription for the currently authenticated member","deprecated":true,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_reactivatesubscription","routeSlug":"/openapi/digital-platform/openapi/subscriptions/ocapimembersubscription_reactivatesubscription","metadata":{"seo":{"title":"Reactivates the current member subscription for the currently authenticated member","description":"Members may select to reactivate their member subscription after it has been frozen for payment failure.On reactivation this will deduct the money from the member's default member payment card"}},"httpPath":"/ocapi/v1/members/current/subscriptions/current/reactivate"}]},{"type":"group","label":"Ticket Redemption Cards","link":"/openapi/digital-platform/openapi/ticket-redemption-cards","routeSlug":"/openapi/digital-platform/openapi/ticket-redemption-cards","items":[{"label":"Gets the list of member ticket redemption card base entities for the currently authenticated member","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards","routeSlug":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapimemberticketredemptioncards_getmemberticketredemptioncards","metadata":{"seo":{"title":"Gets the list of member ticket redemption card base entities for the currently authenticated member","description":"Includes ticket redemption cards which have been shared to the member by their friends."}},"httpPath":"/ocapi/v1/members/current/ticket-redemption-cards"},{"label":"Adds a ticket redemption card to an in progress standard order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard","routeSlug":"/openapi/digital-platform/openapi/ticket-redemption-cards/ocapiorderticketredemptioncards_addticketredemptioncard","metadata":{"seo":{"title":"Adds a ticket redemption card to an in progress standard order","description":"This endpoint validates the provided third party member card credentials or member ticket redemption card baseand stores a successfully validated card against the order for later use."}},"httpPath":"/ocapi/v1/orders/{orderId}/ticket-redemption-cards"}]},{"type":"group","label":"Credentials","link":"/openapi/digital-platform/openapi/credentials","routeSlug":"/openapi/digital-platform/openapi/credentials","items":[{"label":"Updates the email address of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberemail","routeSlug":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberemail","metadata":{"seo":{"title":"Updates the email address of the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/credentials/email"},{"label":"Updates the password of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberpassword","routeSlug":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberpassword","metadata":{"seo":{"title":"Updates the password of the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/credentials/password"},{"label":"Updates the username of the currently authenticated member","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberusername","routeSlug":"/openapi/digital-platform/openapi/credentials/ocapimemberupdate_setmemberusername","metadata":{"seo":{"title":"Updates the username of the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/credentials/username"}]},{"type":"group","label":"Watched Films","link":"/openapi/digital-platform/openapi/watched-films","routeSlug":"/openapi/digital-platform/openapi/watched-films","items":[{"label":"Gets a list of member watched film entities for the currently authenticated member, and their related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms","routeSlug":"/openapi/digital-platform/openapi/watched-films/ocapimemberwatchedfilms_getmemberwatchedfilms","metadata":{"seo":{"title":"Gets a list of member watched film entities for the currently authenticated member, and their related data","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/watched-films"}]},{"type":"group","label":"Watchlist Films","link":"/openapi/digital-platform/openapi/watchlist-films","routeSlug":"/openapi/digital-platform/openapi/watchlist-films","items":[{"label":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms","routeSlug":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_getwatchlistfilms","metadata":{"seo":{"title":"Gets the list of member watchlist film entities for the currently authenticated member, and their related data","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/watchlist-films"},{"label":"Adds a member watchlist film for the currently authenticated member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm","routeSlug":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_addwatchlistfilm","metadata":{"seo":{"title":"Adds a member watchlist film for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/watchlist-films"},{"label":"Removes a member watchlist film for the currently authenticated member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm","routeSlug":"/openapi/digital-platform/openapi/watchlist-films/ocapimemberwatchlistfilms_removewatchlistfilm","metadata":{"seo":{"title":"Removes a member watchlist film for the currently authenticated member","description":"Licenses Required"}},"httpPath":"/ocapi/v1/members/current/watchlist-films/{filmId}"}]},{"type":"group","label":"Completion","link":"/openapi/digital-platform/openapi/completion","routeSlug":"/openapi/digital-platform/openapi/completion","items":[{"label":"Creates an order completion for an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_createordercompletion","routeSlug":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_createordercompletion","metadata":{"seo":{"title":"Creates an order completion for an in progress order base","description":"An order completion is automatically created upon completion of the following payment types:"}},"httpPath":"/ocapi/v1/orders/{orderId}/completion"},{"label":"Gets the order completion for an in progress order base","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_getordercompletion","routeSlug":"/openapi/digital-platform/openapi/completion/ocapiordercompletion_getordercompletion","metadata":{"seo":{"title":"Gets the order completion for an in progress order base","description":"This endpoint may be polled to determine when the order completion has been finished."}},"httpPath":"/ocapi/v1/orders/{orderId}/completion"}]},{"type":"group","label":"Gift shop","link":"/openapi/digital-platform/openapi/gift-shop","routeSlug":"/openapi/digital-platform/openapi/gift-shop","items":[{"label":"Creates an in progress gift shop order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/gift-shop/ocapiorders_creategiftshoporder","routeSlug":"/openapi/digital-platform/openapi/gift-shop/ocapiorders_creategiftshoporder","metadata":{"seo":{"title":"Creates an in progress gift shop order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/gift-shop"}]},{"type":"group","label":"Vouchers","link":"/openapi/digital-platform/openapi/vouchers","routeSlug":"/openapi/digital-platform/openapi/vouchers","items":[{"label":"Removes a voucher from an in progress order base","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_removevoucher","routeSlug":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_removevoucher","metadata":{"seo":{"title":"Removes a voucher from an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers/{voucherId}"},{"label":"Adds a voucher to an in progress order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_addvoucher","routeSlug":"/openapi/digital-platform/openapi/vouchers/ocapiordervouchers_addvoucher","metadata":{"seo":{"title":"Adds a voucher to an in progress order base","description":"This endpoint is not available for in progress tab order entities."}},"httpPath":"/ocapi/v1/orders/{orderId}/vouchers"}]},{"type":"group","label":"Refunds","link":"/openapi/digital-platform/openapi/refunds","routeSlug":"/openapi/digital-platform/openapi/refunds","items":[{"label":"Creates a full refund for a refundable completed order base","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/refunds/ocapirefunds_createfullorderrefund","routeSlug":"/openapi/digital-platform/openapi/refunds/ocapirefunds_createfullorderrefund","metadata":{"seo":{"title":"Creates a full refund for a refundable completed order base","description":"This endpoint can only be used for completed standard order entities."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/refunds/full"}]},{"type":"group","label":"Seating","link":"/openapi/digital-platform/openapi/seating","routeSlug":"/openapi/digital-platform/openapi/seating","items":[{"label":"Gets the seat availability for a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityforshowtime","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityforshowtime","metadata":{"seo":{"title":"Gets the seat availability for a showtime","description":"The response is output cached for a maximum duration depending on preview."}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seat-availability"},{"label":"Gets the seat availability for a showtime in the context of a standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityfororder","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatavailability_getseatavailabilityfororder","metadata":{"seo":{"title":"Gets the seat availability for a showtime in the context of a standard order","description":"Using this endpoint over GetSeatAvailabilityForShowtime enables order-specific seat availabilityinformation and the pre-blocking of social distance seats."}},"httpPath":"/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}/seat-availability"},{"label":"Gets a seat layout by its unique identifier","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayout","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayout","metadata":{"seo":{"title":"Gets a seat layout by its unique identifier","description":"Licenses Required"}},"httpPath":"/ocapi/v1/seat-layouts/{seatLayoutId}"},{"label":"Gets the in seat location tab availability for a seat within a showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapitablocationavailability_getinseatlocationtabavailability","routeSlug":"/openapi/digital-platform/openapi/seating/ocapitablocationavailability_getinseatlocationtabavailability","metadata":{"seo":{"title":"Gets the in seat location tab availability for a seat within a showtime","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seats/{seatId}/tab-availability"},{"label":"Gets the seat layout for a showtime","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayoutforshowtime","routeSlug":"/openapi/digital-platform/openapi/seating/ocapiseatlayout_getseatlayoutforshowtime","metadata":{"seo":{"title":"Gets the seat layout for a showtime","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/seat-layout"}]},{"type":"group","label":"Browsing","link":"/openapi/digital-platform/openapi/browsing","routeSlug":"/openapi/digital-platform/openapi/browsing","items":[{"label":"Gets the current list of showtime availability entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailabilities","routeSlug":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailabilities","metadata":{"seo":{"title":"Gets the current list of showtime availability entities","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/availability"},{"label":"Gets the current showtime availability of a particular showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailability","routeSlug":"/openapi/digital-platform/openapi/browsing/ocapishowtimeavailability_getshowtimeavailability","metadata":{"seo":{"title":"Gets the current showtime availability of a particular showtime","description":"Licenses Required"}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/availability"}]},{"type":"group","label":"Surveys","link":"/openapi/digital-platform/openapi/surveys","routeSlug":"/openapi/digital-platform/openapi/surveys","items":[{"label":"Gets the survey for a completed standard order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/surveys/ocapisurveys_getordersurvey","routeSlug":"/openapi/digital-platform/openapi/surveys/ocapisurveys_getordersurvey","metadata":{"seo":{"title":"Gets the survey for a completed standard order","description":"Only standard orders with a single showtime are applicable for a survey."}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey"},{"label":"Updates the survey responses for completed standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/surveys/ocapisurveys_setordersurveyresponses","routeSlug":"/openapi/digital-platform/openapi/surveys/ocapisurveys_setordersurveyresponses","metadata":{"seo":{"title":"Updates the survey responses for completed standard order","description":"Licenses Required"}},"httpPath":"/ocapi/v1/orders/completed/{orderId}/survey/responses"}]},{"type":"group","label":"Third-Party Member Schemes","link":"/openapi/digital-platform/openapi/third-party-member-schemes","routeSlug":"/openapi/digital-platform/openapi/third-party-member-schemes","items":[{"label":"Gets the list of third party member scheme entities for a specified site","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","routeSlug":"/openapi/digital-platform/openapi/third-party-member-schemes/ocapithirdpartymemberschemes_getthirdpartymemberschemesforsite","metadata":{"seo":{"title":"Gets the list of third party member scheme entities for a specified site","description":"This endpoint excludes any third-party member schemes that are validated against Vista Loyalty."}},"httpPath":"/ocapi/v1/sites/{siteId}/third-party-member-schemes"}]},{"type":"group","label":"Ticket Prices","link":"/openapi/digital-platform/openapi/ticket-prices","routeSlug":"/openapi/digital-platform/openapi/ticket-prices","items":[{"label":"Gets a list of tickets prices for a specified showtime","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/ticket-prices/ocapiticketprices_getticketpricesforshowtime","routeSlug":"/openapi/digital-platform/openapi/ticket-prices/ocapiticketprices_getticketpricesforshowtime","metadata":{"seo":{"title":"Gets a list of tickets prices for a specified showtime","description":"Returns a list of ticket price entities for a showtime with related data."}},"httpPath":"/ocapi/v1/showtimes/{showtimeId}/ticket-prices"}]},{"type":"group","label":"Tracking Events","link":"/openapi/digital-platform/openapi/tracking-events","routeSlug":"/openapi/digital-platform/openapi/tracking-events","items":[{"label":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent","routeSlug":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_getcompletedorderlinkopenedtrackingevent","metadata":{"seo":{"title":"Returns an HTTP status code that indicates whether a patron has opened a link on their own device to view a digital representation of their order","description":"This endpoint would be used by the Kiosk via short-polling to see if the order confirmation QR code has been scanned yet, so it knowswhen to auto-dismiss the prompt for the patron to scan the QR code."}},"httpPath":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}"},{"label":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent","routeSlug":"/openapi/digital-platform/openapi/tracking-events/ocapitrackingevents_setcompletedorderlinkopenedtrackingevent","metadata":{"seo":{"title":"Sets a tracking event to record that a patron has opened a link on their own device to view a digital representation of their order","description":"This endpoint would be used by the web or mobile app that is opened on the patron's device after they have scanned the order confirmationQR code on the Kiosk."}},"httpPath":"/ocapi/v1/tracking-events/completed-order-link-opened/{trackingId}"}]},{"type":"group","label":"Tips","link":"/openapi/digital-platform/openapi/tips","routeSlug":"/openapi/digital-platform/openapi/tips","items":[{"label":"Sets the tip for an in progress standard order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tips/ordertips_setordertip","routeSlug":"/openapi/digital-platform/openapi/tips/ordertips_setordertip","metadata":{"seo":{"title":"Sets the tip for an in progress standard order","description":"For in progress tab order entities, use AddOrderTip instead."}},"httpPath":"/ocapi/v1/orders/{orderId}/tip"},{"label":"Adds a tip to an in progress tab order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/digital-platform/openapi/tips/ordertips_addordertip","routeSlug":"/openapi/digital-platform/openapi/tips/ordertips_addordertip","metadata":{"seo":{"title":"Adds a tip to an in progress tab order","description":"For in progress standard order entities, use SetOrderTip instead."}},"httpPath":"/ocapi/v1/orders/{orderId}/tips"}]}]}]}