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

Creates an order completion for an in progress order base

Request

An order completion is automatically created upon completion of a successful order embedded payment but must be manually created for zero value orders, unpaid orders or orders paid entirely by order gift card payment payments.

Licenses Required

  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
Path
orderIdstringrequired

The unique identifier of the in progress order base being completed

Headers
Connect-Region-Codestring

Region Code

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

Responses

Success

Bodyapplication/json
One of:

Represents the completion of an in progress order base

orderIdstringnon-emptyrequired

Gets the unique identifier of the in progress order base

orderTypestring(OrderType)required

Gets the type of the in progress order base

Enum"Standard""GiftShop""Subscription"
statusstring(OrderCompletionStatus)required

Gets the status

Enum"Pending""Completed""Failed"
transactionNumberinteger or null(int32)

Gets the number generated by the site that can be used to identify and collect the transaction

updatedOrderExpiresAtstring or null(date-time)

Gets the updated date and time that the in progress order base expires

Response
application/json
{
  "orderId": "string",
  "orderType": "Standard",
  "status": "Pending",
  "transactionNumber": 0,
  "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}

Gets the order completion for an in progress order base

Request

This endpoint may be polled to determine when the order completion has been finished.

Licenses Required

  • Vista.Ocapi
  • Vista.Ocapi.EmbeddedPayment
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}/completion' \
  -H 'Connect-Region-Code: string'

Responses

Success

Bodyapplication/json
One of:

Represents the completion of an in progress order base

orderIdstringnon-emptyrequired

Gets the unique identifier of the in progress order base

orderTypestring(OrderType)required

Gets the type of the in progress order base

Enum"Standard""GiftShop""Subscription"
statusstring(OrderCompletionStatus)required

Gets the status

Enum"Pending""Completed""Failed"
transactionNumberinteger or null(int32)

Gets the number generated by the site that can be used to identify and collect the transaction

updatedOrderExpiresAtstring or null(date-time)

Gets the updated date and time that the in progress order base expires

Response
application/json
{
  "orderId": "string",
  "orderType": "Standard",
  "status": "Pending",
  "transactionNumber": 0,
  "updatedOrderExpiresAt": "2019-08-24T14:15:22Z"
}

Gift shop

Operations

Vouchers

Operations

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations