---
title: "Creates a member"
method: POST
path: "/ocapi/v1/members"
tags: ["Members"]
---

# Creates a member

`POST /ocapi/v1/members`

#### Licenses Required


- Vista.Ocapi

## Headers

- `Connect-Region-Code` string

## Request body

- OcapiV1LoyaltyMembersCreateMemberCreate — Represents the values needed to create a member
  - `credentials` OcapiV1LoyaltyMembersCredentialsMemberCredentialsCreate, required — Represents the authentication credentials of a member being created
    - `username` string, nullable — Gets the username
    - `password` string, nullable — Gets the password
    - `pin` string, nullable — Gets the PIN
    - `email` string, nullable — Gets the email address
  - `clubMembership` OcapiV1LoyaltyMembersClubMembershipsMemberClubMembership, required — Represents a member entity's membership of a club
    - `clubId` integer, required — Gets the unique identifier of the club
    - `clubLevelId` integer, nullable — Gets the unique identifier of the club level, if applicable
  - `personalDetails` OcapiV1LoyaltyMembersPersonalDetailsMemberPersonalDetails — Represents the personal details of a member
    - `name` OcapiV1PersonName, required — Represents the parts of a person's name
      - `givenName` string, nullable — Gets the given name
      - `familyName` string, nullable — Gets the family name
      - `middleName` string, nullable — Gets the middle or any additional name
    - `contactDetails` OcapiV1LoyaltyMembersPersonalDetailsMemberContactDetails, required — Represents the contact details of a member
      - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities
        - `type` 'Home' | 'Mobile' | 'Work' | 'Business' | 'Fax', required — Represents the type of a phone number
        - `number` string, required — Gets the phone number
      - `address` OcapiV1LoyaltyMembersPersonalDetailsMemberAddress — Represents the physical address of a member
        - `line1` string, nullable — Gets the first line
        - `suburb` string, nullable — Gets the suburb
        - `city` string, nullable — Gets the city
        - `state` string, nullable — Gets the state
        - `postCode` string, nullable — Gets the post code
        - `country` string, nullable — Gets the country
      - `pushNotificationToken` OcapiV1PushNotificationToken — Represents a token used for push notifications
        - `id` string, required — Gets the unique identifier
        - `type` 'Android' | 'Ios', required — Represents the type of a push notification token
    - `interestSubscriptions` OcapiV1LoyaltyMembersPersonalDetailsMemberInterestSubscription[], required — Gets the list of member interest subscription entities
      - `interestId` integer, required — Gets the unique identifier of the interest
      - `interestContactMethodIds` integer[], required — Gets the list of unique identifiers of the selected interest contact method entities
    - `preferences` OcapiV1LoyaltyMembersPreferencesMemberPreferences, required — Represents preferences of a member
      - `sites` OcapiV1LoyaltyMembersPreferencesMemberSitePreferences, required — Represents the loyalty site preferences of a member
        - `pickupSiteId` string, nullable — Gets the unique identifier of the loyalty site used for pickup orders
        - `primarySiteId` string, nullable — Gets the unique identifier of the primary loyalty site
        - `preferredSiteIds` string[], required — Gets the list of unique identifiers of the preferred loyalty site entities
      - `genres` OcapiV1LoyaltyMembersPreferencesMemberGenrePreferences, required — Represents the loyalty genre preferences of a member
        - `preferredGenreIds` string[], required — Gets the list of unique identifiers of the preferred loyalty genre entities
      - `contact` OcapiV1LoyaltyMembersPreferencesMemberContactPreferences, required — Represents the contact preferences of a member
        - `contactMethods` OcapiV1LoyaltyMembersPreferencesMemberContactMethod[], required — Gets the list of preferred member contact method entities
        - `mailerFrequency` 'Never' | 'Weekly' | 'Fortnightly' | 'Monthly', required — Represents how often the member receives a mailer
        - `allowThirdPartyContact` boolean, required — Gets a value indicating whether the member has consented to being contacted by third parties
      - `customPreferences` OcapiV1LoyaltyMembersPreferencesMemberCustomPreference[], required — Gets the list of member custom preference entities
        - `customPreferenceId` integer, required — Gets the unique identifier of the custom preference
        - `customPreferenceOptionIds` integer[], required — Gets the list of unique identifiers of the selected custom preference option entities
      - `languageTag` string, nullable — Gets the IETF (RFC 4646) language tag
      - `allowThirdPartyProfiling` boolean, required — Gets a value indicating whether the member has consented to third-party profiling
    - `birthDate` string, date-time, nullable — Gets the date of birth, if known
    - `maritalStatus` 'NotSpecified' | 'Single' | 'Married' | 'Partnered' | 'Divorced' | 'Other', required — Represents the marital status of a member
    - `gender` 'NotSpecified' | 'Male' | 'Female' | 'Other', required — Represents the gender of a member
    - `educationLevelId` integer, nullable — Gets the unique identifier of the education level, if known
    - `occupationId` integer, nullable — Gets the unique identifier of the occupation, if known
    - `householdPersonCount` integer, nullable — Gets the number of people living in the household, if known
    - `nationalId` string, nullable — Gets the national unique identifier, if known
    - `externalId` string, nullable — Gets the unique identifier used in a previous loyalty system, if known
  - `acceptedTermsAndConditions` boolean, required — Gets a value indicating whether the member accepted the terms and conditions
  - `authenticationType` 'None' | 'Token' | 'Cookie' — Represents the different types of authentication that can be returned for a member

