--- title: "Creates an in progress tab order" method: POST path: "/ocapi/v1/orders/tab" tags: ["Orders", "Sites", "Tabs"] --- # Creates an in progress tab order `POST /ocapi/v1/orders/tab` ## Request - Base URL: `https://developer.vista.co` (the document declares no server; this is the origin it was published from) - URL: `https://developer.vista.co/ocapi/v1/orders/tab` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) #### Licenses Required - Vista.Ocapi.ChecksAPI ## Headers - `Connect-Region-Code` string ## Request body - OcapiV1OrdersRequestsTabOrderCreate: Represents the details of a tab order to be created - `siteId` string, required: Gets the unique identifier of the site - `location` union, required: Represents the base properties required to create a tab order location base - OcapiV1OrdersTabsLocationsRequestsTabOrderDiningLocationCreate: Represents the properties required to create a tab order dining location - `type` 'InSeat' | 'DiningLocation', required: Represents the type of a tab order location base - `diningLocationId` string, required: Gets the unique identifier of the dining location base - OcapiV1OrdersTabsLocationsRequestsTabOrderInSeatLocationCreate: Represents the properties required to create a tab order in seat location - `type` 'InSeat' | 'DiningLocation', required: Represents the type of a tab order location base - `showtimeId` string, required: Gets the unique identifier of the showtime - `seatIds` string[], required: Gets the list of unique identifiers of the seat entities - `patronCount` integer, required: Gets the number of patrons ## Response `200` Success - OcapiV1OrdersInProgressOrdersInProgressTabOrderDetails: Represents an in progress tab order entity, and its related data - `order` OcapiV1OrdersInProgressOrdersInProgressTabOrder, required: Represents a tab order in an order status InProgress state - `id` string, required: Represents a tab order in an order status InProgress state - `isOpen` boolean, required: Gets a value indicating whether the tab is open at Cinema for ordering items - `accessCode` string, required: Gets the access code - `patronCount` integer, required: Gets the number of patrons - `location` union, required: Represents the base properties of the location of a tab order - OcapiV1OrdersTabsLocationsTabOrderDiningLocation: Represents a tab order location base for a dining location base - `type` 'InSeat' | 'DiningLocation', required: Represents the type of a tab order location base - `diningLocation` OcapiV1OrdersDiningLocationsOrderDiningLocation, required: Represents the details of a dining location base in the context of an order base - `diningLocationId` string, required: Gets the unique identifier of the dining location base - `type` 'Table' | 'Chair', required: Represents the type of a dining location base - `label` string, required: Gets the label/physical name of the dining location base - `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 - … - OcapiV1OrdersTabsLocationsTabOrderInSeatLocation: Represents a tab order location base for one or more seat entities - `type` 'InSeat' | 'DiningLocation', required: Represents the type of a tab order location base - `showtimeId` string, required: Gets the unique identifier of the showtime - `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 - … - `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 - `spendingLimits` OcapiV1OrdersTabsTabOrderSpendingLimits, required: Represents the spending limits for a tab order - `maximumTotalPriceIncludingTax` number, double, required: Gets the maximum total price including tax allowed for the tab order, if applicable - `maximumAddItemsPriceIncludingTax` number, double, required: Gets the maximum price including tax allowed for each add items request, if applicable - `paymentCard` OcapiV1OrdersPaymentsPaymentCardOrderPaymentCard: Represents a payment card assigned to an in progress tab order - `status` 'Pending' | 'Declined' | 'Approved', required: Represents the status of an order payment card - `cardDetails` OcapiV1OrdersPaymentsPaymentCardPaymentCardDetails: Represents the details of a credit, debit, or eftpos card used for a payment - `maskedCardNumber` string, required: Gets the masked card number - `type` string, nullable: Gets the card type - `expiryMonth` integer, nullable: Gets the card expiry month - `expiryYear` integer, nullable: Gets the card expiry year - `member` OcapiV1OrdersMembersOrderMember - `name` OcapiV1PersonName, required: 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 - `hash` string, required - `itemDeliveries` union[], required: Gets the list of order item delivery base entities for the tab 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 order base - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - 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 order base - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - OcapiV1OrdersItemsDeliveriesOrderItemDiningLocationDelivery: 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 order base - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - 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 order base - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - 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 order base - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - 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 order base - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - 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 order base - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemCounterPickup: Represents an order item counter pickup for a completed order base - `id` string, required: Gets the identifier that can be used to uniquely identify the delivery within the order base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemCustomLocationDelivery: Represents an order item custom location delivery for a completed order base - `id` string, required: Gets the identifier that can be used to uniquely identify the delivery within the order base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - `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' | 'DiningLocationDelivery' | '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 - … - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemDiningLocationDelivery: Represents an order item dining location delivery for a completed order base - `id` string, required: Gets the identifier that can be used to uniquely identify the delivery within the order base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - `diningLocation` OcapiV1OrdersDiningLocationsOrderDiningLocation, required: Represents the details of a dining location base in the context of an order base - `diningLocationId` string, required: Gets the unique identifier of the dining location base - `type` 'Table' | 'Chair', required: Represents the type of a dining location base - `label` string, required: Gets the label/physical name of the dining location base - `areaName` OcapiV1Translatable, required: Represents some customer-visible translatable Text in the default language, and a list of translation entities - … - `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 - … - `comment` string, nullable - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - `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 order base - `id` string, required: Gets the identifier that can be used to uniquely identify the delivery within the order base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | 'CustomLocationDelivery' | 'PostalDelivery', required: Represents the delivery method of an item base - OcapiV1OrdersItemsDeliveriesCompletedCompletedOrderItemInSeatDelivery: Represents an order item in seat delivery for a completed order base - `id` string, required: Gets the identifier that can be used to uniquely identify the delivery within the order base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - `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' | 'DiningLocationDelivery' | '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 order base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - `method` 'CounterPickup' | 'ServiceAreaPickup' | 'ElectronicDelivery' | 'InSeatDelivery' | 'DiningLocationDelivery' | '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 order base - `id` string, required: Gets the identifier that can be used to uniquely identify the delivery within the order base - `fee` OcapiV1OrdersItemsDeliveriesOrderItemDeliveryFeeLine: Represents a fee incurred by an order item delivery base - `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 - … - `refundStatus` 'NotRefunded' | 'Refunded', required: Represents the refund status of an order line - `refundAvailability` union, required: Represents the refund availability of an order line - … - `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' | 'DiningLocationDelivery' | '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 - `siteId` string, required: Gets the unique identifier of the site - `items` union[], required: Gets the list of order item line base entities - union: Represents the base properties of a collectable 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 a collectable 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 a collectable 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 a collectable 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 a collectable 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 - `type` 'Standard' | 'GiftShop' | 'Subscription' | 'Tab', 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 - `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 - `deals` OcapiV1OrdersDealsOrderDeal[], required: Represents a tab order in an order status InProgress state - `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 - `payments` union[], required: Represents a tab order in an order status InProgress state - 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' | 'PaymentCard', 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' | 'PaymentCard', 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' | 'PaymentCard', 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' | 'PaymentCard', 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' | 'PaymentCard', 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' | 'PaymentCard', 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 - `expiresAt` string, date-time, required: Represents a tab order in an order status InProgress state - `hasCustomer` boolean, required: Represents a tab order in an order status InProgress state - `tips` OcapiV1OrdersTipsOrderTip[], required: Gets the list of order tip entities - `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 a collectable 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 - `totalTip` 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 - `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 - `attributeIds` string[]: Gets the list of unique identifiers of the assigned attribute entities - `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 - … - `addressV2` OcapiV1BrowsingMasterDataSitesSiteAddressV2, required: 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 - … - `addressV2` OcapiV1BrowsingMasterDataSitesSiteAddressV2, required: 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 - `attributes` OcapiV1BrowsingMasterDataAttributesAttribute[]: Gets the list of related attribute 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 - `description` 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 - `importantMessage` 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 - `displayPriority` integer, required: Gets the display priority used for sorting - `isPromoted` boolean, required: Gets a value indicating whether the attribute should be displayed with prominence ## Other responses - `400`: Site does not exist. - `404`: Showtime or seat(s) do not exist. ## Changes - **2026-10-22** `c46f30854000`: 2 info - added the optional property `relatedData/allOf[subschema #1: OrderRelatedData]/attributes` to the response with the `200` status - added the optional property `relatedData/allOf[subschema #1: OrderRelatedData]/showtimes/items/attributeIds` to the response with the `200` status - **2026-10-09** `41415d239083`: 1 info - endpoint added [Operation history](https://skmtc.dev/vista/apis/vista-digital-platform/changes/ocapi/v1/orders/tab/post.md) --- [API](https://skmtc.dev/vista/apis/vista-digital-platform.md) - [All operations](https://skmtc.dev/vista/apis/vista-digital-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/vista/apis/vista-digital-platform/revisions/c46f30854000?raw)