Model: accountDetails

1 min

Model Parameters

accountDetails
- accountobject
  Description
  [OPTIONAL]
  - isEnrolledInLoyaltyProgramstring<true | false>
    Description
    [OPTIONAL] Whether the purchaser is enrolled in a loyalty program.
    Allowed
    truefalse
  - isMobileAppInstalledstring<true | false>
    Description
    [OPTIONAL] Whether the account has the mobile application installed somewhere, regardless if this event is from that mobile application.
    Allowed
    truefalse
  - accountLocalestring
    Example
    en-US
    Description
    [OPTIONAL] Native language expressed in UTF-8 encoding.
  - accountLevelstring
    Example
    Gold
    Description
    [OPTIONAL] Level of membership or account as defined by you.
  - accountTypestring<individual | business | family | other>
    Description
    [OPTIONAL] Type of membership or account.
    Allowed
    individualbusinessfamilyother
  - accountReferralCodestring
    Example
    [email protected]
    Description
    [OPTIONAL] Referral or promotion code tied to account creation.
  - accountRegistrationDateTimestring<date-time>
    Example
    2020-11-22T17:07:24-07:00
    Description
    [OPTIONAL] Date and time the account was created formatted in yyyy-MM-dd'T'HH:mm
    (RFC3339). This cannot be a future date.
    Format
    date-time
  - accountEmailUpdatedDateTimestring<date-time>
    Example
    2020-08-28T19:00:00-04:00
    Description
    [OPTIONAL] Date and time the member email was last updated formatted in yyyy-MM-dd'T'HH:mm
    (RFC3339). This cannot be a future date.
    Format
    date-time
  - accountEmailVerifiedDateTimestring<date-time>
    Example
    2020-08-28T19:00:00-04:00
    Description
    [OPTIONAL] Date and time the member email was last verified formatted in yyyy-MM-dd'T'HH:mm
    (RFC3339). This cannot be a future date.
    Format
    date-time
  - accountPasswordUpdatedDateTimestring<date-time>
    Example
    2020-02-22T17:07:24-07:00
    Description
    [OPTIONAL] Date and time the member password was last updated formatted in yyyy-MM-dd'T'HH:mm
    (RFC3339). This cannot be a future date.
    Format
    date-time
  - dateOfBirthstring
    Example
    1974-01-03
    Description
    [OPTIONAL] User's date of birth formatted YYYY-MM-DD.
  - totalCreditCardsOnFilestring
    Example
    3
    Description
    [OPTIONAL] Count of cards on file. Maximum field length = 10 characters.
  - totalInactiveCreditCardsOnFilestring
    Example
    1
    Description
    [OPTIONAL] Count of inactive cards on file. Maximum field length = 10 characters.
  - totalPurchasesstring
    Description
    [OPTIONAL] Lifetime number of purchases. Maximum field length = 10 characters.
  - totalRefundsstring
    Description
    [OPTIONAL] Lifetime number of refunds. Maximum field length = 10 characters.
  - totalOrdersAmountstring
    Description
    [OPTIONAL] Lifetime total order amount in the currency specified by the transaction currencyCode field. Format = two decimals.
  - loyaltyProgramNamestring
    Example
    Members Plus
    Description
    [OPTIONAL] Name of loyalty program governing points.
    
    Note: This is different than the accountLevel of a single loyalty program.
  - loyaltyNumberStartDateTimestring<date-time>
    Example
    2020-02-22T17:07:24-07:00
    Description
    [OPTIONAL] Date and time the loyalty account was opened formatted yyyy-MMdd'T'HH:mm
    (RFC3339). This cannot be a future date.
    Format
    date-time
  - loyaltyNumberLastUsedDateTimestring<date-time>
    Example
    2021-01-22T17:07:24-07:00
    Description
    [OPTIONAL] Date and time the loyalty account was last used formatted yyyy-MMdd'T'HH:mm
    (RFC3339). This cannot be a future date.
    Format
    date-time
  - loyaltyLastUsedPointsstring
    Example
    123
    Description
    [OPTIONAL] Points used on the last redemption in decimal numeric format. Maximum field length = 20 characters.
  - loyaltyPointsBalancestring
    Example
    987654321
    Description
    [OPTIONAL] Current points balance. Maximum field length = 20 characters.
  - loyaltyLastEarnedPointsstring
    Example
    1234
    Description
    [OPTIONAL] Points earned on the last earn event. Maximum field length = 20 characters.
  - loyaltyLastEarnedDateTimestring<date-time>
    Example
    2020-02-22T17:07:24-07:00
    Description
    [OPTIONAL] Date and time of last earn event formatted yyyy-MMdd'T'HH:mm
    (RFC3339). This cannot be a future date.
    Format
    date-time
  - loyaltyPromotionMessageTypestring<postalMail | email | smsText | none>
    Description
    [OPTIONAL] Preferred loyalty promo communications channel.
    Allowed
    postalMailemailsmsTextnone

Account/loyalty profile attributes.