Creates a full refund for a refundable completed order base

Completed Order Assets

Operations

Completed Orders

Operations

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

Creates a full refund for a refundable completed order base

Request

This endpoint can only be used for completed standard order entities.

A refundable completed order base can only be fully refunded when order refund availability AvailableMethods includes order refund method Full

Booking fees may or may not be refunded, as indicated by order refund availability IsBookingFeeRefundable

Licenses Required

Vista.Ocapi

Path

orderIdstringrequired

The unique identifier of the refundable completed order base

Headers

Connect-Region-Codestring

Region Code

Body

required

The properties required to create the full refund

reasonstring or null

Gets the reason for the refund

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/completed/{orderId}/refunds/full' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "string"
  }'

Responses

Success

Bodyapplication/json

idstring or null

Gets the unique identifier

typestring(OrderType)required

Gets the type

Enum"Standard""GiftShop""Subscription"

statusstring(OrderStatus)required

Gets the status

Enum"InProgress""Completed"

totalPriceobject(MonetaryValue)required

Gets the total price to be displayed to the customer

totalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

totalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

totalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

originalPriceobject(MonetaryValue)required

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

originalPrice.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

originalPrice.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

originalPrice.taxnumber(double)read-onlyrequired

Gets the amount of tax

bookingobject(CompletedOrderBooking)

Gets the booking details

transactionobject(OrderTransaction)

Gets the transaction details, if applicable

vouchersArray of objects(OrderVoucher)required

Gets the list of order voucher entities

vouchers[].idstringnon-emptyrequired

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

vouchers[].typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"

vouchers[].maskedBarcodestringnon-emptyrequired

Gets a masked representation of the barcode

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

vouchers[].voucherTypeCodestringnon-emptyrequired

Gets the unique identifier of the voucher type

vouchers[].voucherTypeDescriptionobject(Translatable)

Gets the voucher type description text, and its translations

dealsArray of objects(OrderDeal)required

Gets the list of order deal entities

deals[].idstringnon-emptyread-onlyrequired

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

deals[].dealIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the deal base used

deals[].voucherIdstring or null

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

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

payments[].idstringnon-emptyrequired

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

payments[].typestring(OrderPaymentType)required

Gets the type

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

payments[].valuenumber(double)required

Gets the monetary value

payments[].statusstring(OrderPaymentStatus)required

Gets the status

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

showtimesArray of objects(OrderShowtime)required

Gets the list of order showtime entities

showtimes[].showtimeIdstringnon-emptyread-onlyrequired

Gets the unique identifier of the showtime

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

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

Gets the type

Enum"Normal""Package"

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

Gets the list of order package ticket content ticket entities

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

Gets the unique identifier of the normal ticket type

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

Gets the admission status

Enum"NotAdmitted""Admitted"

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

Gets the list of order package ticket content item entities

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

Gets the unique identifier of the item base

showtimes[].tickets[].idstringnon-emptyrequired

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

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

Gets the collection status

Enum"NotCollected""Collected"

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

Gets the refund status

Enum"NotRefunded""Refunded"

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

Gets the unique identifier of the ticket type base

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

Gets the price to be displayed to the customer

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

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

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

Gets the booking fee incurred for the ticket, if applicable

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

Gets the unique identifier of the reward used, if applicable

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

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

showtimes[].tickets[].voucherIdstring or null

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

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

Gets the unique identifier of the discount used, if applicable

showtimes[].tickets[].dealIdstring or null

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

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

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

Gets a value indicating whether the order line can be refunded

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"

showtimes[].seatsArray of objects(OrderSeat)required

Gets the list of order seat entities

showtimes[].seats[].seatIdstringnon-emptyrequired

Gets the unique identifier of the seat

showtimes[].seats[].seatLabelstring or null

Gets the label/physical name of the seat

Example: "5"

showtimes[].seats[].rowLabelstringnon-emptyrequired

Gets the label/physical name of the row

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

Gets the area name text, and its translations

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

Gets the text in the default language

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

