Gets a list of member transaction entities for the currently authenticated member

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

Creates a member

Request

Licenses Required

Vista.Ocapi

Headers

Connect-Region-Codestring

Region Code

Body

required

Member to create

credentialsobject(MemberCredentialsCreate)required

Gets the credentials

credentials.usernamestring or null

Gets the username

credentials.passwordstring or null

Gets the password

credentials.pinstring or null

Gets the PIN

credentials.emailstring or null

Gets the email address

clubMembershipobject(MemberClubMembership)required

Gets the club membership details

clubMembership.clubIdinteger(int32)required

Gets the unique identifier of the club

clubMembership.clubLevelIdinteger or null(int32)

Gets the unique identifier of the club level, if applicable

personalDetailsobject(MemberPersonalDetails)

Gets the personal details

acceptedTermsAndConditionsbooleanrequired

Gets a value indicating whether the member accepted the terms and conditions

authenticationTypestring(MemberAuthenticationType)

Gets the type of authentication that should be returned along with the created member details

Enum"None""Token""Cookie"

curl -i -X POST \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -d '{
    "credentials": {
      "username": "string",
      "password": "string",
      "pin": "string",
      "email": "string"
    },
    "clubMembership": {
      "clubId": 0,
      "clubLevelId": 0
    },
    "personalDetails": {
      "name": {
        "givenName": "string",
        "familyName": "string",
        "middleName": "string"
      },
      "contactDetails": {
        "phoneNumbers": [
          {
            "type": "Home",
            "number": "string"
          }
        ],
        "address": {
          "line1": "60 Khyber Pass Road",
          "suburb": "Grafton",
          "city": "Auckland",
          "state": null,
          "postCode": "1023",
          "country": "New Zealand"
        },
        "pushNotificationToken": {
          "id": "string",
          "type": "Android"
        }
      },
      "interestSubscriptions": [
        {
          "interestId": 0,
          "interestContactMethodIds": [
            0
          ]
        }
      ],
      "preferences": {
        "sites": {
          "pickupSiteId": "string",
          "primarySiteId": "string",
          "preferredSiteIds": [
            "string"
          ]
        },
        "genres": {
          "preferredGenreIds": [
            "string"
          ]
        },
        "contact": {
          "contactMethods": [
            "Sms"
          ],
          "mailerFrequency": "Never",
          "allowThirdPartyContact": true
        },
        "customPreferences": [
          {
            "customPreferenceId": 0,
            "customPreferenceOptionIds": [
              0
            ]
          }
        ],
        "languageTag": "en-US",
        "allowThirdPartyProfiling": true
      },
      "birthDate": "2019-08-24T14:15:22Z",
      "maritalStatus": "NotSpecified",
      "gender": "NotSpecified",
      "educationLevelId": 0,
      "occupationId": 0,
      "householdPersonCount": 0,
      "nationalId": "string",
      "externalId": "string"
    },
    "acceptedTermsAndConditions": true,
    "authenticationType": "None"
  }'

Responses

Success

Bodyapplication/json

memberDetailsobject(MemberDetails)required

Gets the member details entity

memberDetails.memberobject(Member)required

Gets the member entity

memberDetails.member.idstringnon-emptyrequired

Gets the unique identifier

memberDetails.member.hashstring or null

Gets the salted and hashed unique identifier

memberDetails.member.membershipStartDatestring(date-time)required

Gets the date that the membership started

memberDetails.member.credentialsMemberPasswordResetCodeCreate (object) or MemberCredentials (object)required

Represents the authentication credentials of a member

One of:

Represents a request to create a password reset code

memberDetails.member.credentials.emailstring or null

Gets the email address

memberDetails.member.credentials.usernamestring or null

Gets the username

memberDetails.member.clubMembershipobject(MemberClubMembership)required

Gets the club membership details

memberDetails.member.clubMembership.clubIdinteger(int32)required

Gets the unique identifier of the club

memberDetails.member.clubMembership.clubLevelIdinteger or null(int32)

Gets the unique identifier of the club level, if applicable

memberDetails.member.personalDetailsobject(MemberPersonalDetails)required

Gets the personal details

