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
Request
path Parameters
orderId
required
string

The unique identifier of the in progress standard order being modified

header Parameters
loyaltySessionToken
string

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

Connect-Region-Code
string

Region Code

Request Body schema:
required

The details of the ticket redemption card to be added

One of:

Represents the information required to add a member ticket redemption card base to an in progress standard order

memberTicketRedemptionCardId
required
string <uuid>

Gets the unique identifier of the member ticket redemption card base

type
required
string (OrderTicketRedemptionCardRequestType)

Represents the type of an order third party member card request

Enum: "ThirdPartyMemberCard" "MemberTicketRedemptionCard"
showtimeId
required
string non-empty

Gets the unique identifier of the showtime that the ticket redemption card will be validated for

Responses
200

Success

400

Request property is invalid or missing, or invalid order type/card.

401

No member authenticated.

404

Order does not exist.

post/ocapi/v1/orders/{orderId}/ticket-redemption-cards
Request samples
{
  • "memberTicketRedemptionCardId": "f41d4c72-96c0-481b-ac55-a3286e384fd5",
  • "type": "ThirdPartyMemberCard",
  • "showtimeId": "string"
}
Response samples
application/json
{
  • "ticketRedemptionCard": {
    },
  • "redemptionLimit": {
    }
}