---
title: "Sets the requested tickets and/or seats for an order showtime within an in progress standard order"
method: PUT
path: "/ocapi/v1/orders/{orderId}/showtimes/{showtimeId}"
tags: ["Showtimes"]
---

# Sets the requested tickets and/or seats for an order showtime within an in progress standard order

`PUT /ocapi/v1/orders/{orderId}/showtimes/{showtimeId}`

This endpoint cannot be used for orders that have a parent order (see standard order ParentOrderId)

#### Specifying Tickets without Seats (Ticket-first Ordering)

- If session seat allocation is marked as *None*: Tickets will be booked without specific seats
- If session seat allocation is marked as *Manual*: Tickets will be booked. Seats will be auto-allocated if possible.
- If session seat allocation is marked as *Auto*: Tickets will be booked. Seats will be auto-allocated if possible.

#### Specifying Seats (Ticket-first and seat-first Ordering)

- If session seat allocation is marked as *None*: Specifying seats is invalid - a 400 will be returned.
- If session seat allocation is marked as *Manual*: Specified seats will be reserved if possible - otherwise a *SeatsUnavailable* error will be returned.
- If session seat allocation is marked as *Auto*: Specified seats will be reserved if possible - otherwise a *SeatsUnavailable* error will be returned.

#### Auto-Allocation

- The system may attempt to auto-allocate seats if specific seats are not supplied, depending on system configuration.
- The auto-allocation system is not guaranteed to allocate seats. Auto-allocation may fail if seats cannot be allocated contiguously.
- When allocation fails the client must render a seat plan and the seats must be manually specified.
- It is recommended the client render the seat plan regardless to provide the opportunity for the customer to modify the auto-allocated selections.
#### Licenses Required


- Vista.Ocapi

## Path parameters

- `orderId` string, required
- `showtimeId` string, required

## Headers

- `Connect-Region-Code` string

## Request body

- OcapiV1OrdersShowtimesRequestsOrderShowtimeRequest — Represents the requested tickets and/or seats for an order showtime
  - `tickets` OcapiV1OrdersTicketsRequestsOrderTicketRequest[], nullable — Gets the list of order ticket request entities
    - `id` string, nullable — Gets the identifier that can be used to uniquely identify the ticket within the order base
    - `ticketTypeId` string, required — Gets the unique identifier of the ticket type base
    - `rewardId` integer, nullable — Gets the unique identifier of the reward used, if applicable
    - `ticketRedemptionCardId` string, uuid, nullable — Gets the unique identifier of the order ticket redemption card base used, if applicable
    - `voucherId` string, nullable — Gets the unique identifier of the order voucher used, if applicable
    - `discountId` string, nullable — Gets the unique identifier of the discount used, if applicable
  - `seats` string[], nullable — Gets the list of unique identifiers of the requested seat entities

## Response `200`

Success

