Gets the print streams of an uncollected completed order base that are compatible with the requested printer

Completed Order Assets

Operations

Completed Orders

Operations

Gets the completed standard order identifiers for a completed standard order via the completed standard order JourneyReference

Request

Gets a set of identifiers that can be used to call other OCAPI endpoints in a consistent manner.

Licenses Required

Vista.Ocapi

Path

journeyReferencestringrequired

External identifier of completed standard order

Headers

Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json

orderIdstringnon-emptyrequired

journeyReferencestringnon-emptyrequired

siteIdstringnon-emptyrequired

bookingIdstringnon-emptyrequired

transactionNumberinteger or null(int32)

Response

application/json

{
  "orderId": "string",
  "journeyReference": "string",
  "siteId": "string",
  "bookingId": "string",
  "transactionNumber": 0
}

Gets the print streams of an uncollected completed order base that are compatible with the requested printer

Request

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the completed order base being retrieved

Query

printTemplateNamestringrequired

The name of the print templates to generate the print streams with

languageTagstring

The IETF (RFC 4646) language tag representing the desired language that the print streams will be generated in. If not supplied, the default language configured at cinema will be used

Headers

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/print-streams?printTemplateName=string&languageTag=string' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

itemCollectionVouchersArray of stringsrequired

Gets the printable item collection vouchers

ticketsArray of stringsrequired

Gets the printable tickets

orderReceiptsArray of stringsrequired

Gets the printable order receipts

Response

application/json

{
  "itemCollectionVouchers": [
    "string"
  ],
  "tickets": [
    "string"
  ],
  "orderReceipts": [
    "string"
  ]
}

Sets the order line collection status of all lines in a completed standard order to order line collection status Collected

Request

Calling this endpoint confirms that all completed order print streams have been printed and will prevent any further calls to GetPrintStreams.

This endpoint will also start the preparation of any items in a completed standard order, so a further call to StartOrderPreparation is not necessary. The completed order print streams ItemCollectionVouchers will contain relevant collection details.

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the completed standard order being retrieved

Headers

Connect-Region-Codestring

Region Code

Body

The additional request options

includeChildOrdersboolean

Gets a value indicating whether to include all linked completed standard order entities of type linked completed standard order relationship Child in the request

curl -i -X PUT \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/collection-status/collected' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "includeChildOrders": true
  }'

Responses

Success

Bodyapplication/json

orderobject(CompletedStandardOrder)required

Gets the completed order base entity

order.idstring or null

Gets the unique identifier

order.typestring(OrderType)required

Gets the type

Enum"Standard""GiftShop""Subscription"

order.statusstring(OrderStatus)required

Gets the status

Enum"InProgress""Completed"

order.totalPriceobject(MonetaryValue)required

Gets the total price to be displayed to the customer

order.totalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.totalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.totalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.originalPriceobject(MonetaryValue)required

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

order.originalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.originalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.originalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.bookingobject(CompletedOrderBooking)

Gets the booking details

order.transactionobject(OrderTransaction)

Gets the transaction details, if applicable

order.vouchersArray of objects(OrderVoucher)required

Gets the list of order voucher entities

order.vouchers[].idstringnon-emptyrequired

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

order.vouchers[].typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"

order.vouchers[].maskedBarcodestringnon-emptyrequired

Gets a masked representation of the barcode

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

order.vouchers[].voucherTypeCodestringnon-emptyrequired

Gets the unique identifier of the voucher type

order.vouchers[].voucherTypeDescriptionobject(Translatable)

Gets the voucher type description text, and its translations

order.dealsArray of objects(OrderDeal)required

Gets the list of order deal entities

order.deals[].idstringnon-emptyread-onlyrequired

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

order.deals[].dealIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the deal base used

order.deals[].voucherIdstring or null

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

order.paymentsArray of OrderRedirectPayment (object) or OrderMemberBalancePayment (object) or OrderGiftCardPayment (object) or OrderExternallyProcessedPayment (object) or OrderEmbeddedPayment (object) or OrderCinemaProcessedPayment (object)required

Gets the list of order payment base entities

One of:

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

order.payments[].idstringnon-emptyrequired

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

