Vista Digital Platform (V1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://developer.vista.co/_mock/openapi/digital-platform/openapi

Completed Order Assets

Operations

Completed Orders

Operations

Orders

Operations

Creates an in progress standard order that is a child of a completed standard order

Request

This endpoint can only be used for completed standard order entities that are not children themselves.

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the completed standard order

Headers

Connect-Region-Codestring

Region Code

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/child-orders' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json

orderobject(InProgressStandardOrder)required

Gets the in progress 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.bookingobject(InProgressOrderBooking)required

Gets the booking details

order.booking.modestring(OrderBookingMode)required

Gets the order booking mode.

Enum"Paid""Unpaid""UnpaidConfirmed"

order.booking.totalBookingFeeobject(MonetaryValue)required

Gets the total booking fee amount the customer has currently paid.

order.booking.totalBookingFee.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

order.booking.totalBookingFee.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

order.booking.totalBookingFee.taxnumber(double)read-onlyrequired

Gets the amount of tax

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 OrderItemDeliveryBase (object) or CompletedOrderItemCounterPickup (object) or CompletedOrderItemCustomLocationDelivery (object) or CompletedOrderItemElectronicDelivery (object) or CompletedOrderItemInSeatDelivery (object) or CompletedOrderItemPostalDelivery (object) or CompletedOrderItemServiceAreaPickup (object)required

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

One of:

Represents an order item delivery base for items that can be picked up by the patron from the counter at any time, as they do not require preparation

order.itemDeliveries[].methodstring(ItemDeliveryMethod)required

Gets the delivery method

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

order.itemDeliveries[].idstringnon-emptyrequired

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

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.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.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.expiresAtstring(date-time)required

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

order.siteIdstringnon-emptyrequired

Gets the unique identifier of the site

order.hasCustomerbooleanrequired

Gets a value indicating whether the order customer has been set

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.tipobject(OrderTip)

Gets the tip

order.parentOrderIdstring or null

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

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 in progress order base entity

relatedData.filmsArray of objects(OrderRelatedFilm)required

Gets the list of related order related film entities

relatedData.films[].idstringnon-emptyrequired

relatedData.films[].titleobject(Translatable)required

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

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.films[].externalIdsobject(FilmExternalIds)required

Represents the external identifiers linked to a film

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

Gets the unique identifier of the linked movieXchange film release entity

relatedData.films[].externalIds.corporateIdstring or null

Gets the unique corporate identifier

relatedData.films[].censorRatingIdstring or null

relatedData.films[].censorRatingNoteobject(Translatable)

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

relatedData.ticketTypesArray of objects(OrderRelatedTicketType)required

Gets the list of related order related ticket type entities

relatedData.ticketTypes[].idstringnon-emptyread-onlyrequired

relatedData.ticketTypes[].descriptionobject(Translatable)required

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

relatedData.ticketTypes[].description.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.ticketTypes[].longDescriptionobject(Translatable)required

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

relatedData.ticketTypes[].longDescription.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.itemsArray of objects(OrderRelatedItem)required

Gets the list of related order related item entities

relatedData.items[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.items[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.items[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.items[].hoCodestringnon-emptyrequired

Gets the Head Office code

relatedData.items[].hopkstring or null

Gets the Head Office primary key

relatedData.items[].isSundryboolean

Gets a value indicating whether this is a sundry item

relatedData.items[].isPreparationRequiredboolean

Gets a value indicating whether the item requires preparation

relatedData.showtimesArray of objects(OrderRelatedShowtime)required

Gets the list of related order related showtime entities

relatedData.showtimes[].idstringnon-emptyread-onlyrequired

relatedData.showtimes[].scheduleobject(ShowtimeSchedule)required

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

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

Gets the showtime entity's business date

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

Gets the date and time that the showtime starts

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

Gets the date and time that the showtime ends

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

Gets the date and time that the film screening starts

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

Gets the date and time that the film screening ends

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

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

relatedData.showtimes[].filmIdstringnon-emptyrequired

relatedData.showtimes[].siteIdstringnon-emptyrequired

relatedData.showtimes[].screenIdstringnon-emptyread-onlyrequired

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

Gets the list of related site entities

One of:

Represents a site in Vista Loyalty

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

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

Gets the list of phone number entities

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

Gets the type

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

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

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

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

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

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

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

Gets the list of allowed item delivery method entities

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

relatedData.screensArray of objects(Screen)required

Gets the list of related screen entities

relatedData.screens[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.screens[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.screens[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.censorRatingsArray of objects(CensorRating)required

Gets the list of related censor rating entities

relatedData.censorRatings[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.censorRatings[].classificationobject(Translatable)required

Gets the classification text, and its translations

relatedData.censorRatings[].classification.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.censorRatings[].classificationDescriptionobject(Translatable)

Gets the censor rating Classification description text, and its translations

relatedData.censorRatings[].ageRestrictionobject(CensorRatingAgeRestriction)

Gets the age restriction, if applicable

relatedData.itemServiceAreasArray of objects(ItemServiceArea)required

Gets the list of related item service area entities

relatedData.itemServiceAreas[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemServiceAreas[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemServiceAreas[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.itemServiceAreas[].shortNameobject(Translatable)required

Gets the short name text, and its translations

relatedData.itemServiceAreas[].shortName.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.itemShowtimeDeliveryWindowsArray of objects(ItemShowtimeDeliveryWindowBase)required

Gets the list of related item showtime delivery window base entities

relatedData.itemShowtimeDeliveryWindows[].minutesinteger(int32)required

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

relatedData.itemShowtimeDeliveryWindows[].typestring(ItemShowtimeDeliveryWindowType)required

Gets the type

Value"MinutesFromStart"

relatedData.itemShowtimeDeliveryWindows[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.itemShowtimeDeliveryWindows[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemShowtimeDeliveryWindows[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.subscriptionBillingOptionobject(OrderRelatedSubscriptionBillingOption)

Gets the related order related subscription billing option entity

relatedData.subscriptionobject(OrderRelatedSubscription)

Gets the related order related subscription entity

relatedData.balanceTypeobject(BalanceType)

Gets the related balance type entity, if applicable

relatedData.areaCategoriesArray of objects(AreaCategory)required

Gets the list of related area category entities

relatedData.areaCategories[].idstringnon-emptyread-onlyrequired

Gets the unique identifier

relatedData.areaCategories[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.areaCategories[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

relatedData.areaCategories[].hopkstring or null

Gets the Head Office primary key

relatedData.areaCategories[].isAllocatedSeatingbooleanrequired

Gets a value indicating whether the seat entities are allocated

relatedData.areaCategories[].isInSeatItemDeliveryAvailablebooleanrequired

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

relatedData.itemPostalDeliveryMethodsArray of objects(OrderRelatedItemPostalDeliveryMethod)required

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

relatedData.itemPostalDeliveryMethods[].isDefaultbooleanrequired

Gets a value indicating whether this is the default delivery method

relatedData.itemPostalDeliveryMethods[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.itemPostalDeliveryMethods[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.itemPostalDeliveryMethods[].name.textstringnon-emptyrequired

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

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

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

Example: "en-US"

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

Gets the translated text

Response

application/json

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

Sets the customer for an in progress standard order or in progress gift shop order

Request

This endpoint is not available for in progress subscription order entities, as the order customer is automatically set based on the details of the authenticated member

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the in progress standard order or in progress gift shop order being modified

Headers

Connect-Region-Codestring

Region Code

Body

required

The customer's details

nameobject(PersonName)

Gets the name

emailstring[ 0 .. 255 ] charactersrequired

Gets the email address

phoneNumberstring or null[ 0 .. 25 ] characters

Gets the phone number

preferencesobject(OrderCustomerPreferences)

Gets the preferences

taxDetailsobject(OrderCustomerTaxDetails)

Gets the tax details

deliveryAddressobject(OrderCustomerAddress)

Gets the postal delivery address, if applicable

billingAddressobject(OrderCustomerAddress)

Gets the billing address, if applicable

curl -i -X PUT \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/customer' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": {
      "givenName": "string",
      "familyName": "string",
      "middleName": "string"
    },
    "email": "string",
    "phoneNumber": "string",
    "preferences": {
      "languageTag": "en-US"
    },
    "taxDetails": {
      "name": "string",
      "number": "string"
    },
    "deliveryAddress": {
      "name": {
        "givenName": "string",
        "familyName": "string",
        "middleName": "string"
      },
      "companyName": "string",
      "phoneNumber": "string",
      "line1": "string",
      "suburb": "string",
      "city": "string",
      "state": null,
      "postCode": "string",
      "country": "string"
    },
    "billingAddress": {
      "name": {
        "givenName": "string",
        "familyName": "string",
        "middleName": "string"
      },
      "companyName": "string",
      "phoneNumber": "string",
      "line1": "string",
      "suburb": "string",
      "city": "string",
      "state": null,
      "postCode": "string",
      "country": "string"
    }
  }'

Responses

Order customer updated.

Gets the customer set on an in progress order base

Request

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the in progress order base

Headers

Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json

nameobject(PersonName)

Gets the name, if known

emailstring[ 0 .. 255 ] charactersrequired

Gets the email address

phoneNumberstring or null[ 0 .. 25 ] characters

Gets the phone number, if known

preferencesobject(OrderCustomerPreferences)required

Gets the preferences

preferences.languageTagstring or null

Gets the IETF (RFC 4646) language tag

Example: "en-US"

taxDetailsobject(OrderCustomerTaxDetails)required

Gets the tax details

taxDetails.namestring or null

Gets the tax name, if known

taxDetails.numberstring or null

Gets the tax number, if known

deliveryAddressobject(OrderCustomerAddress)

Gets the postal delivery address, if applicable

billingAddressobject(OrderCustomerAddress)

Gets the billing address, if applicable

Response

application/json

{
  "name": {
    "givenName": "string",
    "familyName": "string",
    "middleName": "string"
  },
  "email": "string",
  "phoneNumber": "string",
  "preferences": {
    "languageTag": "en-US"
  },
  "taxDetails": {
    "name": "string",
    "number": "string"
  },
  "deliveryAddress": {
    "name": { … },
    "companyName": "string",
    "phoneNumber": "string",
    "line1": "string",
    "suburb": "string",
    "city": "string",
    "state": null,
    "postCode": "string",
    "country": "string"
  },
  "billingAddress": {
    "name": { … },
    "companyName": "string",
    "phoneNumber": "string",
    "line1": "string",
    "suburb": "string",
    "city": "string",
    "state": null,
    "postCode": "string",
    "country": "string"
  }
}

Removes an order payment base from an in progress order base

Request

Only order gift card payment and order member balance payment entities can be removed at this time.

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the in progress order base that the payment will be removed from

paymentIdstringrequired

The unique identifier of the order payment base to be removed

Headers

Connect-Region-Codestring

Region Code

curl -i -X DELETE \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/payments/{paymentId}' \
  -H 'Connect-Region-Code: string'

Responses

Payment removed.

Creates an in progress standard order as a booking

Request

Licenses Required

Vista.Ocapi

Headers

Connect-Region-Codestring

Region Code

Body

required

Details of the order to be created

siteIdstringnon-emptyrequired

Gets the unique identifier of the site

bookingModestring(OrderBookingMode)required

Gets the booking mode

Enum"Paid""Unpaid""UnpaidConfirmed"

siteOrderLocationIdstring or null

Gets the unique identifier of the site order location, if applicable.
If null, items will be ordered from the default site item profile

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/standard/booking \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": "string",
    "bookingMode": "Paid",
    "siteOrderLocationId": "string"
  }'