- OcapiV1OrdersInProgressOrdersInProgressStandardOrderDetails — Represents an in progress standard order entity, and its related data
  - `order` OcapiV1OrdersInProgressOrdersInProgressStandardOrder, required — Represents a standard order in an order status InProgress state
    - `id` string, nullable — Gets the unique identifier
    - `type` 'Standard' | 'GiftShop' | 'Subscription', required — Represents the type of an order base
    - `status` 'InProgress' | 'Completed', required — Represents the life-cycle stages of an order base
    - `totalPrice` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
      - `valueIncludingTax` number, double, required — Gets the monetary value including tax
      - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
      - `tax` number, double, required — Gets the amount of tax
    - `booking` OcapiV1OrdersBookingsInProgressOrderBooking, required
      - `mode` 'Paid' | 'Unpaid' | 'UnpaidConfirmed', required — Represents the mode of an order booking base
      - `totalBookingFee` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
        - `valueIncludingTax` number, double, required — Gets the monetary value including tax
        - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
        - `tax` number, double, required — Gets the amount of tax
    - `showtimes` OcapiV1OrdersShowtimesOrderShowtime[], required — Gets the list of order showtime entities
      - `showtimeId` string, required — Gets the unique identifier of the showtime
      - `tickets` union[], required — Gets the list of order ticket line base entities
        - union — Represents the base properties of an order line for an instance of a ticket type base within an order showtime
          - OcapiV1OrdersTicketsPackageOrderPackageTicketLine — Represents the base properties of an order line for an instance of a ticket type base within an order showtime
            - `id` string, required — Gets the identifier that can be used to uniquely identify the line within the order base
            - `collectionStatus` 'NotCollected' | 'Collected', required — Represents the collection status of an order line
            - `refundStatus` 'NotRefunded' | 'Refunded', required — Represents the refund status of an order line
            - `ticketTypeId` string, required — Gets the unique identifier of the ticket type base
            - `type` 'Normal' | 'Package', required — Represents the type of a ticket type base entity
            - `price` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
              - …
            - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
              - …
            - `bookingFee` OcapiV1OrdersTicketsOrderBookingFeeLine — Represents a booking fee incurred by an order ticket line base
              - …
            - `rewardId` integer, nullable — Gets the unique identifier of the reward used, if applicable
            - `ticketRedemptionCardId` string, uuid, nullable — Gets the unique identifier of the order ticket redemption card base used, if applicable
            - `voucherId` string, nullable — Gets the unique identifier of the order voucher used, if applicable
            - `discountId` string, nullable — Gets the unique identifier of the discount used, if applicable
            - `dealId` string, nullable — Gets the unique identifier of the order deal used, if applicable
            - `refundAvailability` union, required — Represents the refund availability of an order line
              - …
          - OcapiV1OrdersTicketsNormalOrderNormalTicketLine — Represents the base properties of an order line for an instance of a ticket type base within an order showtime
            - `id` string, required — Gets the identifier that can be used to uniquely identify the line within the order base
            - `collectionStatus` 'NotCollected' | 'Collected', required — Represents the collection status of an order line
            - `refundStatus` 'NotRefunded' | 'Refunded', required — Represents the refund status of an order line
            - `ticketTypeId` string, required — Gets the unique identifier of the ticket type base
            - `type` 'Normal' | 'Package', required — Represents the type of a ticket type base entity
            - `price` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
              - …
            - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
              - …
            - `bookingFee` OcapiV1OrdersTicketsOrderBookingFeeLine — Represents a booking fee incurred by an order ticket line base
              - …
            - `rewardId` integer, nullable — Gets the unique identifier of the reward used, if applicable
            - `ticketRedemptionCardId` string, uuid, nullable — Gets the unique identifier of the order ticket redemption card base used, if applicable
            - `voucherId` string, nullable — Gets the unique identifier of the order voucher used, if applicable
            - `discountId` string, nullable — Gets the unique identifier of the discount used, if applicable
            - `dealId` string, nullable — Gets the unique identifier of the order deal used, if applicable
            - `refundAvailability` union, required — Represents the refund availability of an order line
              - …
      - `seats` OcapiV1OrdersSeatsOrderSeat[], required — Gets the list of order seat entities
        - `seatId` string, required — Gets the unique identifier of the seat
        - `seatLabel` string, nullable — Gets the label/physical name of the seat
        - `rowLabel` string, required — Gets the label/physical name of the row
        - `areaName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
        - `areaCategoryId` string, required — Gets the unique identifier of the area category the seat belongs to
        - `position` OcapiV1SeatingMasterDataSeatPosition, required — Represents the position of a seat within the seat layout
          - `areaNumber` integer, required — Gets the number that can be used to uniquely identify the area within the seat layout
          - `columnNumber` integer, required — Gets the number that can be used to uniquely identify the column of the seat entity within the area
          - `rowNumber` integer, required — Gets the number that can be used to uniquely identify the row within the area
      - `seatSwapStatus` OcapiV1OrdersShowtimesOrderShowtimeSeatSwapStatus, required — Represents the status of the seat swap availability for an order showtime
        - `isAvailable` boolean, required — Gets a value indicating whether the order showtime Seats can be swapped
        - `unavailableReason` 'NotApplicable' | 'NotEnabled' | 'UnallocatedSeating' | 'NoSeats' | 'PackageTickets' | 'InSeatDeliveryItems' | 'OrderNotCompleted' | 'OrderRefunded' | 'UnpaidBooking' | 'ShowtimeEnded', required — Represents the reasons that seat swaps may be unavailable for an order showtime
    - `items` union[], required — Gets the list of order item line base entities
      - union — Represents the base properties of an order line for a top-level instance of an item base within a standard order or gift shop order
        - OcapiV1OrdersItemsOrderItemLine — Represents the base properties of an order line for a top-level instance of an item base within a standard order or gift shop order
          - `itemId` string, required
          - `id` string, required
          - `type` 'Normal' | 'ParentSales' | 'Package' | 'Recipe' | 'WeightBased', required — Represents the type of an item base entity
          - `price` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
            - `valueIncludingTax` number, double, required — Gets the monetary value including tax
            - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
            - `tax` number, double, required — Gets the amount of tax
          - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
            - `valueIncludingTax` number, double, required — Gets the monetary value including tax
            - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
            - `tax` number, double, required — Gets the amount of tax
          - `parentSalesItemId` string, nullable
          - `collectionStatus` 'NotCollected' | 'Collected', required — Represents the collection status of an order line
          - `refundStatus` 'NotRefunded' | 'Refunded', required — Represents the refund status of an order line
          - `refundAvailability` union, required — Represents the refund availability of an order line
            - OcapiV1OrdersRefundsCompletedOrderLineRefundAvailability — Represents the refund availability of an order line
              - …
            - OcapiV1OrdersRefundsCompletedWeightBasedOrderLineRefundAvailability — Represents the refund availability of an order line
              - …
            - OcapiV1OrdersRefundsInProgressOrderLineRefundAvailability — Represents the refund availability of an order line
              - …
          - `rewardId` integer, nullable
          - `discountId` string, nullable
          - `dealId` string, nullable
        - OcapiV1OrdersItemsOrderWeightBasedItemLine — Represents the base properties of an order line for a top-level instance of an item base within a standard order or gift shop order
          - `itemId` string, required
          - `id` string, required
          - `type` 'Normal' | 'ParentSales' | 'Package' | 'Recipe' | 'WeightBased', required — Represents the type of an item base entity
          - `price` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
            - `valueIncludingTax` number, double, required — Gets the monetary value including tax
            - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
            - `tax` number, double, required — Gets the amount of tax
          - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
            - `valueIncludingTax` number, double, required — Gets the monetary value including tax
            - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
            - `tax` number, double, required — Gets the amount of tax
          - `parentSalesItemId` string, nullable
          - `collectionStatus` 'NotCollected' | 'Collected', required — Represents the collection status of an order line
          - `refundStatus` 'NotRefunded' | 'Refunded', required — Represents the refund status of an order line
          - `refundAvailability` union, required — Represents the refund availability of an order line
            - OcapiV1OrdersRefundsCompletedOrderLineRefundAvailability — Represents the refund availability of an order line
              - …
            - OcapiV1OrdersRefundsCompletedWeightBasedOrderLineRefundAvailability — Represents the refund availability of an order line
              - …
            - OcapiV1OrdersRefundsInProgressOrderLineRefundAvailability — Represents the refund availability of an order line
              - …
          - `rewardId` integer, nullable
          - `discountId` string, nullable
          - `dealId` string, nullable
    - `itemDeliveries` union[], required — Gets the list of order item delivery base entities for the standard order Items
      - union — Represents the base properties of the delivery of one or more order item line base entities
        - OcapiV1OrdersItemsDeliveriesOrderItemCounterPickup — Represents the base properties of the delivery of one or more order item line base entities
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesOrderItemCustomLocationDelivery — Represents the base properties of the delivery of one or more order item line base entities
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesOrderItemElectronicDelivery — Represents the base properties of the delivery of one or more order item line base entities
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesOrderItemInSeatDelivery — Represents the base properties of the delivery of one or more order item line base entities
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesOrderItemPostalDelivery — Represents the base properties of the delivery of one or more order item line base entities
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesOrderItemServiceAreaPickup — Represents the base properties of the delivery of one or more order item line base entities
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemCounterPickup — Represents an order item counter pickup for a completed standard order
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemCustomLocationDelivery — Represents an order item custom location delivery for a completed standard order
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `locationName` string, required
          - `schedule` union, required — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleImmediate — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleOnRequest — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleShowtimeDeliveryWindow — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
          - `comment` string, nullable
          - `preparation` union, required — Represents the preparation details of a completed order item delivery base that requires preparation
            - OcapiV1OrdersItemsDeliveriesPreparationsCompletedOrderItemDeliveryPreparation — Represents the preparation details of a completed order item delivery base that requires preparation
              - …
            - OcapiV1OrdersItemsDeliveriesPreparationsCompletedOrderItemInSeatDeliveryPreparation — Represents a completed order item delivery preparation for an order item in seat delivery
              - …
            - OcapiV1OrdersItemsDeliveriesPreparationsCompletedOrderItemServiceAreaPickupPreparation — Represents a completed order item delivery preparation for an order item service area pickup
              - …
        - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemElectronicDelivery — Represents an order item electronic delivery for a completed standard order
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
        - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemInSeatDelivery — Represents an order item in seat delivery for a completed standard order
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `showtimeId` string, required — Gets the unique identifier of the showtime
          - `seats` OcapiV1OrdersSeatsOrderSeat[], required — Gets the list of order seat entities the items will be delivered to
            - `seatId` string, required — Gets the unique identifier of the seat
            - `seatLabel` string, nullable — Gets the label/physical name of the seat
            - `rowLabel` string, required — Gets the label/physical name of the row
            - `areaName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
              - …
            - `areaCategoryId` string, required — Gets the unique identifier of the area category the seat belongs to
            - `position` OcapiV1SeatingMasterDataSeatPosition, required — Represents the position of a seat within the seat layout
              - …
          - `schedule` union, required — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleImmediate — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleOnRequest — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleShowtimeDeliveryWindow — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
          - `comment` string, nullable
          - `preparation` OcapiV1OrdersItemsDeliveriesPreparationsCompletedOrderItemInSeatDeliveryPreparation, required — Represents a completed order item delivery preparation for an order item in seat delivery
            - `status` 'OnHold' | 'Requested' | 'InProgress' | 'Ready' | 'Delivered' | 'Cancelled', required — Represents the status of a completed order item delivery preparation
            - `availableAt` string, date-time, required — Gets the earliest date and time that preparation is available, i.e. when item preparation can be started
            - `unavailableAt` string, date-time, required — Gets the date and time when in-seat item delivery is no longer available, i.e. when item preparation must be completed by
        - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemPostalDelivery — Represents an order item delivery base for items that are delivered to a postal address
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery' — Represents the delivery method of an item base
          - `postalDeliveryMethodId` string, required — Gets the unique identifier of the item postal delivery method
          - `deliveryFee` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
            - `valueIncludingTax` number, double, required — Gets the monetary value including tax
            - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
            - `tax` number, double, required — Gets the amount of tax
        - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemServiceAreaPickup — Represents an order item service area pickup for a completed standard order
          - `id` string, required — Gets the identifier that can be used to uniquely identify the delivery within the standard order
          - `schedule` union, required — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleImmediate — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleOnRequest — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
            - OcapiV1OrdersItemsDeliveriesSchedulesOrderItemDeliveryScheduleShowtimeDeliveryWindow — Represents the base properties of a schedule that determines when an order item delivery base should be delivered or ready for pickup
              - …
          - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required — Represents the delivery method of an item base
          - `comment` string, nullable — Gets the patron's comment, if applicable
          - `serviceAreaIds` string[], required — Gets the list of unique identifiers of the item service area entities
          - `preparation` OcapiV1OrdersItemsDeliveriesPreparationsCompletedOrderItemServiceAreaPickupPreparation, required — Represents a completed order item delivery preparation for an order item service area pickup
            - `status` 'OnHold' | 'Requested' | 'InProgress' | 'Ready' | 'Delivered' | 'Cancelled', required — Represents the status of a completed order item delivery preparation
            - `pickupNumber` integer, nullable — Gets the pickup number, if applicable
            - `availableAt` string, date-time, required — Gets the earliest date and time that preparation is available, i.e. when item preparation can be started
    - `payments` union[], required — Gets the list of order payment base entities
      - union — Represents the base properties of a payment that has been added to an order base
        - OcapiV1OrdersPaymentsRedirectOrderRedirectPayment — Represents a redirect payment that has been added to an order base
          - `id` string, required — Gets the identifier that can be used to uniquely identify the payment within the order base
          - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed', required — Represents the type of an order payment base
          - `value` number, double, required — Gets the monetary value
          - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required — Represents the status of an order payment base
        - OcapiV1OrdersPaymentsMemberBalanceOrderMemberBalancePayment — Represents a member balance payment that has been added to an order base
          - `id` string, required — Gets the identifier that can be used to uniquely identify the payment within the order base
          - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed', required — Represents the type of an order payment base
          - `value` number, double, required — Gets the monetary value
          - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required — Represents the status of an order payment base
          - `balanceTypeId` integer, required — Gets the unique identifier of the balance type
          - `units` number, double, required — Gets the value in balance type units
        - OcapiV1OrdersPaymentsGiftCardsOrderGiftCardPayment — Represents a gift card payment that has been added to an order base
          - `id` string, required — Gets the identifier that can be used to uniquely identify the payment within the order base
          - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed', required — Represents the type of an order payment base
          - `maskedCardNumber` string, required — Gets a masked representation of the card number
          - `value` number, double, required — Gets the monetary value
          - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required — Represents the status of an order payment base
        - OcapiV1OrdersPaymentsExternallyProcessedOrderExternallyProcessedPayment — Represents an externally processed payment that has been added to an order base
          - `id` string, required — Gets the identifier that can be used to uniquely identify the payment within the order base
          - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required — Represents the status of an order payment base
          - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed', required — Represents the type of an order payment base
          - `value` number, double, required — Gets the monetary value
        - OcapiV1OrdersPaymentsEmbeddedOrderEmbeddedPayment — Represents an embedded payment that has been added to an order base
          - `id` string, required — Gets the identifier that can be used to uniquely identify the payment within the order base
          - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed', required — Represents the type of an order payment base
          - `value` number, double, required — Gets the monetary value
          - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required — Represents the status of an order payment base
        - OcapiV1OrdersPaymentsCinemaProcessedOrderCinemaProcessedPayment — Represents a cinema processed payment that has been added to an order base
          - `id` string, required — Gets the identifier that can be used to uniquely identify the payment within the order base
          - `type` 'CinemaProcessed' | 'Embedded' | 'GiftCard' | 'Redirect' | 'MemberBalance' | 'ExternallyProcessed', required — Represents the type of an order payment base
          - `value` number, double, required — Gets the monetary value
          - `status` 'NotStarted' | 'Pending' | 'Declined' | 'Completed', required — Represents the status of an order payment base
    - `vouchers` OcapiV1OrdersVouchersOrderVoucher[], required — Gets the list of order voucher entities
      - `id` string, required — Gets the identifier that can be used to uniquely identify the voucher within the order base
      - `type` 'Ticket' | 'Subscription' | 'Deal', required — Represents the type of a voucher
      - `maskedBarcode` string, required — Gets a masked representation of the barcode
      - `voucherTypeCode` string, required — Gets the unique identifier of the voucher type
      - `voucherTypeDescription` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
    - `deals` OcapiV1OrdersDealsOrderDeal[], required — Gets the list of order deal entities
      - `id` string, required — Gets the identifier that can be used to uniquely identify the deal within the order base
      - `dealId` string, required — Gets the unique identifier of the deal base used
      - `voucherId` string, nullable — Gets the unique identifier of the order voucher used, if applicable
    - `ticketRedemptionCards` union[], required — Gets the list of order ticket redemption card base entities
      - union — Represents the base properties of a ticket redemption card base that has been added to a standard order
        - OcapiV1OrdersTicketRedemptionCardsOrderMemberSubscriptionCard — Represents the base properties of a card that can be redeemed to purchase tickets
          - `type` 'MemberSubscriptionCard' | 'ThirdPartyMemberCard', required — Represents the type of a ticket redemption card base
          - `maskedCardNumber` string, required — Gets a masked representation of the card number
          - `memberName` OcapiV1PersonName — Represents the parts of a person's name
            - `givenName` string, nullable — Gets the given name
            - `familyName` string, nullable — Gets the family name
            - `middleName` string, nullable — Gets the middle or any additional name
        - OcapiV1OrdersTicketRedemptionCardsOrderThirdPartyMemberCard — Represents the base properties of a card that can be redeemed to purchase tickets
          - `type` 'MemberSubscriptionCard' | 'ThirdPartyMemberCard', required — Represents the type of a ticket redemption card base
          - `maskedCardNumber` string, required — Gets a masked representation of the card number
          - `memberName` OcapiV1PersonName — Represents the parts of a person's name
            - `givenName` string, nullable — Gets the given name
            - `familyName` string, nullable — Gets the family name
            - `middleName` string, nullable — Gets the middle or any additional name
    - `expiresAt` string, date-time, required — Gets the date and time that the order is set to expire
    - `siteId` string, required — Gets the unique identifier of the site
    - `hasCustomer` boolean, required — Gets a value indicating whether the order customer has been set
    - `amountSaved` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
      - `valueIncludingTax` number, double, required — Gets the monetary value including tax
      - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
      - `tax` number, double, required — Gets the amount of tax
    - `tip` OcapiV1OrdersTipsOrderTip — Represents the tip associated with a standard order
      - `id` string, required — Gets the identifier that can be used to uniquely identify the line within the order base
      - `amount` OcapiV1MonetaryValue, required — Represents a monetary value, and its related tax value
        - `valueIncludingTax` number, double, required — Gets the monetary value including tax
        - `valueExcludingTax` number, double, required — Gets the monetary value excluding tax
        - `tax` number, double, required — Gets the amount of tax
      - `collectionStatus` 'NotCollected' | 'Collected', required — Represents the collection status of an order line
      - `refundStatus` 'NotRefunded' | 'Refunded', required — Represents the refund status of an order line
      - `refundAvailability` union, required — Represents the refund availability of an order line
        - OcapiV1OrdersRefundsCompletedOrderLineRefundAvailability — Represents the refund availability of an order line
          - `isAvailable` boolean, required — Gets a value indicating whether the order line can be refunded
          - `unavailableReason` 'NotApplicable' | 'NotEnabled' | 'OrderNotCompleted' | 'AlreadyCollected' | 'AlreadyRefunded' | 'ItemDeliveryPreparationStarted' | 'ShowtimeRefundWindowEnded' | 'VoucherRedeemed' | 'RedeemableItemIssued' | 'OrderExpired' | 'WeightBasedItem', required — Represents the reasons that an order line cannot be refunded
        - OcapiV1OrdersRefundsCompletedWeightBasedOrderLineRefundAvailability — Represents the refund availability of an order line
          - `isAvailable` boolean, required
          - `unavailableReason` 'NotApplicable' | 'NotEnabled' | 'OrderNotCompleted' | 'AlreadyCollected' | 'AlreadyRefunded' | 'ItemDeliveryPreparationStarted' | 'ShowtimeRefundWindowEnded' | 'VoucherRedeemed' | 'RedeemableItemIssued' | 'OrderExpired' | 'WeightBasedItem', required — Represents the reasons that an order line cannot be refunded
        - OcapiV1OrdersRefundsInProgressOrderLineRefundAvailability — Represents the refund availability of an order line
          - `isAvailable` boolean, required — Gets a value indicating whether the order line can be refunded
          - `unavailableReason` 'NotApplicable' | 'NotEnabled' | 'OrderNotCompleted' | 'AlreadyCollected' | 'AlreadyRefunded' | 'ItemDeliveryPreparationStarted' | 'ShowtimeRefundWindowEnded' | 'VoucherRedeemed' | 'RedeemableItemIssued' | 'OrderExpired' | 'WeightBasedItem', required — Represents the reasons that an order line cannot be refunded
    - `parentOrderId` string, nullable — Gets the unique identifier of the linked parent completed standard order, if applicable
    - `siteOrderLocationId` string, nullable — Gets the unique identifier of the site order location, if applicable. <remarks><br> Will equal null if items are ordered from the default site item profile </remarks>
  - `relatedData` OcapiV1OrdersRelatedDataOrderRelatedData, required — Related data for an order base entity
    - `films` OcapiV1OrdersRelatedDataOrderRelatedFilm[], required — Gets the list of related order related film entities
      - `id` string, required
      - `title` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `externalIds` OcapiV1BrowsingMasterDataFilmsFilmExternalIds, required — Represents the external identifiers linked to a film
        - `moviexchangeReleaseId` string, uuid, nullable — Gets the unique identifier of the linked movieXchange film release entity
        - `corporateId` string, nullable — Gets the unique corporate identifier
      - `censorRatingId` string, nullable
      - `censorRatingNote` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
    - `ticketTypes` OcapiV1OrdersRelatedDataOrderRelatedTicketType[], required — Gets the list of related order related ticket type entities
      - `id` string, required
      - `description` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `longDescription` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
    - `items` OcapiV1OrdersRelatedDataOrderRelatedItem[], required — Gets the list of related order related item entities
      - `id` string, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `hoCode` string, required — Gets the Head Office code
      - `hopk` string, nullable — Gets the Head Office primary key
      - `isSundry` boolean — Gets a value indicating whether this is a sundry item
      - `isPreparationRequired` boolean — Gets a value indicating whether the item requires preparation
    - `showtimes` OcapiV1OrdersRelatedDataOrderRelatedShowtime[], required — Gets the list of related order related showtime entities
      - `id` string, required
      - `schedule` OcapiV1BrowsingMasterDataShowtimesShowtimeSchedule, required — Represents the dates and times relevant to a showtime, e.g. its start, end, film start, etc
        - `businessDate` string, date-time, required — Gets the showtime entity's business date
        - `startsAt` string, date-time, required — Gets the date and time that the showtime starts
        - `endsAt` string, date-time, required — Gets the date and time that the showtime ends
        - `filmStartsAt` string, date-time, required — Gets the date and time that the film screening starts
        - `filmEndsAt` string, date-time, required — Gets the date and time that the film screening ends
        - `inSeatItemDelivery` OcapiV1BrowsingMasterDataShowtimesShowtimeInSeatItemDeliverySchedule — Represents when in-seat item delivery is available for a showtime
          - `startsAt` string, date-time, required — Gets the date and time when in-seat item delivery becomes available
          - `endsAt` string, date-time, required — Gets the date and time when in-seat item delivery is no longer available
      - `filmId` string, required
      - `siteId` string, required
      - `screenId` string, required
    - `sites` union[], required — Gets the list of related site entities
      - union — Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities
        - OcapiV1LoyaltyMasterDataSitesLoyaltySite — Represents a site in Vista Loyalty
          - `location` OcapiV1GeographicLocation — Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a location on a map
            - `latitude` number, double, required — Gets the latitude (expressed in degrees and minutes)
            - `longitude` number, double, required — Gets the longitude (expressed in degrees and minutes)
          - `contactDetails` OcapiV1BrowsingMasterDataSitesSiteContactDetails, required — Represents the contact details of a site
            - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities
              - …
            - `email` string, nullable — Gets the email address
            - `address` OcapiV1BrowsingMasterDataSitesSiteAddress — Represents the physical address of a site
              - …
          - `ianaTimeZoneName` string, required — Gets the IANA time zone name
          - `id` string, required — Gets the unique identifier
          - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
            - `text` string, required — Gets the text in the default language
            - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
              - …
          - `hasSellableItems` boolean, required — Gets a value indicating whether the site has any sellable item entities
          - `allowedItemDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities
        - OcapiV1BrowsingMasterDataSitesSite — Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities
          - `id` string, required — Gets the unique identifier
          - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
            - `text` string, required — Gets the text in the default language
            - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
              - …
          - `location` OcapiV1GeographicLocation — Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a location on a map
            - `latitude` number, double, required — Gets the latitude (expressed in degrees and minutes)
            - `longitude` number, double, required — Gets the longitude (expressed in degrees and minutes)
          - `contactDetails` OcapiV1BrowsingMasterDataSitesSiteContactDetails, required — Represents the contact details of a site
            - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities
              - …
            - `email` string, nullable — Gets the email address
            - `address` OcapiV1BrowsingMasterDataSitesSiteAddress — Represents the physical address of a site
              - …
          - `ianaTimeZoneName` string, required — Gets the IANA time zone name
          - `hasSellableItems` boolean, required — Gets a value indicating whether the site has any sellable item entities
          - `allowedItemDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities
    - `screens` OcapiV1BrowsingMasterDataScreensScreen[], required — Gets the list of related screen entities
      - `id` string, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
    - `censorRatings` OcapiV1BrowsingMasterDataCensorRatingsCensorRating[], required — Gets the list of related censor rating entities
      - `id` string, required — Gets the unique identifier
      - `classification` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `classificationDescription` OcapiV1Translatable — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `ageRestriction` OcapiV1BrowsingMasterDataCensorRatingsCensorRatingAgeRestriction — Represents the age restriction of a censor rating
        - `minimumAge` integer, required — Gets the minimum age required
    - `itemServiceAreas` OcapiV1SalesMasterDataItemsItemServiceArea[], required — Gets the list of related item service area entities
      - `id` string, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `shortName` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
    - `itemShowtimeDeliveryWindows` OcapiV1SalesMasterDataItemsShowtimeDeliveryWindowsItemShowtimeDeliveryWindowMinutesFromStart[], required — Gets the list of related item showtime delivery window base entities
      - `id` string, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `type` 'MinutesFromStart', required — Represents the type of an item showtime delivery window base
    - `subscriptionBillingOption` OcapiV1OrdersRelatedDataOrderRelatedSubscriptionBillingOption
      - `id` string, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `subscriptionId` integer, required
      - `billingPeriodInMonths` integer, required
      - `isRecurring` boolean, required
    - `subscription` OcapiV1OrdersRelatedDataOrderRelatedSubscription — Represents the subscription data related to a subscription order
      - `id` integer, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
    - `balanceType` OcapiV1LoyaltyBalanceTypesBalanceType — Represents an account in Vista Loyalty that tracks the spending or activity of a member
      - `id` integer, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `isPrimary` boolean, required — Gets a value indicating whether this is the primary balance type
      - `unitName` string, nullable — Gets the name of the balance units
      - `paymentConversionRate` number, double, nullable — Gets the conversion rate that applies when using balance units for an order member balance payment, if applicable
      - `unitDecimalPlaces` integer, required — Gets the number of decimal places used to format and calculate balance unit values
    - `areaCategories` OcapiV1SeatingMasterDataAreaCategory[], required — Gets the list of related area category entities
      - `id` string, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text
      - `hopk` string, nullable — Gets the Head Office primary key
      - `isAllocatedSeating` boolean, required — Gets a value indicating whether the seat entities are allocated
      - `isInSeatItemDeliveryAvailable` boolean, required — Gets a value indicating whether in-seat item delivery is available for seats belonging to this area category
    - `itemPostalDeliveryMethods` OcapiV1OrdersRelatedDataOrderRelatedItemPostalDeliveryMethod[], required — Gets the list of related order related item postal delivery method entities
      - `isDefault` boolean, required — Gets a value indicating whether this is the default delivery method
      - `id` string, required — Gets the unique identifier
      - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
        - `text` string, required — Gets the text in the default language
        - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
          - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
          - `text` string, required — Gets the translated text

## Other responses

- `400` — Request property is invalid or missing, or invalid order type.
- `404` — Order or showtime does not exist.

---

[API](https://skmtc.net/vista/apis/vista-digital-platform.md) · [All operations](https://skmtc.net/vista/apis/vista-digital-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vista/vista-digital-platform/revisions/3a81c0aed14e/schema)