The unique identifier of the site
Vista Digital Platform (V1)
Download OpenAPI description
Languages
Servers
Mock server
https://developer.vista.co/_mock/openapi/digital-platform/openapi
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/item-availability
- cURL
- JavaScript
- Node.js
curl -i -X GET \
'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/item-availability' \
-H 'Connect-Region-Code: string'Success
Gets the list of item availability entities
Gets the related data for the item availability entities
Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities
One of:
Represents a site in Vista Loyalty
Gets the contact details
Gets the list of phone number entities
Gets the IANA time zone name
Example: "America/New_York"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets a value indicating whether the site has any sellable item entities
Response
application/json
{ "itemAvailabilities": [ { … } ], "siteId": "string", "relatedData": { "site": { … } } }
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/gift-shop/item-availability
- cURL
- JavaScript
- Node.js
curl -i -X GET \
https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/gift-shop/item-availability \
-H 'Connect-Region-Code: string'Response
application/json
- ItemAvailabilityListDetails
- SiteItemAvailabilityListDetails
{ "itemAvailabilities": [ { … } ] }
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/item-profile
- cURL
- JavaScript
- Node.js
curl -i -X GET \
'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/item-profile' \
-H 'Connect-Region-Code: string'Success
Gets the site item profile entity
Gets the list of item profile page entities
Gets the number that can be used to uniquely identify the page within the item profile
Gets the title text, and its translations
Gets the translations of the translatable Text in other languages
Gets the list of item profile button entities
Gets the unique identifier of the item base entity
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets a value indicating whether this is the default price
itemProfile.pages[].buttons[].prices[].restrictionsArray of strings(ItemPriceRestriction)required
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the title text, and its translations
Gets a value indicating whether this is the default item profile for the site
Gets the list of order tip option entities
Gets the amount to tip, as a percentage of the total cost of the standard order Items
Gets the list of item showtime delivery window base entities
Gets the targeted delivery time, as a number of minutes from showtime schedule StartsAt
Gets the type
Value"MinutesFromStart"
Gets the unique identifier
Gets the name text, and its translations
Gets the text in the default language
Gets the related data for the site item profile entity
Gets the list of related discount entities
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the restriction
Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the restrictions
Items Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the list of unique identifiers of the reward entities that the discount is restricted to
Gets the list of unique identifiers of the voucher types that the discount is restricted to
Gets the list of related item base entities
One of:
Represents an item base that is sold by weight, e.g. bulk candies
Represents the type of an item base entity
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the short name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the description text, and its translations
Gets the restrictions that apply
Items Enum"Member""AvailableHours"
Gets the unique identifier of the item class the item belongs to, if applicable
Gets a value indicating whether the item requires preparation
Gets the list of allowed item delivery method entities
Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Gets the unique identifier of the available hours entity
Gets the list of related item modifier group entities
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the short name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the prompt text, and its translations
Gets a value indicating the number of item modifier entities that can or must be added to a supported normal item
Gets a value indicating whether the quantity is unlimited
Gets the maximum quantity allowed
Gets a value indicating the number of item modifier entities that can be added to a supported normal item at no additional charge
Gets the list of item modifier entities
Gets the unique identifier of the item base entity
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets a value indicating whether this is the default price
relatedData.itemModifierGroups[].modifiers[].prices[].restrictionsArray of strings(ItemPriceRestriction)required
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the discount details
Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities
One of:
Represents a site in Vista Loyalty
Gets the contact details
Gets the list of phone number entities
Gets the IANA time zone name
Example: "America/New_York"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets a value indicating whether the site has any sellable item entities
Gets the list of related available hours entities
Gets the available hours for the days of the week
Gets the day of week
Enum"Sunday""Monday""Tuesday""Wednesday""Thursday""Friday""Saturday"
Response
application/json
{ "itemProfile": { "pages": [ … ], "siteId": "string", "isDefault": true, "orderTipOptions": [ … ], "itemShowtimeDeliveryWindows": [ … ], "siteOrderLocationId": "string" }, "relatedData": { "discounts": [ … ], "items": [ … ], "itemModifierGroups": [ … ], "site": { … }, "availableHours": [ … ] } }
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-profile
- cURL
- JavaScript
- Node.js
curl -i -X GET \
'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/order-locations/{siteOrderLocationId}/item-profile' \
-H 'Connect-Region-Code: string'Success
Gets the site item profile entity
Gets the list of item profile page entities
Gets the number that can be used to uniquely identify the page within the item profile
Gets the title text, and its translations
Gets the translations of the translatable Text in other languages
Gets the list of item profile button entities
Gets the unique identifier of the item base entity
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets a value indicating whether this is the default price
itemProfile.pages[].buttons[].prices[].restrictionsArray of strings(ItemPriceRestriction)required
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the title text, and its translations
Gets a value indicating whether this is the default item profile for the site
Gets the list of order tip option entities
Gets the amount to tip, as a percentage of the total cost of the standard order Items
Gets the list of item showtime delivery window base entities
Gets the targeted delivery time, as a number of minutes from showtime schedule StartsAt
Gets the type
Value"MinutesFromStart"
Gets the unique identifier
Gets the name text, and its translations
Gets the text in the default language
Gets the related data for the site item profile entity
Gets the list of related discount entities
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the restriction
Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the restrictions
Items Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the list of unique identifiers of the reward entities that the discount is restricted to
Gets the list of unique identifiers of the voucher types that the discount is restricted to
Gets the list of related item base entities
One of:
Represents an item base that is sold by weight, e.g. bulk candies
Represents the type of an item base entity
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the short name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the description text, and its translations
Gets the restrictions that apply
Items Enum"Member""AvailableHours"
Gets the unique identifier of the item class the item belongs to, if applicable
Gets a value indicating whether the item requires preparation
Gets the list of allowed item delivery method entities
Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Gets the unique identifier of the available hours entity
Gets the list of related item modifier group entities
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the short name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the prompt text, and its translations
Gets a value indicating the number of item modifier entities that can or must be added to a supported normal item
Gets a value indicating whether the quantity is unlimited
Gets the maximum quantity allowed
Gets a value indicating the number of item modifier entities that can be added to a supported normal item at no additional charge
Gets the list of item modifier entities
Gets the unique identifier of the item base entity
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets a value indicating whether this is the default price
relatedData.itemModifierGroups[].modifiers[].prices[].restrictionsArray of strings(ItemPriceRestriction)required
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the discount details
Represents a physical location that belongs to a cinema chain, consisting of one or more screen entities
One of:
Represents a site in Vista Loyalty
Gets the contact details
Gets the list of phone number entities
Gets the IANA time zone name
Example: "America/New_York"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets a value indicating whether the site has any sellable item entities
Gets the list of related available hours entities
Gets the available hours for the days of the week
Gets the day of week
Enum"Sunday""Monday""Tuesday""Wednesday""Thursday""Friday""Saturday"
Response
application/json
{ "itemProfile": { "pages": [ … ], "siteId": "string", "isDefault": true, "orderTipOptions": [ … ], "itemShowtimeDeliveryWindows": [ … ], "siteOrderLocationId": "string" }, "relatedData": { "discounts": [ … ], "items": [ … ], "itemModifierGroups": [ … ], "site": { … }, "availableHours": [ … ] } }
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}
- cURL
- JavaScript
- Node.js
curl -i -X GET \
'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/sites/{siteId}/sellable-items/by-hopk/{itemHopk}' \
-H 'Connect-Region-Code: string'Success
Represents the details of an item base entity that can be purchased directly
One of:
Represents the details of an item base entity that can be purchased directly
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets the monetary value including tax
Gets the monetary value excluding tax
Gets a value indicating whether this is the default price
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the related data for the sellable item entity
Represents the base properties of an item that is available for sale
One of:
Represents an item base that is sold by weight, e.g. bulk candies
Represents the type of an item base entity
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the short name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the restrictions that apply
Items Enum"Member""AvailableHours"
Gets the unique identifier of the item class the item belongs to, if applicable
Gets a value indicating whether the item requires preparation
Gets the list of allowed item delivery method entities
Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Gets the unique identifier of the available hours entity
Gets the list of related discount entities
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the restriction
Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the restrictions
Items Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the list of unique identifiers of the reward entities that the discount is restricted to
Gets the list of unique identifiers of the voucher types that the discount is restricted to
Gets the list of related item modifier group entities
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the short name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the prompt text, and its translations
Gets a value indicating the number of item modifier entities that can or must be added to a supported normal item
Gets a value indicating whether the quantity is unlimited
Gets the maximum quantity allowed
Gets a value indicating the number of item modifier entities that can be added to a supported normal item at no additional charge
Gets the list of item modifier entities
Gets the unique identifier of the item base entity
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets a value indicating whether this is the default price
relatedData.itemModifierGroups[].modifiers[].prices[].restrictionsArray of strings(ItemPriceRestriction)required
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the discount details
Response
application/json
{ "sellableItem": { "itemId": "string", "prices": [ … ] }, "relatedData": { "item": { … }, "discounts": [ … ], "itemModifierGroups": [ … ] } }
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/gift-shop/item-profile
- cURL
- JavaScript
- Node.js
curl -i -X GET \
https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/gift-shop/item-profile \
-H 'Connect-Region-Code: string'Success
Gets the gift shop item profile entity
Gets the list of item profile page entities
Gets the number that can be used to uniquely identify the page within the item profile
Gets the title text, and its translations
Gets the translations of the translatable Text in other languages
Gets the list of item profile button entities
Gets the unique identifier of the item base entity
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets a value indicating whether this is the default price
itemProfile.pages[].buttons[].prices[].restrictionsArray of strings(ItemPriceRestriction)required
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the title text, and its translations
Gets the list of related item postal delivery method entities
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets a value indicating whether this is the default delivery method
Related data for an item profile entity
One of:
Related data for an item profile entity
Gets the list of related discount entities
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the restriction
Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the restrictions
Items Enum"None""Multiple""MemberReward""Voucher""Availability"
Gets the list of unique identifiers of the reward entities that the discount is restricted to
Gets the list of unique identifiers of the voucher types that the discount is restricted to
Gets the list of related item base entities
One of:
Represents an item base that is sold by weight, e.g. bulk candies
Represents the type of an item base entity
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the short name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the description text, and its translations
Gets the restrictions that apply
Items Enum"Member""AvailableHours"
Gets the unique identifier of the item class the item belongs to, if applicable
Gets a value indicating whether the item requires preparation
Gets the list of allowed item delivery method entities
Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Gets the unique identifier of the available hours entity
Gets the list of related item modifier group entities
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the short name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the prompt text, and its translations
Gets a value indicating the number of item modifier entities that can or must be added to a supported normal item
Gets a value indicating whether the quantity is unlimited
Gets the maximum quantity allowed
Gets a value indicating the number of item modifier entities that can be added to a supported normal item at no additional charge
Gets the list of item modifier entities
Gets the unique identifier of the item base entity
Gets the list of item price entities
Gets the price to be displayed to the customer
Gets a value indicating whether this is the default price
relatedData.itemModifierGroups[].modifiers[].prices[].restrictionsArray of strings(ItemPriceRestriction)required
Gets the restrictions that apply
Items Enum"MemberReward""InheritedMemberReward""Discount""InheritedDiscount"
Gets the unique identifier of the reward that the price is restricted to
Gets the discount details
Response
application/json
{ "itemProfile": { "pages": [ … ], "itemPostalDeliveryMethods": [ … ] }, "relatedData": { "discounts": [ … ], "items": [ … ], "itemModifierGroups": [ … ] } }
Request
Existing items on the order will be replaced with the specified selections.
Note: Items with attached scarcity such as items with selling limits currently may fail on repeated PUT as this API is currently not fully atomic.
If the order contains showtimes (see standard order Showtimes), item availability will be based on the earliest showtime.
If the order has a parent order (see standard order ParentOrderId), item availability will be based on the the start time of the earliest showtime of the parent order.
- Vista.Ocapi
- application/json
- text/json
- application/*+json
- application/json-patch+json
The requested items
Gets the list of order item request base entities
One of:
Represents the base properties of a requested order item line base
Gets the identifier that can be used to uniquely identify the item within the order base
Gets the item type
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the unique identifier of the order item delivery create base, if applicable
Gets the unique identifier of the parent sales item this item is an option for
Gets the list of order item modifier group request entities
Gets the list of order package item content item request base entities that require customisation
Gets the list of order item delivery create base entities, if applicable
Gets the comment that applies to all order item delivery with comment entities (including any default deliveries)
- Mock serverhttps://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/items
- cURL
- JavaScript
- Node.js
- application/json
- text/json
- application/*+json
- application/json-patch+json
curl -i -X PUT \
'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/items' \
-H 'Connect-Region-Code: string' \
-H 'Content-Type: application/json' \
-d '{
"items": [
{
"id": "string",
"itemId": "string",
"type": "Normal",
"rewardId": 0,
"discountId": "string",
"deliveryId": "string",
"comment": "string",
"parentSalesItemId": "string",
"modifierGroups": [
{
"itemModifierGroupId": "string",
"modifiers": [
{
"itemId": "string"
}
]
}
],
"items": [
{
"itemId": "string",
"type": "Normal",
"parentSalesItemId": "string",
"modifierGroups": [
{
"itemModifierGroupId": "string",
"modifiers": [
null
]
}
],
"components": [
{
"itemId": "string",
"type": "Normal",
"parentSalesItemId": "string",
"modifierGroups": [
null
],
"modification": "None"
}
],
"deliveryId": "string",
"comment": "string"
}
],
"components": [
{
"itemId": "string",
"type": "Normal",
"parentSalesItemId": "string",
"modifierGroups": [
{
"itemModifierGroupId": "string",
"modifiers": [
null
]
}
],
"modification": "None"
}
]
}
],
"itemDeliveries": [
{
"locationName": "string",
"schedule": {
"type": "Immediate"
},
"comment": "string",
"id": "string",
"method": "CounterPickup"
}
],
"itemDeliveriesComment": "string",
"serviceAreaPickupSchedule": {
"type": "Immediate"
}
}'Order items
orderInProgressGiftShopOrder (object) or InProgressStandardOrder (object) or InProgressSubscriptionOrder (object)read-onlyrequired
Gets the in progress order base entity
One of:
Represents a gift shop order in an order status InProgress state
Gets the total price to be displayed to the customer
Gets the list of order voucher entities
Gets the identifier that can be used to uniquely identify the voucher within the order base
Gets a masked representation of the barcode
Example: "12.......6789"
Gets the unique identifier of the voucher type
Gets the list of order deal entities
Gets the identifier that can be used to uniquely identify the deal within the order base
Gets the unique identifier of the deal base used
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:
- OrderRedirectPayment
- OrderMemberBalancePayment
- OrderGiftCardPayment
- OrderExternallyProcessedPayment
- OrderEmbeddedPayment
- OrderCinemaProcessedPayment
Represents a redirect payment that has been added to an order base
Gets the identifier that can be used to uniquely identify the payment within the order base
Gets the type
Enum"CinemaProcessed""Embedded""GiftCard""Redirect""MemberBalance""ExternallyProcessed"
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
Gets the list of order item modifier group entities
Gets the unique identifier of the item modifier group
Gets the list of order item modifier entities
Gets the unique identifier of the item base
Gets the price to be displayed to the customer
Gets the list of order package item content item base entities
Gets the item type
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the price to be displayed to the customer
Gets the monetary value including tax
Gets the monetary value excluding tax
Gets the total amount saved on the item due to all discounts and deals
Gets the monetary value including tax
Gets the monetary value excluding tax
Gets the unique identifier of the parent sales item this item is an option for
Gets the list of order item modifier group entities
Gets the components of the recipe item
Gets the unique identifier of the item base
Gets the item type
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the price to be displayed to the customer
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"
Gets the unique identifier of the order item delivery base
Gets the components of the recipe item
Gets the unique identifier of the item base
Gets the item type
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Gets the price to be displayed to the customer
Gets the monetary value including tax
Gets the monetary value excluding tax
Gets the total amount saved on the item due to all discounts and deals
Gets the monetary value including tax
Gets the monetary value excluding tax
Gets the modification
Enum"None""Remove""Extra""OnTheSide""ExtraOnTheSide"
Gets the list of order item modifier group entities
Gets the unique identifier of the order item delivery base
Represents the type of an item base entity
Enum"Normal""ParentSales""Package""Recipe""WeightBased"
Represents a monetary value, and its related tax value
Represents a monetary value, and its related tax value
Gets the monetary value including tax
Gets the monetary value excluding tax
Represents the collection status of an order line
Enum"NotCollected""Collected"
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
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"
Gets the monetary amount saved via discounted prices
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 gift shop order Items
One of:
- OrderItemDeliveryBase
- OrderItemDeliveryBase
- OrderItemDeliveryBase
- OrderItemDeliveryBase
- OrderItemDeliveryBase
- OrderItemDeliveryBase
- CompletedOrderItemCounterPickup
- CompletedOrderItemCustomLocationDelivery
- CompletedOrderItemElectronicDelivery
- CompletedOrderItemInSeatDelivery
- CompletedOrderItemPostalDelivery
- CompletedOrderItemServiceAreaPickup
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
Gets the delivery method
Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"
Gets the total fee for the in progress gift shop order ItemDeliveries
Gets the monetary value including tax
Gets the monetary value excluding tax
Gets the related data for the in progress order base entity
Gets the list of related order related film entities
Represents some customer-visible translatable Text in the default language, and a list of translation entities
Gets the translations of the translatable Text in other languages
Represents the external identifiers linked to a film
Gets the list of related order related ticket type entities
Represents some customer-visible translatable Text in the default language, and a list of translation entities
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Represents some customer-visible translatable Text in the default language, and a list of translation entities
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the list of related order related item entities
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the list of related order related showtime entities
Represents the dates and times relevant to a showtime, e.g. its start, end, film start, etc
Gets the showtime entity's business date
Gets the date and time that the showtime starts
Gets the date and time that the showtime ends
Gets the date and time that the film screening starts
Gets the date and time that the film screening ends
Gets the list of related site entities
One of:
Represents a site in Vista Loyalty
Gets the contact details
Gets the list of phone number entities
Gets the IANA time zone name
Example: "America/New_York"
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets a value indicating whether the site has any sellable item entities
Gets the list of related screen entities
Gets the name text, and its translations
Gets the translations of the translatable Text in other languages
Gets the list of related censor rating entities
Gets the classification text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the censor rating Classification description text, and its translations
Gets the list of related item service area entities
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the short name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Gets the list of related item showtime delivery window base entities
Gets the targeted delivery time, as a number of minutes from showtime schedule StartsAt
Gets the type
Value"MinutesFromStart"
Gets the unique identifier
Gets the name text, and its translations
Gets the text in the default language
Gets the related order related subscription billing option entity
Gets the related order related subscription entity
Gets the list of related area category entities
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets a value indicating whether the seat entities are allocated
relatedData.itemPostalDeliveryMethodsArray of objects(OrderRelatedItemPostalDeliveryMethod)required
Gets the list of related order related item postal delivery method entities
Gets a value indicating whether this is the default delivery method
Gets the name text, and its translations
Gets the text in the default language
Gets the translations of the translatable Text in other languages
Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
Example: "en-US"
Response
application/json
{ "order": { "id": "string", "type": "Standard", "status": "InProgress", "totalPrice": { … }, "vouchers": [ … ], "deals": [ … ], "payments": [ … ], "items": [ … ], "expiresAt": "2019-08-24T14:15:22Z", "hasCustomer": true, "amountSaved": { … }, "itemDeliveries": [ … ], "totalItemDeliveryFee": { … } }, "relatedData": { "films": [ … ], "ticketTypes": [ … ], "items": [ … ], "showtimes": [ … ], "sites": [ … ], "screens": [ … ], "censorRatings": [ … ], "itemServiceAreas": [ … ], "itemShowtimeDeliveryWindows": [ … ], "subscriptionBillingOption": { … }, "subscription": { … }, "balanceType": { … }, "areaCategories": [ … ], "itemPostalDeliveryMethods": [ … ] } }