## Response `200`

Success

- OcapiV1LoyaltyMembersCreateCreatedMemberDetails — Represents a member that has just been created, and its related data. Includes an created member details AuthenticationToken for the created member, if requested
  - `memberDetails` OcapiV1LoyaltyMembersMemberDetails, required — Represents the details of a member entity, and its related data
    - `member` OcapiV1LoyaltyMembersMember, required — Represents a member in Vista Loyalty
      - `id` string, required — Gets the unique identifier
      - `hash` string, nullable — Gets the salted and hashed unique identifier
      - `membershipStartDate` string, date-time, required — Gets the date that the membership started
      - `credentials` union, required — Represents the authentication credentials of a member
        - OcapiV1LoyaltyMembersPasswordResetMemberPasswordResetCodeCreate — Represents a request to create a password reset code
          - `email` string, nullable — Gets the email address
          - `username` string, nullable — Gets the username
        - OcapiV1LoyaltyMembersCredentialsMemberCredentials — Represents the authentication credentials of a member
          - `username` string, nullable — Gets the username
          - `email` string, nullable — Gets the email address
      - `clubMembership` OcapiV1LoyaltyMembersClubMembershipsMemberClubMembership, required — Represents a member entity's membership of a club
        - `clubId` integer, required — Gets the unique identifier of the club
        - `clubLevelId` integer, nullable — Gets the unique identifier of the club level, if applicable
      - `personalDetails` OcapiV1LoyaltyMembersPersonalDetailsMemberPersonalDetails, required — Represents the personal details of a member
        - `name` OcapiV1PersonName, required — Represents the parts of a person's name
          - `givenName` string, nullable — Gets the given name
          - `familyName` string, nullable — Gets the family name
          - `middleName` string, nullable — Gets the middle or any additional name
        - `contactDetails` OcapiV1LoyaltyMembersPersonalDetailsMemberContactDetails, required — Represents the contact details of a member
          - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities
            - `type` 'Home' | 'Mobile' | 'Work' | 'Business' | 'Fax', required — Represents the type of a phone number
            - `number` string, required — Gets the phone number
          - `address` OcapiV1LoyaltyMembersPersonalDetailsMemberAddress — Represents the physical address of a member
            - `line1` string, nullable — Gets the first line
            - `suburb` string, nullable — Gets the suburb
            - `city` string, nullable — Gets the city
            - `state` string, nullable — Gets the state
            - `postCode` string, nullable — Gets the post code
            - `country` string, nullable — Gets the country
          - `pushNotificationToken` OcapiV1PushNotificationToken — Represents a token used for push notifications
            - `id` string, required — Gets the unique identifier
            - `type` 'Android' | 'Ios', required — Represents the type of a push notification token
        - `interestSubscriptions` OcapiV1LoyaltyMembersPersonalDetailsMemberInterestSubscription[], required — Gets the list of member interest subscription entities
          - `interestId` integer, required — Gets the unique identifier of the interest
          - `interestContactMethodIds` integer[], required — Gets the list of unique identifiers of the selected interest contact method entities
        - `preferences` OcapiV1LoyaltyMembersPreferencesMemberPreferences, required — Represents preferences of a member
          - `sites` OcapiV1LoyaltyMembersPreferencesMemberSitePreferences, required — Represents the loyalty site preferences of a member
            - `pickupSiteId` string, nullable — Gets the unique identifier of the loyalty site used for pickup orders
            - `primarySiteId` string, nullable — Gets the unique identifier of the primary loyalty site
            - `preferredSiteIds` string[], required — Gets the list of unique identifiers of the preferred loyalty site entities
          - `genres` OcapiV1LoyaltyMembersPreferencesMemberGenrePreferences, required — Represents the loyalty genre preferences of a member
            - `preferredGenreIds` string[], required — Gets the list of unique identifiers of the preferred loyalty genre entities
          - `contact` OcapiV1LoyaltyMembersPreferencesMemberContactPreferences, required — Represents the contact preferences of a member
            - `contactMethods` OcapiV1LoyaltyMembersPreferencesMemberContactMethod[], required — Gets the list of preferred member contact method entities
            - `mailerFrequency` 'Never' | 'Weekly' | 'Fortnightly' | 'Monthly', required — Represents how often the member receives a mailer
            - `allowThirdPartyContact` boolean, required — Gets a value indicating whether the member has consented to being contacted by third parties
          - `customPreferences` OcapiV1LoyaltyMembersPreferencesMemberCustomPreference[], required — Gets the list of member custom preference entities
            - `customPreferenceId` integer, required — Gets the unique identifier of the custom preference
            - `customPreferenceOptionIds` integer[], required — Gets the list of unique identifiers of the selected custom preference option entities
          - `languageTag` string, nullable — Gets the IETF (RFC 4646) language tag
          - `allowThirdPartyProfiling` boolean, required — Gets a value indicating whether the member has consented to third-party profiling
        - `birthDate` string, date-time, nullable — Gets the date of birth, if known
        - `maritalStatus` 'NotSpecified' | 'Single' | 'Married' | 'Partnered' | 'Divorced' | 'Other', required — Represents the marital status of a member
        - `gender` 'NotSpecified' | 'Male' | 'Female' | 'Other', required — Represents the gender of a member
        - `educationLevelId` integer, nullable — Gets the unique identifier of the education level, if known
        - `occupationId` integer, nullable — Gets the unique identifier of the occupation, if known
        - `householdPersonCount` integer, nullable — Gets the number of people living in the household, if known
        - `nationalId` string, nullable — Gets the national unique identifier, if known
        - `externalId` string, nullable — Gets the unique identifier used in a previous loyalty system, if known
      - `cards` OcapiV1LoyaltyMembersCardsMemberCard[], required — Gets the list of member card entities
        - `cardNumber` string, required — Gets the card number
        - `isPrimary` boolean, required — Gets a value indicating whether this is the primary card
      - `balances` OcapiV1LoyaltyMembersBalancesMemberBalance[], required — Gets the list of member balance entities
        - `balanceTypeId` integer, required — Gets the unique identifier of the balance type
        - `availableUnits` number, double, required — Gets the current available balance type units
        - `expiries` OcapiV1LoyaltyMembersBalancesMemberBalanceExpiry[], required — Gets the list member balance expiry entities
          - `units` number, double, required — Gets the number of balance type units that are expiring
          - `expiresAt` string, date-time, required — Gets the date and time that the units expire
      - `photo` OcapiV1LoyaltyMembersPhotosMemberPhoto — Represents the base properties of the photo associated with a member
        - `uriExpiresAt` string, date-time, required — Gets the date and time that the URI returned for retrieving the photo is no longer valid
        - `uri` string, uri, required — Gets the address used for retrieving the photo
      - `subscriptions` OcapiV1LoyaltyMembersSubscriptionsMemberSubscriptions — Represents the member subscription entities belonging to a member
        - `current` OcapiV1LoyaltyMembersSubscriptionsMemberSubscription, required — Represents an instance of a subscription belonging to a particular member
          - `subscriptionId` integer, required — Gets the unique identifier of the subscription
          - `status` 'Active' | 'Frozen' | 'OnHold' | 'NotStarted', required — Represents the status of a member subscription
          - `startsAt` string, date-time, required — Gets the date and time that the subscription starts
          - `expiresAt` string, date-time, nullable — Gets the date and time that the subscription expires
          - `contractedTermEndsAt` string, date-time, required — Gets the date and time that the contracted subscription MinimumTermInMonths ends
          - `billingDetails` OcapiV1LoyaltyMembersSubscriptionsMemberSubscriptionBillingDetails, required — Represents the billing details of a member subscription
            - `isRecurring` boolean, required — Gets a value indicating whether billing will occur at a regular interval
            - `reactivationPrice` OcapiV1MonetaryValue — Represents a monetary value, and its related tax value
              - …
            - `isUsingThirdPartyPaymentProvider` boolean, required — Gets a value indicating whether the member uses a third-party payment provider to pay for their member subscription
            - `currentBillingPeriodStartsAt` string, date-time, nullable — Gets the date and time that the current billing period started
            - `nextBillingPeriodStartsAt` string, date-time, nullable — Gets the date and time that the current billing period ends and the next billing period starts
            - `billingError` OcapiV1LoyaltyMembersSubscriptionsMemberSubscriptionBillingError — Represents a billing error for a member subscription
              - …
            - `hasLastContractedPaymentBeenMade` boolean, nullable — Gets a value indicating whether the last contracted payment has been made, if applicable
            - `hasNextBillingPeriodPriceAdjustment` boolean, nullable — Gets a value indicating whether there is a billing price adjustment for the next billing period
          - `holdPeriod` OcapiV1LoyaltyMembersSubscriptionsMemberSubscriptionHoldPeriod — Represents the hold period of a member subscription
            - `startDate` string, date-time, required — Gets the date that the hold period starts
            - `endDate` string, date-time, required — Gets the date that the hold period ends. The hold period is inclusive of this date
          - `isCancellationAllowed` boolean, required — Gets a value indicating whether the member is allowed to cancel the subscription
          - `cancelsAt` string, date-time, nullable — Gets the date and time that the subscription will be cancelled, if applicable
        - `future` OcapiV1LoyaltyMembersSubscriptionsMemberSubscription — Represents an instance of a subscription belonging to a particular member
          - `subscriptionId` integer, required — Gets the unique identifier of the subscription
          - `status` 'Active' | 'Frozen' | 'OnHold' | 'NotStarted', required — Represents the status of a member subscription
          - `startsAt` string, date-time, required — Gets the date and time that the subscription starts
          - `expiresAt` string, date-time, nullable — Gets the date and time that the subscription expires
          - `contractedTermEndsAt` string, date-time, required — Gets the date and time that the contracted subscription MinimumTermInMonths ends
          - `billingDetails` OcapiV1LoyaltyMembersSubscriptionsMemberSubscriptionBillingDetails, required — Represents the billing details of a member subscription
            - `isRecurring` boolean, required — Gets a value indicating whether billing will occur at a regular interval
            - `reactivationPrice` OcapiV1MonetaryValue — Represents a monetary value, and its related tax value
              - …
            - `isUsingThirdPartyPaymentProvider` boolean, required — Gets a value indicating whether the member uses a third-party payment provider to pay for their member subscription
            - `currentBillingPeriodStartsAt` string, date-time, nullable — Gets the date and time that the current billing period started
            - `nextBillingPeriodStartsAt` string, date-time, nullable — Gets the date and time that the current billing period ends and the next billing period starts
            - `billingError` OcapiV1LoyaltyMembersSubscriptionsMemberSubscriptionBillingError — Represents a billing error for a member subscription
              - …
            - `hasLastContractedPaymentBeenMade` boolean, nullable — Gets a value indicating whether the last contracted payment has been made, if applicable
            - `hasNextBillingPeriodPriceAdjustment` boolean, nullable — Gets a value indicating whether there is a billing price adjustment for the next billing period
          - `holdPeriod` OcapiV1LoyaltyMembersSubscriptionsMemberSubscriptionHoldPeriod — Represents the hold period of a member subscription
            - `startDate` string, date-time, required — Gets the date that the hold period starts
            - `endDate` string, date-time, required — Gets the date that the hold period ends. The hold period is inclusive of this date
          - `isCancellationAllowed` boolean, required — Gets a value indicating whether the member is allowed to cancel the subscription
          - `cancelsAt` string, date-time, nullable — Gets the date and time that the subscription will be cancelled, if applicable
        - `canPurchaseFutureSubscription` boolean, required — Gets a value indicating whether the member can purchase a member subscriptions Future subscription
        - `canPurchaseFutureSubscriptionAt` string, date-time, required — Gets the date and time that the member can purchase a member subscriptions Future subscription
      - `friends` OcapiV1LoyaltyMembersFriendsMemberFriend[], required — Gets the list of member friend entities
        - `id` string, uuid, required — Gets the unique identifier
        - `name` OcapiV1PersonName, required — Represents the parts of a person's name
          - `givenName` string, nullable — Gets the given name
          - `familyName` string, nullable — Gets the family name
          - `middleName` string, nullable — Gets the middle or any additional name
        - `photo` OcapiV1LoyaltyMembersFriendsMemberFriendPhoto — Represents the base properties of the photo associated with a member
          - `uriExpiresAt` string, date-time, required — Gets the date and time that the URI returned for retrieving the photo is no longer valid
          - `uri` string, uri, required — Gets the address used for retrieving the photo
        - `subscriptionSharing` OcapiV1LoyaltyMembersFriendsMemberFriendSubscriptionSharing, required — Represents the details of any member subscription sharing between a member friend and a member
          - `friendCanUseMemberSubscription` boolean, required — Gets a value indicating whether the member friend can use the member entity's member subscription
          - `friendSubscriptions` OcapiV1LoyaltyMembersFriendsMemberFriendSubscription[], required — Gets the list of member friend subscription entities that the member can use
            - `subscriptionId` integer, required — Gets the unique identifier of the subscription
        - `createdAt` string, date-time, required — Gets the date and time that the friend was created
    - `relatedData` OcapiV1LoyaltyMembersMemberRelatedData, required — Related data for a member entity
      - `balanceTypes` OcapiV1LoyaltyBalanceTypesBalanceType[], required — Gets the list of related balance type entities for the member balance entities
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
        - `isPrimary` boolean, required — Gets a value indicating whether this is the primary balance type
        - `unitName` string, nullable — Gets the name of the balance units
        - `paymentConversionRate` number, double, nullable — Gets the conversion rate that applies when using balance units for an order member balance payment, if applicable
        - `unitDecimalPlaces` integer, required — Gets the number of decimal places used to format and calculate balance unit values
      - `club` OcapiV1LoyaltyClubsClub, required — Represents a scheme in Vista Loyalty that member entities join via a member club membership to gain reward entities
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
      - `clubLevel` OcapiV1LoyaltyClubsClubLevel — Represents the level of a club
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
        - `isExemptFromBookingFees` boolean, required — Gets a value indicating whether a member assigned to this club level will be exempt from booking fees
      - `customPreferences` OcapiV1LoyaltyMasterDataCustomPreferencesCustomPreference[], required — Gets the list of related custom preference entities for the member custom preference entities
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
        - `optionQuantityLimit` OcapiV1QuantityLimit, required — Represents a limited or unlimited quantity
          - `isUnlimited` boolean, required — Gets a value indicating whether the quantity is unlimited
          - `maximum` integer, nullable — Gets the maximum quantity allowed
          - `minimum` integer, required — Gets the minimum quantity allowed (0 by default)
        - `options` OcapiV1LoyaltyMasterDataCustomPreferencesCustomPreferenceOption[], required — Gets the list of custom preference option entities
          - `id` integer, required — Gets the unique identifier
          - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
            - `text` string, required — Gets the text in the default language
            - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
              - …
      - `educationLevel` OcapiV1LoyaltyMasterDataEducationLevelsEducationLevel — Represents the education level of a member
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
      - `genres` OcapiV1LoyaltyMasterDataGenresLoyaltyGenre[], required — Gets the list of related loyalty genre entities for the member genre preferences
        - `id` string, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
      - `interests` OcapiV1LoyaltyMasterDataInterestsInterest[], required — Gets the list of related interest entities for the member interest subscription entities
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
        - `displayPriority` integer, required — Gets the display priority used for sorting
      - `interestContactMethods` OcapiV1LoyaltyMasterDataInterestsInterestContactMethod[], required — Gets the list of related interest contact method entities for the member interest subscription entities
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
      - `occupation` OcapiV1LoyaltyMasterDataOccupationsOccupation — Represents the occupation of a member
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
      - `sites` OcapiV1LoyaltyMasterDataSitesLoyaltySite[], required — Gets the list of related loyalty site entities for the member site preferences
        - `location` OcapiV1GeographicLocation — Represents a set of geospatial coordinates; longitude and latitude, that can be used to pinpoint a location on a map
          - `latitude` number, double, required — Gets the latitude (expressed in degrees and minutes)
          - `longitude` number, double, required — Gets the longitude (expressed in degrees and minutes)
        - `contactDetails` OcapiV1BrowsingMasterDataSitesSiteContactDetails, required — Represents the contact details of a site
          - `phoneNumbers` OcapiV1PhoneNumber[], required — Gets the list of phone number entities
            - `type` 'Home' | 'Mobile' | 'Work' | 'Business' | 'Fax', required — Represents the type of a phone number
            - `number` string, required — Gets the phone number
          - `email` string, nullable — Gets the email address
          - `address` OcapiV1BrowsingMasterDataSitesSiteAddress — Represents the physical address of a site
            - `line1` string, nullable — Gets the first line
            - `line2` string, nullable — Gets the second line
            - `city` string, nullable — Gets the city
        - `ianaTimeZoneName` string, required — Gets the IANA time zone name
        - `id` string, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
        - `hasSellableItems` boolean, required — Gets a value indicating whether the site has any sellable item entities
        - `allowedItemDeliveryMethods` OcapiV1SalesMasterDataItemsDeliveryMethodsItemDeliveryMethod[], required — Gets the list of allowed item delivery method entities
      - `subscriptions` OcapiV1LoyaltyMasterDataSubscriptionsSubscription[], required — Gets the list of related subscription entities for the member subscription entities
        - `id` integer, required — Gets the unique identifier
        - `name` OcapiV1Translatable, required — Represents some customer-visible translatable Text in the default language, and a list of translation entities
          - `text` string, required — Gets the text in the default language
          - `translations` OcapiV1Translation[], required — Gets the translations of the translatable Text in other languages
            - `languageTag` string, required — Gets the IETF (RFC 4646) language tag that the translation Text has been translated for
            - `text` string, required — Gets the translated text
        - `clubId` integer, required — Gets the unique identifier of the club
        - `minimumTermInMonths` integer, required — Gets the minimum number of number of months required for the subscription term
        - `minimumTermBeforeCanPurchaseFutureSubscriptionInMonths` integer, required — Gets the minimum number of months that must be completed before purchase of another subscription will be allowed
  - `authenticationToken` OcapiV1LoyaltyMembersAuthenticationMemberAuthenticationToken — Represents a successful member authentication response
    - `access_token` string, required — Gets the access token
    - `token_type` string, required — Gets the type
    - `expires_in` integer, required — Gets the expiry time in seconds
    - `refresh_token` string, nullable — Gets the refresh token

## Other responses

- `400` — Request property is invalid or missing.

---

[API](https://skmtc.net/vista/apis/vista-digital-platform.md) · [All operations](https://skmtc.net/vista/apis/vista-digital-platform/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vista/vista-digital-platform/revisions/3a81c0aed14e/schema)