order.payments[].typestring(OrderPaymentType)required

Gets the type

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

order.payments[].valuenumber(double)required

Gets the monetary value

order.payments[].statusstring(OrderPaymentStatus)required

Gets the status

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

order.showtimesArray of objects(OrderShowtime)required

Gets the list of order showtime entities

order.showtimes[].showtimeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the showtime

order.showtimes[].ticketsArray of OrderTicketLineBase (object)required

Gets the list of order ticket line base entities

One of:

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

order.showtimes[].tickets[].typestring(TicketTypeType)required

Gets the type

Enum"Normal""Package"

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

Gets the list of order package ticket content ticket entities

order.showtimes[].tickets[].tickets[].ticketTypeIdstringnon-emptyrequired

Gets the unique identifier of the normal ticket type

order.showtimes[].tickets[].tickets[].admissionStatusstring(OrderTicketAdmissionStatus)required

Gets the admission status

Enum"NotAdmitted""Admitted"

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

Gets the list of order package ticket content item entities

order.showtimes[].tickets[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.showtimes[].tickets[].idstringnon-emptyrequired

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

order.showtimes[].tickets[].collectionStatusstring(OrderLineCollectionStatus)required

Gets the collection status

Enum"NotCollected""Collected"

order.showtimes[].tickets[].refundStatusstring(OrderLineRefundStatus)required

Gets the refund status

Enum"NotRefunded""Refunded"

order.showtimes[].tickets[].ticketTypeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the ticket type base

order.showtimes[].tickets[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.showtimes[].tickets[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.showtimes[].tickets[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.showtimes[].tickets[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.showtimes[].tickets[].amountSavedobject(MonetaryValue)required

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

order.showtimes[].tickets[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.showtimes[].tickets[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.showtimes[].tickets[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.showtimes[].tickets[].bookingFeeobject(OrderBookingFeeLine)

Gets the booking fee incurred for the ticket, if applicable

order.showtimes[].tickets[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward used, if applicable

order.showtimes[].tickets[].ticketRedemptionCardIdstring or null(uuid)

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

order.showtimes[].tickets[].voucherIdstring or null

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

order.showtimes[].tickets[].discountIdstring or nullread-only

Gets the unique identifier of the discount used, if applicable

order.showtimes[].tickets[].dealIdstring or null

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

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

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

order.showtimes[].tickets[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the order line can be refunded

order.showtimes[].tickets[].refundAvailability.unavailableReasonstring(OrderLineRefundUnavailableReason)required

Gets the reason the order line cannot be refunded

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

order.showtimes[].seatsArray of objects(OrderSeat)required

Gets the list of order seat entities

order.showtimes[].seats[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

order.showtimes[].seats[].seatLabelstring or null

Gets the label/physical name of the seat

Example: "5"

order.showtimes[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

order.showtimes[].seats[].areaNameobject(Translatable)required

Gets the area name text, and its translations

order.showtimes[].seats[].areaName.textstringnon-emptyrequired

Gets the text in the default language

order.showtimes[].seats[].areaName.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

order.showtimes[].seats[].areaCategoryIdstringnon-emptyrequired

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

order.showtimes[].seats[].positionobject(SeatPosition)required

Gets the seat position

order.showtimes[].seats[].position.areaNumberinteger(int32)required

Gets the number that can be used to uniquely identify the area within the seat layout

order.showtimes[].seats[].position.columnNumberinteger(int32)required

Gets the number that can be used to uniquely identify the column of the seat entity within the area

order.showtimes[].seats[].position.rowNumberinteger(int32)required

Gets the number that can be used to uniquely identify the row within the area

order.showtimes[].seatSwapStatusobject(OrderShowtimeSeatSwapStatus)required

Gets the seat swap status

order.showtimes[].seatSwapStatus.isAvailablebooleanrequired

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

order.showtimes[].seatSwapStatus.unavailableReasonstring(OrderShowtimeSeatSwapUnavailableReason)required

Gets the reason the seats cannot be swapped

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

order.itemsArray of OrderItemLineBase (object)required

Gets the list of order item line base entities

One of:

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

order.items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

order.items[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

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

Gets the list of order item modifier entities

order.items[].modifierGroups[].modifiers[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].modifierGroups[].modifiers[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.items[].modifierGroups[].modifiers[].amountSavedobject(MonetaryValue)required

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

order.items[].itemsArray of objects(OrderPackageItemContentItem)required

Gets the list of order package item content item base entities

order.items[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].items[].typestring(ItemType)required

Gets the item type

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

order.items[].items[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

order.items[].items[].amountSavedobject(MonetaryValue)required

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

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

order.items[].items[].parentSalesItemIdstring or null

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

order.items[].items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

order.items[].items[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

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

Gets the list of order item modifier entities

order.items[].items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

order.items[].items[].components[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].items[].components[].typestring(ItemType)required

Gets the item type

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

order.items[].items[].components[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.items[].items[].components[].amountSavedobject(MonetaryValue)required

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

order.items[].items[].components[].modificationstring(OrderRecipeItemComponentModification)required

Gets the modification

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

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

Gets the list of order item modifier group entities

order.items[].items[].components[].parentSalesItemIdstring or nullread-only

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

order.items[].items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

order.items[].items[].commentstring or null

Gets the patron's comment, if applicable

order.items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

order.items[].components[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

order.items[].components[].typestring(ItemType)required

Gets the item type

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

order.items[].components[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

order.items[].components[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].components[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].components[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].components[].amountSavedobject(MonetaryValue)required

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

order.items[].components[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.items[].components[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.items[].components[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.items[].components[].modificationstring(OrderRecipeItemComponentModification)required

Gets the modification

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

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

Gets the list of order item modifier group entities

order.items[].components[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

order.items[].components[].modifierGroups[].modifiersArray of objects(OrderItemModifier)required

Gets the list of order item modifier entities

order.items[].components[].parentSalesItemIdstring or nullread-only

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

order.items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

order.items[].commentstring or null

Gets the patron's comment, if applicable

order.items[].itemIdstringnon-emptyrequired

order.items[].idstringnon-emptyrequired

order.items[].typestring(ItemType)required

Represents the type of an item base entity

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

order.items[].priceobject(MonetaryValue)required

Represents a monetary value, and its related tax value

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

order.items[].amountSavedobject(MonetaryValue)required

Represents a monetary value, and its related tax value

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

order.items[].parentSalesItemIdstring or nullread-only

order.items[].collectionStatusstring(OrderLineCollectionStatus)required

Represents the collection status of an order line

Enum"NotCollected""Collected"

order.items[].refundStatusstring(OrderLineRefundStatus)required

Represents the refund status of an order line

Enum"NotRefunded""Refunded"

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

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

order.items[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the order line can be refunded

order.items[].refundAvailability.unavailableReasonstring(OrderLineRefundUnavailableReason)required

Gets the reason the order line cannot be refunded

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

order.items[].rewardIdinteger or null(int32)

order.items[].discountIdstring or nullread-only

order.items[].dealIdstring or null

order.itemDeliveriesArray of CompletedOrderItemCounterPickup (object) or CompletedOrderItemCustomLocationDelivery (object) or CompletedOrderItemElectronicDelivery (object) or CompletedOrderItemInSeatDelivery (object) or CompletedOrderItemPostalDelivery (object) or CompletedOrderItemServiceAreaPickup (object)required

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

One of:

Represents an order item counter pickup for a completed standard order

order.itemDeliveries[].idstringnon-emptyrequired

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

order.itemDeliveries[].methodstring(ItemDeliveryMethod)required

Gets the delivery method

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

order.ticketRedemptionCardsArray of TicketRedemptionCardBase (object)required

Gets the list of order ticket redemption card base entities

One of:

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

order.ticketRedemptionCards[].typestring(TicketRedemptionCardType)required

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"

order.ticketRedemptionCards[].idstring(uuid)required

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

order.ticketRedemptionCards[].subscriptionIdinteger(int32)required

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

order.ticketRedemptionCards[].maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

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

order.ticketRedemptionCards[].memberNameobject(PersonName)

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

order.siteIdstringnon-emptyrequired

Gets the unique identifier of the site

order.preparationobject(OrderPreparation)

Gets the preparation and collection details

order.amountSavedobject(MonetaryValue)required

Gets the monetary amount saved via discounted prices

order.amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.journeyReferencestring or null

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

order.tipobject(OrderTip)

Gets the tip

order.refundAvailabilityobject(OrderRefundAvailability)required

Gets the current refund availability

order.refundAvailability.isAvailablebooleanread-onlyrequired

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

order.refundAvailability.unavailableReasonstring(OrderRefundUnavailableReason)required

Gets the reason the refundable completed order base cannot be refunded

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

order.refundAvailability.availableMethodsArray of strings(OrderRefundMethod)required

Gets the list of available refund methods

Items Enum"Full""Partial"

order.refundAvailability.isBookingFeeRefundablebooleanrequired

Gets a value indicating whether the booking fee can be refunded

order.totalRefundedobject(MonetaryValue)required

Gets the total amount already refunded to the patron

order.totalRefunded.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.totalRefunded.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.totalRefunded.taxnumber(double)read-onlyrequired

Gets the amount of tax

order.expiresAtstring(date-time)required

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

order.parentOrderIdstring or null

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

order.createdAtstring(date-time)required

Gets the date and time that the order was completed

order.surveyStatusstring(CompletedOrderSurveyStatus)required

Gets the survey status

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

order.siteOrderLocationIdstring or null

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

relatedDataobject(OrderRelatedData)required

Gets the related data for the completed order base entity and any linked completed standard order entities

relatedData.filmsArray of objects(OrderRelatedFilm)required

Gets the list of related order related film entities

relatedData.films[].idstringnon-emptyrequired

relatedData.films[].titleobject(Translatable)required

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

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.films[].externalIdsobject(FilmExternalIds)required

Represents the external identifiers linked to a film

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

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].censorRatingIdstring or null

relatedData.films[].censorRatingNoteobject(Translatable)

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

relatedData.ticketTypesArray of objects(OrderRelatedTicketType)required

Gets the list of related order related ticket type entities

relatedData.ticketTypes[].idstringnon-emptyread-onlyrequired

relatedData.ticketTypes[].descriptionobject(Translatable)required

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

relatedData.ticketTypes[].description.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.ticketTypes[].longDescriptionobject(Translatable)required

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

relatedData.ticketTypes[].longDescription.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.itemsArray of objects(OrderRelatedItem)required

Gets the list of related order related item entities

relatedData.items[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.items[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.items[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.items[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.items[].hopkstring or null

Gets the Head Office primary key

relatedData.items[].isSundryboolean

Gets a value indicating whether this is a sundry item

relatedData.items[].isPreparationRequiredboolean

Gets a value indicating whether the item requires preparation

relatedData.showtimesArray of objects(OrderRelatedShowtime)required

Gets the list of related order related showtime entities

relatedData.showtimes[].idstringnon-emptyread-onlyrequired

relatedData.showtimes[].scheduleobject(ShowtimeSchedule)required

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

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

Gets the showtime entity's business date

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

Gets the date and time that the showtime starts

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

Gets the date and time that the showtime ends

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

Gets the date and time that the film screening starts

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

Gets the date and time that the film screening ends

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

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

relatedData.showtimes[].filmIdstringnon-emptyrequired

relatedData.showtimes[].siteIdstringnon-emptyrequired

relatedData.showtimes[].screenIdstringnon-emptyread-onlyrequired

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

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

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

Gets the list of phone number entities

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

Gets the type

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

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

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

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

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

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

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

Gets the list of allowed item delivery method entities

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

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.itemServiceAreasArray of objects(ItemServiceArea)required

Gets the list of related item service area entities

relatedData.itemServiceAreas[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemServiceAreas[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemServiceAreas[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.itemServiceAreas[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.itemServiceAreas[].shortName.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.itemShowtimeDeliveryWindowsArray of objects(ItemShowtimeDeliveryWindowBase)required

Gets the list of related item showtime delivery window base entities

relatedData.itemShowtimeDeliveryWindows[].minutesinteger(int32)required

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

relatedData.itemShowtimeDeliveryWindows[].typestring(ItemShowtimeDeliveryWindowType)required

Gets the type

Value"MinutesFromStart"

relatedData.itemShowtimeDeliveryWindows[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.itemShowtimeDeliveryWindows[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemShowtimeDeliveryWindows[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.subscriptionBillingOptionobject(OrderRelatedSubscriptionBillingOption)

Gets the related order related subscription billing option entity

relatedData.subscriptionobject(OrderRelatedSubscription)

Gets the related order related subscription entity

relatedData.balanceTypeobject(BalanceType)

Gets the related balance type entity, if applicable

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

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

relatedData.itemPostalDeliveryMethodsArray of objects(OrderRelatedItemPostalDeliveryMethod)required

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

relatedData.itemPostalDeliveryMethods[].isDefaultbooleanrequired

Gets a value indicating whether this is the default delivery method

relatedData.itemPostalDeliveryMethods[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemPostalDeliveryMethods[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemPostalDeliveryMethods[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

linkedOrdersArray of objects(LinkedCompletedStandardOrder)required

Gets the list of linked completed standard order entities

linkedOrders[].relationshipstring(LinkedCompletedStandardOrderRelationship)required

Gets the relationship of the linked completed standard order Order to the other completed standard order entity

Enum"Parent""Child""Sibling"

linkedOrders[].orderobject(CompletedStandardOrder)required

Gets the linked completed standard order entity

linkedOrders[].order.idstring or null

Gets the unique identifier

linkedOrders[].order.typestring(OrderType)required

Gets the type

Enum"Standard""GiftShop""Subscription"

linkedOrders[].order.statusstring(OrderStatus)required

Gets the status

Enum"InProgress""Completed"

linkedOrders[].order.totalPriceobject(MonetaryValue)required

Gets the total price to be displayed to the customer

linkedOrders[].order.totalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

linkedOrders[].order.totalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

linkedOrders[].order.totalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

linkedOrders[].order.originalPriceobject(MonetaryValue)required

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

linkedOrders[].order.originalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

linkedOrders[].order.originalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

linkedOrders[].order.originalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

linkedOrders[].order.bookingobject(CompletedOrderBooking)

Gets the booking details

linkedOrders[].order.transactionobject(OrderTransaction)

Gets the transaction details, if applicable

linkedOrders[].order.vouchersArray of objects(OrderVoucher)required

Gets the list of order voucher entities

linkedOrders[].order.vouchers[].idstringnon-emptyrequired

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

linkedOrders[].order.vouchers[].typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"

linkedOrders[].order.vouchers[].maskedBarcodestringnon-emptyrequired

Gets a masked representation of the barcode

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

linkedOrders[].order.vouchers[].voucherTypeCodestringnon-emptyrequired

Gets the unique identifier of the voucher type

linkedOrders[].order.vouchers[].voucherTypeDescriptionobject(Translatable)

Gets the voucher type description text, and its translations

linkedOrders[].order.dealsArray of objects(OrderDeal)required

Gets the list of order deal entities

linkedOrders[].order.deals[].idstringnon-emptyread-onlyrequired

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

linkedOrders[].order.deals[].dealIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the deal base used

linkedOrders[].order.deals[].voucherIdstring or null

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

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

Gets the list of order payment base entities

One of:

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

linkedOrders[].order.payments[].idstringnon-emptyrequired

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

linkedOrders[].order.payments[].typestring(OrderPaymentType)required

Gets the type

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

linkedOrders[].order.payments[].valuenumber(double)required

Gets the monetary value

linkedOrders[].order.payments[].statusstring(OrderPaymentStatus)required

Gets the status

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

linkedOrders[].order.showtimesArray of objects(OrderShowtime)required

Gets the list of order showtime entities

linkedOrders[].order.showtimes[].showtimeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the showtime

linkedOrders[].order.showtimes[].ticketsArray of OrderTicketLineBase (object)required

Gets the list of order ticket line base entities

One of:

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

linkedOrders[].order.showtimes[].tickets[].typestring(TicketTypeType)required

Gets the type

Enum"Normal""Package"

linkedOrders[].order.showtimes[].tickets[].ticketsArray of objects(OrderPackageTicketContentTicket)required

Gets the list of order package ticket content ticket entities

linkedOrders[].order.showtimes[].tickets[].itemsArray of objects(OrderPackageTicketContentItem)required

Gets the list of order package ticket content item entities

linkedOrders[].order.showtimes[].tickets[].idstringnon-emptyrequired

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

linkedOrders[].order.showtimes[].tickets[].collectionStatusstring(OrderLineCollectionStatus)required

Gets the collection status

Enum"NotCollected""Collected"

linkedOrders[].order.showtimes[].tickets[].refundStatusstring(OrderLineRefundStatus)required

Gets the refund status

Enum"NotRefunded""Refunded"

linkedOrders[].order.showtimes[].tickets[].ticketTypeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the ticket type base

linkedOrders[].order.showtimes[].tickets[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

linkedOrders[].order.showtimes[].tickets[].amountSavedobject(MonetaryValue)required

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

linkedOrders[].order.showtimes[].tickets[].bookingFeeobject(OrderBookingFeeLine)

Gets the booking fee incurred for the ticket, if applicable

linkedOrders[].order.showtimes[].tickets[].rewardIdinteger or null(int32)

Gets the unique identifier of the reward used, if applicable

linkedOrders[].order.showtimes[].tickets[].ticketRedemptionCardIdstring or null(uuid)

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

linkedOrders[].order.showtimes[].tickets[].voucherIdstring or null

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

linkedOrders[].order.showtimes[].tickets[].discountIdstring or nullread-only

Gets the unique identifier of the discount used, if applicable

linkedOrders[].order.showtimes[].tickets[].dealIdstring or null

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

linkedOrders[].order.showtimes[].tickets[].refundAvailabilityCompletedOrderLineRefundAvailability (object) or CompletedWeightBasedOrderLineRefundAvailability (object) or InProgressOrderLineRefundAvailability (object)required

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

linkedOrders[].order.showtimes[].seatsArray of objects(OrderSeat)required

Gets the list of order seat entities

linkedOrders[].order.showtimes[].seats[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

linkedOrders[].order.showtimes[].seats[].seatLabelstring or null

Gets the label/physical name of the seat

Example: "5"

linkedOrders[].order.showtimes[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

linkedOrders[].order.showtimes[].seats[].areaNameobject(Translatable)required

Gets the area name text, and its translations

linkedOrders[].order.showtimes[].seats[].areaCategoryIdstringnon-emptyrequired

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

linkedOrders[].order.showtimes[].seats[].positionobject(SeatPosition)required

Gets the seat position

linkedOrders[].order.showtimes[].seatSwapStatusobject(OrderShowtimeSeatSwapStatus)required

Gets the seat swap status

linkedOrders[].order.showtimes[].seatSwapStatus.isAvailablebooleanrequired

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

linkedOrders[].order.showtimes[].seatSwapStatus.unavailableReasonstring(OrderShowtimeSeatSwapUnavailableReason)required

Gets the reason the seats cannot be swapped

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

linkedOrders[].order.itemsArray of OrderItemLineBase (object)required

Gets the list of order item line base entities

One of:

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

linkedOrders[].order.items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

linkedOrders[].order.items[].modifierGroups[].itemModifierGroupIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the item modifier group

linkedOrders[].order.items[].modifierGroups[].modifiersArray of objects(OrderItemModifier)required

Gets the list of order item modifier entities

linkedOrders[].order.items[].itemsArray of objects(OrderPackageItemContentItem)required

Gets the list of order package item content item base entities

linkedOrders[].order.items[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

linkedOrders[].order.items[].items[].typestring(ItemType)required

Gets the item type

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

linkedOrders[].order.items[].items[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

linkedOrders[].order.items[].items[].amountSavedobject(MonetaryValue)required

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

linkedOrders[].order.items[].items[].parentSalesItemIdstring or null

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

linkedOrders[].order.items[].items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

linkedOrders[].order.items[].items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

linkedOrders[].order.items[].items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

linkedOrders[].order.items[].items[].commentstring or null

Gets the patron's comment, if applicable

linkedOrders[].order.items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

linkedOrders[].order.items[].components[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

linkedOrders[].order.items[].components[].typestring(ItemType)required

Gets the item type

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

linkedOrders[].order.items[].components[].priceobject(MonetaryValue)required

Gets the price to be displayed to the customer

linkedOrders[].order.items[].components[].amountSavedobject(MonetaryValue)required

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

linkedOrders[].order.items[].components[].modificationstring(OrderRecipeItemComponentModification)required

Gets the modification

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

linkedOrders[].order.items[].components[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

linkedOrders[].order.items[].components[].parentSalesItemIdstring or nullread-only

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

linkedOrders[].order.items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

linkedOrders[].order.items[].commentstring or null

Gets the patron's comment, if applicable

linkedOrders[].order.items[].itemIdstringnon-emptyrequired

linkedOrders[].order.items[].idstringnon-emptyrequired

linkedOrders[].order.items[].typestring(ItemType)required

Represents the type of an item base entity

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

linkedOrders[].order.items[].priceobject(MonetaryValue)required

Represents a monetary value, and its related tax value

linkedOrders[].order.items[].price.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

linkedOrders[].order.items[].price.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

linkedOrders[].order.items[].price.taxnumber(double)read-onlyrequired

Gets the amount of tax

linkedOrders[].order.items[].amountSavedobject(MonetaryValue)required

Represents a monetary value, and its related tax value

linkedOrders[].order.items[].amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

linkedOrders[].order.items[].amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

linkedOrders[].order.items[].amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

linkedOrders[].order.items[].parentSalesItemIdstring or nullread-only

linkedOrders[].order.items[].collectionStatusstring(OrderLineCollectionStatus)required

Represents the collection status of an order line

Enum"NotCollected""Collected"

linkedOrders[].order.items[].refundStatusstring(OrderLineRefundStatus)required

Represents the refund status of an order line

Enum"NotRefunded""Refunded"

linkedOrders[].order.items[].refundAvailabilityCompletedOrderLineRefundAvailability (object) or CompletedWeightBasedOrderLineRefundAvailability (object) or InProgressOrderLineRefundAvailability (object)required

Represents the refund availability of an order line

One of:

Represents the refund availability of an order line

linkedOrders[].order.items[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the order line can be refunded

linkedOrders[].order.items[].refundAvailability.unavailableReasonstring(OrderLineRefundUnavailableReason)required

Gets the reason the order line cannot be refunded

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

linkedOrders[].order.items[].rewardIdinteger or null(int32)

linkedOrders[].order.items[].discountIdstring or nullread-only

linkedOrders[].order.items[].dealIdstring or null

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

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

One of:

Represents an order item counter pickup for a completed standard order

linkedOrders[].order.itemDeliveries[].idstringnon-emptyrequired

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

linkedOrders[].order.itemDeliveries[].methodstring(ItemDeliveryMethod)required

Gets the delivery method

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

linkedOrders[].order.ticketRedemptionCardsArray of TicketRedemptionCardBase (object)required

Gets the list of order ticket redemption card base entities

One of:

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

linkedOrders[].order.ticketRedemptionCards[].typestring(TicketRedemptionCardType)required

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"

linkedOrders[].order.ticketRedemptionCards[].idstring(uuid)required

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

linkedOrders[].order.ticketRedemptionCards[].subscriptionIdinteger(int32)required

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

linkedOrders[].order.ticketRedemptionCards[].maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

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

linkedOrders[].order.ticketRedemptionCards[].memberNameobject(PersonName)

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

linkedOrders[].order.siteIdstringnon-emptyrequired

Gets the unique identifier of the site

linkedOrders[].order.preparationobject(OrderPreparation)

Gets the preparation and collection details

linkedOrders[].order.amountSavedobject(MonetaryValue)required

Gets the monetary amount saved via discounted prices

linkedOrders[].order.amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

linkedOrders[].order.amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

linkedOrders[].order.amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

linkedOrders[].order.journeyReferencestring or null

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

linkedOrders[].order.tipobject(OrderTip)

Gets the tip

linkedOrders[].order.refundAvailabilityobject(OrderRefundAvailability)required

Gets the current refund availability

linkedOrders[].order.refundAvailability.isAvailablebooleanread-onlyrequired

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

linkedOrders[].order.refundAvailability.unavailableReasonstring(OrderRefundUnavailableReason)required

Gets the reason the refundable completed order base cannot be refunded

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

linkedOrders[].order.refundAvailability.availableMethodsArray of strings(OrderRefundMethod)required

Gets the list of available refund methods

Items Enum"Full""Partial"

linkedOrders[].order.refundAvailability.isBookingFeeRefundablebooleanrequired

Gets a value indicating whether the booking fee can be refunded

linkedOrders[].order.totalRefundedobject(MonetaryValue)required

Gets the total amount already refunded to the patron

linkedOrders[].order.totalRefunded.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

linkedOrders[].order.totalRefunded.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

linkedOrders[].order.totalRefunded.taxnumber(double)read-onlyrequired

Gets the amount of tax

linkedOrders[].order.expiresAtstring(date-time)required

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

linkedOrders[].order.parentOrderIdstring or null

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

linkedOrders[].order.createdAtstring(date-time)required

Gets the date and time that the order was completed

linkedOrders[].order.surveyStatusstring(CompletedOrderSurveyStatus)required

Gets the survey status

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

linkedOrders[].order.siteOrderLocationIdstring or null

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

Response

application/json

{
  "order": {
    "id": "string",
    "type": "Standard",
    "status": "InProgress",
    "totalPrice": { … },
    "originalPrice": { … },
    "booking": { … },
    "transaction": { … },
    "vouchers": [ … ],
    "deals": [ … ],
    "payments": [ … ],
    "showtimes": [ … ],
    "items": [ … ],
    "itemDeliveries": [ … ],
    "ticketRedemptionCards": [ … ],
    "siteId": "string",
    "preparation": { … },
    "amountSaved": { … },
    "journeyReference": "string",
    "tip": { … },
    "refundAvailability": { … },
    "totalRefunded": { … },
    "expiresAt": "2019-08-24T14:15:22Z",
    "parentOrderId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "surveyStatus": "NotApplicable",
    "siteOrderLocationId": "string"
  },
  "relatedData": {
    "films": [ … ],
    "ticketTypes": [ … ],
    "items": [ … ],
    "showtimes": [ … ],
    "sites": [ … ],
    "screens": [ … ],
    "censorRatings": [ … ],
    "itemServiceAreas": [ … ],
    "itemShowtimeDeliveryWindows": [ … ],
    "subscriptionBillingOption": { … },
    "subscription": { … },
    "balanceType": { … },
    "areaCategories": [ … ],
    "itemPostalDeliveryMethods": [ … ]
  },
  "linkedOrders": [
    { … }
  ]
}

Orders

Operations

Seats

Operations

Discounts

Operations

Events

Operations

Showtimes

Operations

Films

Operations

Gift Cards

Operations

Items

Operations

Journeys

Operations

Third Party Passes

Operations

Loyalty

Operations

Authentication

Operations

Members

Operations

Member Completed Orders

Operations

Friends

Operations

Password Reset

Operations

Payments

Operations

Member Rewards

Operations

Subscriptions

Operations

Ticket Redemption Cards

Operations

Credentials

Operations

Watched Films

Operations

Watchlist Films

Operations

Completion

Operations

Gift shop

Operations

Vouchers

Operations

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations

Vista Digital Platform (V1)

Completed Order Assets

Completed Orders

Gets the completed standard order identifiers for a completed standard order via the completed standard order JourneyReference

Request

Licenses Required

Responses

Gets the print streams of an uncollected completed order base that are compatible with the requested printer

Request

Licenses Required

Responses

Sets the order line collection status of all lines in a completed standard order to order line collection status Collected

Request

Licenses Required

Responses

Orders

Seats

Discounts

Events

Showtimes

Films

Gift Cards

Items

Journeys

Third Party Passes

Loyalty

Authentication

Members

Member Completed Orders

Friends

Password Reset

Payments

Member Rewards

Subscriptions

Ticket Redemption Cards

Credentials

Watched Films

Watchlist Films

Completion

Gift shop

Vouchers

Refunds

Seating

Browsing

Sites

Surveys

Third-Party Member Schemes

Ticket Prices

Tracking Events

Tips