memberDetails.member.personalDetails.nameobject(PersonName)required

Gets the name

memberDetails.member.personalDetails.name.givenNamestring or null

Gets the given name

memberDetails.member.personalDetails.name.familyNamestring or null

Gets the family name

memberDetails.member.personalDetails.name.middleNamestring or null

Gets the middle or any additional name

memberDetails.member.personalDetails.contactDetailsobject(MemberContactDetails)required

Gets the contact details

memberDetails.member.personalDetails.contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

memberDetails.member.personalDetails.contactDetails.addressobject(MemberAddress)

Gets the physical address

memberDetails.member.personalDetails.contactDetails.pushNotificationTokenobject(PushNotificationToken)

Gets the push notification token

memberDetails.member.personalDetails.interestSubscriptionsArray of objects(MemberInterestSubscription)required

Gets the list of member interest subscription entities

memberDetails.member.personalDetails.interestSubscriptions[].interestIdinteger(int32)required

Gets the unique identifier of the interest

memberDetails.member.personalDetails.interestSubscriptions[].interestContactMethodIdsArray of integers(int32)required

Gets the list of unique identifiers of the selected interest contact method entities

memberDetails.member.personalDetails.preferencesobject(MemberPreferences)required

Gets the preferences

memberDetails.member.personalDetails.preferences.sitesobject(MemberSitePreferences)required

Gets the site preferences

memberDetails.member.personalDetails.preferences.genresobject(MemberGenrePreferences)required

Gets the genre preferences

memberDetails.member.personalDetails.preferences.contactobject(MemberContactPreferences)required

Gets the contact preferences

memberDetails.member.personalDetails.preferences.customPreferencesArray of objects(MemberCustomPreference)required

Gets the list of member custom preference entities

memberDetails.member.personalDetails.preferences.languageTagstring or null

Gets the IETF (RFC 4646) language tag

Example: "en-US"

memberDetails.member.personalDetails.preferences.allowThirdPartyProfilingbooleanrequired

Gets a value indicating whether the member has consented to third-party profiling

memberDetails.member.personalDetails.birthDatestring or null(date-time)

Gets the date of birth, if known

memberDetails.member.personalDetails.maritalStatusstring(MemberMaritalStatus)required

Gets the marital status

Enum"NotSpecified""Single""Married""Partnered""Divorced""Other"

memberDetails.member.personalDetails.genderstring(MemberGender)required

Gets the gender

Enum"NotSpecified""Male""Female""Other"

memberDetails.member.personalDetails.educationLevelIdinteger or null(int32)

Gets the unique identifier of the education level, if known

memberDetails.member.personalDetails.occupationIdinteger or null(int32)

Gets the unique identifier of the occupation, if known

memberDetails.member.personalDetails.householdPersonCountinteger or null(int32)

Gets the number of people living in the household, if known

memberDetails.member.personalDetails.nationalIdstring or null

Gets the national unique identifier, if known

memberDetails.member.personalDetails.externalIdstring or null

Gets the unique identifier used in a previous loyalty system, if known

memberDetails.member.cardsArray of objects(MemberCard)required

Gets the list of member card entities

memberDetails.member.cards[].cardNumberstringnon-emptyrequired

Gets the card number

memberDetails.member.cards[].isPrimarybooleanrequired

Gets a value indicating whether this is the primary card

memberDetails.member.balancesArray of objects(MemberBalance)required

Gets the list of member balance entities

memberDetails.member.balances[].balanceTypeIdinteger(int32)required

Gets the unique identifier of the balance type

memberDetails.member.balances[].availableUnitsnumber(double)required

Gets the current available balance type units

memberDetails.member.balances[].expiriesArray of objects(MemberBalanceExpiry)required

Gets the list member balance expiry entities

memberDetails.member.balances[].expiries[].unitsnumber(double)required

Gets the number of balance type units that are expiring

memberDetails.member.balances[].expiries[].expiresAtstring(date-time)required

Gets the date and time that the units expire

memberDetails.member.photoobject(MemberPhotoBase)

Gets the photo details

memberDetails.member.subscriptionsobject(MemberSubscriptions)

Gets the subscriptions

memberDetails.member.friendsArray of objects(MemberFriend)required

Gets the list of member friend entities

memberDetails.member.friends[].idstring(uuid)required

Gets the unique identifier

memberDetails.member.friends[].nameobject(PersonName)required

Gets the name

memberDetails.member.friends[].name.givenNamestring or null

Gets the given name

memberDetails.member.friends[].name.familyNamestring or null

Gets the family name

memberDetails.member.friends[].name.middleNamestring or null

Gets the middle or any additional name

memberDetails.member.friends[].photoobject(MemberPhotoBase)

Gets the photo details

memberDetails.member.friends[].subscriptionSharingobject(MemberFriendSubscriptionSharing)required

Gets the subscription sharing details

memberDetails.member.friends[].subscriptionSharing.friendCanUseMemberSubscriptionbooleanrequired

Gets a value indicating whether the member friend can use the member entity's member subscription

memberDetails.member.friends[].subscriptionSharing.friendSubscriptionsArray of objects(MemberFriendSubscription)required

Gets the list of member friend subscription entities that the member can use

memberDetails.member.friends[].createdAtstring(date-time)required

Gets the date and time that the friend was created

memberDetails.relatedDataobject(MemberRelatedData)required

Gets the related data for the member entity

memberDetails.relatedData.balanceTypesArray of objects(BalanceType)required

Gets the list of related balance type entities for the member balance entities

memberDetails.relatedData.balanceTypes[].idinteger(int32)required

Gets the unique identifier

