Skip to content

Vista Digital Platform (V1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://developer.vista.co/_mock/openapi/digital-platform/openapi

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

Removes a voucher from an in progress order base

Request

If the voucher is not a deal voucher, all usages of the voucher on the order must be cancelled before the voucher can be removed.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress order base being modified

voucherIdstringrequired

The unique identifier of the order voucher being removed

Headers
Connect-Region-Codestring

Region Code

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

Responses

Voucher removed.

Adds a voucher to an in progress order base

Request

This endpoint validates the provided voucher credentials and stores a successfully validated voucher against the order for later use.

Licenses Required

  • Vista.Ocapi
Path
orderIdstringrequired

The unique identifier of the in progress order base being modified

Headers
Connect-Region-Codestring

Region Code

Body
required

The details of the voucher to be added to the in progress order base

One of:

Represents the information required to add an order voucher of type voucher type Deal to an in progress standard order

typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"
credentialsobject(VoucherCredentials)required

Gets the credentials

credentials.​barcodestringnon-emptyrequired

Gets the barcode

credentials.​pinstring or null

Gets the PIN

curl -i -X POST \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/orders/{orderId}/vouchers' \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "Ticket",
    "showtimeId": "string",
    "credentials": {
      "barcode": "string",
      "pin": "string"
    }
  }'

Responses

Success

Bodyapplication/json
voucherobject(OrderVoucher)required

Gets the order voucher entity

voucher.​idstringnon-emptyrequired

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

voucher.​typestring(VoucherType)required

Gets the type

Enum"Ticket""Subscription""Deal"
voucher.​maskedBarcodestringnon-emptyrequired

Gets a masked representation of the barcode

Example: "12.......6789"
voucher.​voucherTypeCodestringnon-emptyrequired

Gets the unique identifier of the voucher type

voucher.​voucherTypeDescriptionobject(Translatable)

Gets the voucher type description text, and its translations

availableRedemptionsinteger(int32)required

Gets the maximum number of times that the order voucher details Voucher can be redeemed

Response
application/json
{
  "voucher": {
    "id": "string",
    "type": "Ticket",
    "maskedBarcode": "12.......6789",
    "voucherTypeCode": "string",
    "voucherTypeDescription": { … }
  },
  "availableRedemptions": 0
}

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations