Sign in

v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Ticket Redemption Cards

Adds a ticket redemption card to an in progress standard order

This endpoint validates the provided third party member card credentials or member ticket redemption card base and stores a successfully validated card against the order for later use.

For third party member card entities belonging to a third party member scheme that supports partial approvals, an arbitrarily large number of tickets will be requested to determine how many redemptions are actually available.

For third party member card entities belonging to a third party member scheme that does not support partial approvals, the number of tickets requested will depend on a preconfigured quantity per showtime, or only one ticket if no quantity has been configured.

This endpoint cannot be used for orders that have a parent order (see standard order ParentOrderId)

Licenses Required

  • Vista.Ocapi
post/ocapi/v1/orders/{orderId}/ticket-redemption-cards

Path parameters

orderIdstring required

The unique identifier of the in progress standard order being modified

Headers

loyaltySessionTokenstring

Current Loyalty session token, represents a 'signed-in' member

Connect-Region-Codestring

Region Code

Request body

OR

Response

Success

Example response

{
  "ticketRedemptionCard": {
    "maskedCardNumber": "12.......6789"
  },
  "ticketTypeAvailabilities": [
    {
      "unavailableMessage": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    }
  ]
}