memberDetails.relatedData.balanceTypes[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.balanceTypes[].name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.balanceTypes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.balanceTypes[].isPrimarybooleanrequired

Gets a value indicating whether this is the primary balance type

memberDetails.relatedData.balanceTypes[].unitNamestring or null

Gets the name of the balance units

Example: "Points"

memberDetails.relatedData.balanceTypes[].paymentConversionRatenumber or null(double)

Gets the conversion rate that applies when using balance units for an order member balance payment, if applicable

memberDetails.relatedData.balanceTypes[].unitDecimalPlacesinteger(int32)required

Gets the number of decimal places used to format and calculate balance unit values

memberDetails.relatedData.clubobject(Club)required

Gets the related club entity for the member club membership

memberDetails.relatedData.club.idinteger(int32)required

Gets the unique identifier

memberDetails.relatedData.club.nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.club.name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.club.name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.clubLevelobject(ClubLevel)

Gets the related club level entity for the member club membership, if applicable

memberDetails.relatedData.customPreferencesArray of objects(CustomPreference)required

Gets the list of related custom preference entities for the member custom preference entities

memberDetails.relatedData.customPreferences[].idinteger(int32)required

Gets the unique identifier

memberDetails.relatedData.customPreferences[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.customPreferences[].name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.customPreferences[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.customPreferences[].optionQuantityLimitobject(QuantityLimit)required

Gets a value indicating the number of options that can be selected by a member

memberDetails.relatedData.customPreferences[].optionQuantityLimit.isUnlimitedbooleanrequired

Gets a value indicating whether the quantity is unlimited

memberDetails.relatedData.customPreferences[].optionQuantityLimit.maximuminteger or null(int32)

Gets the maximum quantity allowed

memberDetails.relatedData.customPreferences[].optionQuantityLimit.minimuminteger(int32)required

Gets the minimum quantity allowed (0 by default)

memberDetails.relatedData.customPreferences[].optionsArray of objects(CustomPreferenceOption)required

Gets the list of custom preference option entities

memberDetails.relatedData.customPreferences[].options[].idinteger(int32)required

Gets the unique identifier

memberDetails.relatedData.customPreferences[].options[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.educationLevelobject(EducationLevel)

Gets the related education level entity for the member personal details, if applicable

memberDetails.relatedData.genresArray of objects(LoyaltyGenre)required

Gets the list of related loyalty genre entities for the member genre preferences

memberDetails.relatedData.genres[].idstringnon-emptyrequired

Gets the unique identifier

memberDetails.relatedData.genres[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.genres[].name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.genres[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.interestsArray of objects(Interest)required

Gets the list of related interest entities for the member interest subscription entities

memberDetails.relatedData.interests[].idinteger(int32)required

Gets the unique identifier

memberDetails.relatedData.interests[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.interests[].name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.interests[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.interests[].displayPriorityinteger(int32)required

Gets the display priority used for sorting

memberDetails.relatedData.interestContactMethodsArray of objects(InterestContactMethod)required

Gets the list of related interest contact method entities for the member interest subscription entities

memberDetails.relatedData.interestContactMethods[].idinteger(int32)required

Gets the unique identifier

memberDetails.relatedData.interestContactMethods[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.interestContactMethods[].name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.interestContactMethods[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.occupationobject(Occupation)

Gets the related occupation entity for the member personal details, if applicable

memberDetails.relatedData.sitesArray of objects(LoyaltySite)required

Gets the list of related loyalty site entities for the member site preferences

memberDetails.relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

memberDetails.relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

memberDetails.relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

memberDetails.relatedData.sites[].contactDetails.emailstring or null

Gets the email address

memberDetails.relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

memberDetails.relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

memberDetails.relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

memberDetails.relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

memberDetails.relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

memberDetails.relatedData.subscriptionsArray of objects(Subscription)required

Gets the list of related subscription entities for the member subscription entities

memberDetails.relatedData.subscriptions[].idinteger(int32)required

Gets the unique identifier

memberDetails.relatedData.subscriptions[].nameobject(Translatable)required

Gets the name text, and its translations

memberDetails.relatedData.subscriptions[].name.textstringnon-emptyrequired

Gets the text in the default language

memberDetails.relatedData.subscriptions[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

memberDetails.relatedData.subscriptions[].clubIdinteger(int32)required

Gets the unique identifier of the club

memberDetails.relatedData.subscriptions[].minimumTermInMonthsinteger(int32)required

Gets the minimum number of number of months required for the subscription term

memberDetails.relatedData.subscriptions[].minimumTermBeforeCanPurchaseFutureSubscriptionInMonthsinteger(int32)required

Gets the minimum number of months that must be completed before purchase of another subscription will be allowed

authenticationTokenobject(MemberAuthenticationToken)

Gets the member authentication token for the created member, if the member authentication type Token authentication type was requested

Response

application/json

{
  "memberDetails": {
    "member": { … },
    "relatedData": { … }
  },
  "authenticationToken": {
    "access_token": "string",
    "token_type": "Bearer",
    "expires_in": 0,
    "refresh_token": "string"
  }
}

Gets a list of member transaction entities for the currently authenticated member

Request

Licenses Required

Vista.Ocapi

Query

limitinteger(int32)

The maximum number of transactions to return in the result set

Default 50

offsetinteger(int32)

The index of the first transaction to return in the result set

Default 0

Headers

loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

curl -i -X GET \
  'https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/transactions?limit=50&offset=0' \
  -H 'Connect-Region-Code: string' \
  -H 'loyaltySessionToken: string'

Responses

Success

Bodyapplication/json

relatedDataobject(MemberTransactionListRelatedData)required

Gets the related data for the member transaction entities

relatedData.sitesArray of objects(LoyaltySite)required

Gets the list of related loyalty site entities

relatedData.sites[].locationobject(GeographicLocation)

Gets the geographic location

relatedData.sites[].contactDetailsobject(SiteContactDetails)required

Gets the contact details

relatedData.sites[].contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

relatedData.sites[].contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

relatedData.sites[].contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

relatedData.sites[].contactDetails.emailstring or null

Gets the email address

relatedData.sites[].contactDetails.addressobject(SiteAddress)

Represents the physical address of a site

relatedData.sites[].ianaTimeZoneNamestringnon-emptyrequired

Gets the IANA time zone name

Example: "America/New_York"

relatedData.sites[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.sites[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.sites[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.sites[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.sites[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.sites[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.sites[].hasSellableItemsbooleanrequired

Gets a value indicating whether the site has any sellable item entities

relatedData.sites[].allowedItemDeliveryMethodsArray of strings(ItemDeliveryMethod)required

Gets the list of allowed item delivery method entities

Items Enum"CounterPickup""ServiceAreaPickup""ElectronicDelivery""InSeatDelivery""CustomLocationDelivery""PostalDelivery"

relatedData.filmsArray of objects(LoyaltyRelatedFilm)required

Gets the list of related loyalty related film entities

relatedData.films[].idstringnon-emptyrequired

relatedData.films[].titleobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.films[].title.textstringnon-emptyrequired

Gets the text in the default language

relatedData.films[].title.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.films[].title.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.films[].title.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.showtimesArray of objects(LoyaltyRelatedShowtime)required

Gets the list of related loyalty related showtime entities

relatedData.showtimes[].idstringnon-emptyrequired

relatedData.showtimes[].filmIdstringnon-emptyrequired

relatedData.showtimes[].siteIdstringnon-emptyrequired

relatedData.ticketTypesArray of objects(LoyaltyRelatedTicketType)required

Gets the list of related loyalty related ticket type entities

relatedData.ticketTypes[].idstringnon-emptyrequired

relatedData.ticketTypes[].descriptionobject(Translatable)required

Represents some customer-visible translatable Text in the default language, and a list of translation entities

relatedData.ticketTypes[].description.textstringnon-emptyrequired

Gets the text in the default language

relatedData.ticketTypes[].description.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.ticketTypes[].description.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.ticketTypes[].description.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.itemsArray of objects(LoyaltyItem)required

Gets the list of related loyalty item entities

relatedData.items[].idstringnon-emptyrequired

Gets the unique identifier

relatedData.items[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.items[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.items[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.items[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.items[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.items[].itemClassobject(LoyaltyItemClass)

Gets the item class

relatedData.balanceTypesArray of objects(BalanceType)required

Gets the list of related balance type entities

relatedData.balanceTypes[].idinteger(int32)required

Gets the unique identifier

relatedData.balanceTypes[].nameobject(Translatable)required

Gets the name text, and its translations

relatedData.balanceTypes[].name.textstringnon-emptyrequired

Gets the text in the default language

relatedData.balanceTypes[].name.translationsArray of objects(Translation)required

Gets the translations of the translatable Text in other languages

relatedData.balanceTypes[].name.translations[].languageTagstringnon-emptyrequired

Gets the IETF (RFC 4646) language tag that the translation Text has been translated for

Example: "en-US"

relatedData.balanceTypes[].name.translations[].textstringnon-emptyrequired

Gets the translated text

relatedData.balanceTypes[].isPrimarybooleanrequired

Gets a value indicating whether this is the primary balance type

relatedData.balanceTypes[].unitNamestring or null

Gets the name of the balance units

Example: "Points"

relatedData.balanceTypes[].paymentConversionRatenumber or null(double)

Gets the conversion rate that applies when using balance units for an order member balance payment, if applicable

relatedData.balanceTypes[].unitDecimalPlacesinteger(int32)required

Gets the number of decimal places used to format and calculate balance unit values

resultsArray of objects(MemberTransaction)required

Gets the list of results

results[].idinteger(int64)required

Gets the unique identifier

results[].totalPriceIncludingTaxnumber(double)required

Gets the total price including tax

results[].bookingobject(MemberTransactionBooking)

Gets the booking details, if applicable

results[].createdAtstring(date-time)required

Gets the date and time that the transaction was created

results[].showtimesArray of objects(MemberTransactionShowtime)required

Gets the list of member transaction showtime entities

results[].showtimes[].showtimeIdstringnon-emptyrequired

Gets the unique identifier of the loyalty related showtime

results[].showtimes[].ticketsArray of objects(MemberTransactionTicketLine)required

Gets the list of member transaction ticket line entities

results[].showtimes[].tickets[].ticketTypeIdstringnon-emptyrequired

Gets the unique identifier of the loyalty related ticket type

results[].showtimes[].tickets[].priceIncludingTaxnumber(double)required

Gets the price including tax that the member paid

results[].itemsArray of objects(MemberTransactionItemLine)required

Gets the list of member transaction item line entities

results[].items[].itemIdstringnon-emptyrequired

Gets the unique identifier of the loyalty item

results[].items[].priceIncludingTaxnumber(double)required

Gets the price including tax that the member paid

results[].balanceAdjustmentsArray of objects(MemberTransactionBalanceAdjustment)required

Gets the list of member transaction balance adjustment entities

results[].balanceAdjustments[].balanceTypeIdinteger(int32)required

Gets the unique identifier of the balance type

results[].balanceAdjustments[].unitsnumber(double)required

Gets the value in balance type units

results[].balanceAdjustments[].availableUnitsnumber(double)required

Gets the available balance type units after the adjustment

results[].balanceAdjustments[].isManualbooleanrequired

Gets a value indicating whether the adjustment was completed outside of a purchase being made by the member

results[].balanceAdjustments[].manualReasonstring or null

Gets the note associated with the manual balance adjustment, if applicable

hasMoreResultsbooleanrequired

Gets a value indicating whether any more results are available

Response

application/json

{
  "relatedData": {
    "sites": [ … ],
    "films": [ … ],
    "showtimes": [ … ],
    "ticketTypes": [ … ],
    "items": [ … ],
    "balanceTypes": [ … ]
  },
  "results": [
    { … }
  ],
  "hasMoreResults": true
}

Updates the member personal details of the currently authenticated member

Request

Full personalDetails object from GetMember containing updated values must be sent to this endpoint. If field is not provided then it's considered that it must be cleared.

Note: currently Vista Loyalty doesn't support clearing fields. Also enum fields don't support setting value 0 where it is equivalent of clearing field (e.g. NotSpecified)

Licenses Required

Vista.Ocapi

Headers

loyaltySessionTokenstring

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

Connect-Region-Codestring

Region Code

Body

required

Member personal details to update

nameobject(PersonName)required

Gets the name

name.givenNamestring or null

Gets the given name

name.familyNamestring or null

Gets the family name

name.middleNamestring or null

Gets the middle or any additional name

contactDetailsobject(MemberContactDetails)required

Gets the contact details

contactDetails.phoneNumbersArray of objects(PhoneNumber)required

Gets the list of phone number entities

contactDetails.phoneNumbers[].typestring(PhoneNumberType)required

Gets the type

Enum"Home""Mobile""Work""Business""Fax"

contactDetails.phoneNumbers[].numberstringnon-emptyrequired

Gets the phone number

contactDetails.addressobject(MemberAddress)

Gets the physical address

contactDetails.pushNotificationTokenobject(PushNotificationToken)

Gets the push notification token

interestSubscriptionsArray of objects(MemberInterestSubscription)required

Gets the list of member interest subscription entities

interestSubscriptions[].interestIdinteger(int32)required

Gets the unique identifier of the interest

interestSubscriptions[].interestContactMethodIdsArray of integers(int32)required

Gets the list of unique identifiers of the selected interest contact method entities

preferencesobject(MemberPreferences)required

Gets the preferences

preferences.sitesobject(MemberSitePreferences)required

Gets the site preferences

preferences.sites.pickupSiteIdstring or null

Gets the unique identifier of the loyalty site used for pickup orders

preferences.sites.primarySiteIdstring or null

Gets the unique identifier of the primary loyalty site

preferences.sites.preferredSiteIdsArray of stringsrequired

Gets the list of unique identifiers of the preferred loyalty site entities

preferences.genresobject(MemberGenrePreferences)required

Gets the genre preferences

preferences.genres.preferredGenreIdsArray of stringsrequired

Gets the list of unique identifiers of the preferred loyalty genre entities

preferences.contactobject(MemberContactPreferences)required

Gets the contact preferences

preferences.contact.contactMethodsArray of strings(MemberContactMethod)required

Gets the list of preferred member contact method entities

Items Enum"Sms""Email""Mail""Phone""Fax"

preferences.contact.mailerFrequencystring(MemberMailerFrequency)required

Gets the mailer frequency

Enum"Never""Weekly""Fortnightly""Monthly"

preferences.contact.allowThirdPartyContactbooleanrequired

Gets a value indicating whether the member has consented to being contacted by third parties

preferences.customPreferencesArray of objects(MemberCustomPreference)required

Gets the list of member custom preference entities

preferences.customPreferences[].customPreferenceIdinteger(int32)required

Gets the unique identifier of the custom preference

preferences.customPreferences[].customPreferenceOptionIdsArray of integers(int32)required

Gets the list of unique identifiers of the selected custom preference option entities

preferences.languageTagstring or null

Gets the IETF (RFC 4646) language tag

Example: "en-US"

preferences.allowThirdPartyProfilingbooleanrequired

Gets a value indicating whether the member has consented to third-party profiling

birthDatestring or null(date-time)

Gets the date of birth, if known

maritalStatusstring(MemberMaritalStatus)required

Gets the marital status

Enum"NotSpecified""Single""Married""Partnered""Divorced""Other"

genderstring(MemberGender)required

Gets the gender

Enum"NotSpecified""Male""Female""Other"

educationLevelIdinteger or null(int32)

Gets the unique identifier of the education level, if known

occupationIdinteger or null(int32)

Gets the unique identifier of the occupation, if known

householdPersonCountinteger or null(int32)

Gets the number of people living in the household, if known

nationalIdstring or null

Gets the national unique identifier, if known

externalIdstring or null

Gets the unique identifier used in a previous loyalty system, if known

curl -i -X PUT \
  https://developer.vista.co/_mock/openapi/digital-platform/openapi/ocapi/v1/members/current/personal-details \
  -H 'Connect-Region-Code: string' \
  -H 'Content-Type: application/json' \
  -H 'loyaltySessionToken: string' \
  -d '{
    "name": {
      "givenName": "string",
      "familyName": "string",
      "middleName": "string"
    },
    "contactDetails": {
      "phoneNumbers": [
        {
          "type": "Home",
          "number": "string"
        }
      ],
      "address": {
        "line1": "60 Khyber Pass Road",
        "suburb": "Grafton",
        "city": "Auckland",
        "state": null,
        "postCode": "1023",
        "country": "New Zealand"
      },
      "pushNotificationToken": {
        "id": "string",
        "type": "Android"
      }
    },
    "interestSubscriptions": [
      {
        "interestId": 0,
        "interestContactMethodIds": [
          0
        ]
      }
    ],
    "preferences": {
      "sites": {
        "pickupSiteId": "string",
        "primarySiteId": "string",
        "preferredSiteIds": [
          "string"
        ]
      },
      "genres": {
        "preferredGenreIds": [
          "string"
        ]
      },
      "contact": {
        "contactMethods": [
          "Sms"
        ],
        "mailerFrequency": "Never",
        "allowThirdPartyContact": true
      },
      "customPreferences": [
        {
          "customPreferenceId": 0,
          "customPreferenceOptionIds": [
            0
          ]
        }
      ],
      "languageTag": "en-US",
      "allowThirdPartyProfiling": true
    },
    "birthDate": "2019-08-24T14:15:22Z",
    "maritalStatus": "NotSpecified",
    "gender": "NotSpecified",
    "educationLevelId": 0,
    "occupationId": 0,
    "householdPersonCount": 0,
    "nationalId": "string",
    "externalId": "string"
  }'

Responses

Member personal details updated.

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

Refunds

Operations

Seating

Operations

Browsing

Operations

Sites

Operations

Surveys

Operations

Third-Party Member Schemes

Operations

Ticket Prices

Operations

Tracking Events

Operations

Tips

Operations

Vista Digital Platform (V1)

Completed Order Assets

Completed Orders

Orders

Seats

Discounts

Events

Showtimes

Films

Gift Cards

Items

Journeys

Third Party Passes

Loyalty

Authentication

Members

Creates a member

RequestExpand all

Licenses Required

Responses

Gets a list of member transaction entities for the currently authenticated member

Request

Licenses Required

Responses

Updates the member personal details of the currently authenticated member

RequestExpand all

Licenses Required

Responses

Member Completed Orders

Friends

Password Reset

Payments

Member Rewards

Subscriptions

Ticket Redemption Cards

Credentials

Watched Films

Watchlist Films

Completion

Gift shop

Vouchers

Refunds

Seating

Browsing

Sites

Surveys

Third-Party Member Schemes

Ticket Prices

Tracking Events

Tips

Request

Request