Gets the translations of the translatable Text in other languages

showtimes[].seats[].areaName.translations[].languageTagstringnon-emptyrequired

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

Example: "en-US"

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

Gets the translated text

showtimes[].seats[].areaCategoryIdstringnon-emptyrequired

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

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

Gets the seat position

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

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

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

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

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

showtimes[].seatSwapStatusobject(OrderShowtimeSeatSwapStatus)required

Gets the seat swap status

showtimes[].seatSwapStatus.isAvailablebooleanrequired

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

showtimes[].seatSwapStatus.unavailableReasonstring(OrderShowtimeSeatSwapUnavailableReason)required

Gets the reason the seats cannot be swapped

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

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

items[].modifierGroupsArray of objects(OrderItemModifierGroup)required

Gets the list of order item modifier group entities

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

Gets the unique identifier of the item modifier group

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

Gets the list of order item modifier entities

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

Gets the unique identifier of the item base

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

Gets the price to be displayed to the customer

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

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

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

items[].itemsArray of objects(OrderPackageItemContentItem)required

Gets the list of order package item content item base entities

items[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

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

Gets the item type

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

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

Gets the price to be displayed to the customer

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

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

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

items[].items[].parentSalesItemIdstring or null

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

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

Gets the list of order item modifier group entities

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

Gets the unique identifier of the item modifier group

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

Gets the list of order item modifier entities

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

Gets the unique identifier of the item base

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

Gets the price to be displayed to the customer

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

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

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

Gets the components of the recipe item

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

Gets the unique identifier of the item base

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

Gets the item type

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

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

Gets the price to be displayed to the customer

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

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

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

Gets the modification

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

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

Gets the list of order item modifier group entities

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

Gets the unique identifier of the item modifier group

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

Gets the list of order item modifier entities

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

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

items[].items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

items[].items[].commentstring or null

Gets the patron's comment, if applicable

items[].componentsArray of objects(OrderRecipeItemNormalComponent)required

Gets the components of the recipe item

items[].components[].itemIdstringnon-emptyrequired

Gets the unique identifier of the item base

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

Gets the item type

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

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

Gets the price to be displayed to the customer

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

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

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

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

Gets the modification

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

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

Gets the list of order item modifier group entities

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

Gets the unique identifier of the item modifier group

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

Gets the list of order item modifier entities

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

Gets the unique identifier of the item base

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

Gets the price to be displayed to the customer

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

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

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

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

items[].deliveryIdstringnon-emptyrequired

Gets the unique identifier of the order item delivery base

items[].commentstring or null

Gets the patron's comment, if applicable

items[].itemIdstringnon-emptyrequired

items[].idstringnon-emptyrequired

items[].typestring(ItemType)required

Represents the type of an item base entity

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

items[].priceobject(MonetaryValue)required

Represents a monetary value, and its related tax value

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

items[].amountSavedobject(MonetaryValue)required

Represents a monetary value, and its related tax value

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

Gets the monetary value including tax

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

Gets the monetary value excluding tax

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

Gets the amount of tax

items[].parentSalesItemIdstring or nullread-only

items[].collectionStatusstring(OrderLineCollectionStatus)required

Represents the collection status of an order line

Enum"NotCollected""Collected"

items[].refundStatusstring(OrderLineRefundStatus)required

Represents the refund status of an order line

Enum"NotRefunded""Refunded"

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

items[].refundAvailability.isAvailablebooleanread-onlyrequired

Gets a value indicating whether the order line can be refunded

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"

items[].rewardIdinteger or null(int32)

items[].discountIdstring or nullread-only

items[].dealIdstring or null

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

itemDeliveries[].idstringnon-emptyrequired

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

itemDeliveries[].methodstring(ItemDeliveryMethod)required

Gets the delivery method

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

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

ticketRedemptionCards[].typestring(TicketRedemptionCardType)required

Gets the type

Enum"MemberSubscriptionCard""ThirdPartyMemberCard"

ticketRedemptionCards[].idstring(uuid)required

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

ticketRedemptionCards[].subscriptionIdinteger(int32)required

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

ticketRedemptionCards[].maskedCardNumberstringnon-emptyrequired

Gets a masked representation of the card number

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

ticketRedemptionCards[].memberNameobject(PersonName)

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

siteIdstringnon-emptyrequired

Gets the unique identifier of the site

preparationobject(OrderPreparation)

Gets the preparation and collection details

amountSavedobject(MonetaryValue)required

Gets the monetary amount saved via discounted prices

amountSaved.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

amountSaved.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

amountSaved.taxnumber(double)read-onlyrequired

Gets the amount of tax

journeyReferencestring or null

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

tipobject(OrderTip)

Gets the tip

refundAvailabilityobject(OrderRefundAvailability)required

Gets the current refund availability

refundAvailability.isAvailablebooleanread-onlyrequired

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

refundAvailability.unavailableReasonstring(OrderRefundUnavailableReason)required

Gets the reason the refundable completed order base cannot be refunded

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

refundAvailability.availableMethodsArray of strings(OrderRefundMethod)required

Gets the list of available refund methods

Items Enum"Full""Partial"

refundAvailability.isBookingFeeRefundablebooleanrequired

Gets a value indicating whether the booking fee can be refunded

totalRefundedobject(MonetaryValue)required

Gets the total amount already refunded to the patron

totalRefunded.valueIncludingTaxnumber(double)read-onlyrequired

Gets the monetary value including tax

totalRefunded.valueExcludingTaxnumber(double)read-onlyrequired

Gets the monetary value excluding tax

totalRefunded.taxnumber(double)read-onlyrequired

Gets the amount of tax

expiresAtstring(date-time)required

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

parentOrderIdstring or null

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

createdAtstring(date-time)required

Gets the date and time that the order was completed

surveyStatusstring(CompletedOrderSurveyStatus)required

Gets the survey status

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

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

{
  "id": "string",
  "type": "Standard",
  "status": "InProgress",
  "totalPrice": {
    "valueIncludingTax": 0.1,
    "valueExcludingTax": 0.1,
    "tax": 0.1
  },
  "originalPrice": {
    "valueIncludingTax": 0.1,
    "valueExcludingTax": 0.1,
    "tax": 0.1
  },
  "booking": {
    "id": "string",
    "totalBookingFee": { … },
    "originalBookingFee": { … },
    "mode": "Paid"
  },
  "transaction": {
    "number": 0,
    "barcode": "T00210738425",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "vouchers": [
    { … }
  ],
  "deals": [
    { … }
  ],
  "payments": [
    { … }
  ],
  "showtimes": [
    { … }
  ],
  "items": [
    { … }
  ],
  "itemDeliveries": [
    { … }
  ],
  "ticketRedemptionCards": [
    { … }
  ],
  "siteId": "string",
  "preparation": {
    "collectionNumber": 0,
    "status": "NotStarted"
  },
  "amountSaved": {
    "valueIncludingTax": 0.1,
    "valueExcludingTax": 0.1,
    "tax": 0.1
  },
  "journeyReference": "string",
  "tip": {
    "id": "string",
    "amount": { … },
    "collectionStatus": "NotCollected",
    "refundStatus": "NotRefunded",
    "refundAvailability": { … }
  },
  "refundAvailability": {
    "isAvailable": true,
    "unavailableReason": "NotApplicable",
    "availableMethods": [ … ],
    "isBookingFeeRefundable": true
  },
  "totalRefunded": {
    "valueIncludingTax": 0.1,
    "valueExcludingTax": 0.1,
    "tax": 0.1
  },
  "expiresAt": "2019-08-24T14:15:22Z",
  "parentOrderId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "surveyStatus": "NotApplicable",
  "siteOrderLocationId": "string"
}

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

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

Creates a full refund for a refundable completed order base

Request

Licenses Required

Responses

Seating

Browsing

Sites

Surveys

Third-Party Member Schemes

Ticket Prices

Tracking Events

Tips