Model: accountDetails

1 min

Model Parameters

accountDetails
- accountobject
  Description
  Fields associated with account numbers or loyalty IDs.
  - isEnrolledInLoyaltyProgramboolean
    Description
    Optional. Whether the purchaser is enrolled in a loyalty program.
    
    Options are:
    
    true
    
    false
    Allowed
    truefalse
  - isMobileAppInstalledboolean
    Description
    Optional. Whether the account has the mobile application installed somewhere, regardless if this event is from that mobile application.
    
    Options are:
    
    true
    
    false
    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.
    
    Options are:
    
    individual
    
    business
    
    family
    
    other
    Allowed
    individualbusinessfamilyother
  - accountReferralCodestring
    Example
    [email protected]
    Description
    Optional. Referral code provided by a friend or joining discount code.
  - 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
    . 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
    . 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
    . 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
    . 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.
  - totalCreditCardsOnFileinteger
    Example
    3
    Description
    Optional. Number of credit cards on file. Maximum field length = 10 characters.
  - totalInactiveCreditCardsOnFileinteger
    Example
    1
    Description
    Optional. Number of inactive credit cards on file. Maximum field length = 10 characters.
  - totalPurchasesinteger
    Description
    Optional. Number of purchases made in lifetime of membership. Maximum field length = 10 characters.
  - totalRefundsinteger
    Description
    Optional. Number of refunds made in lifetime of membership. Maximum field length = 10 characters.
  - totalOrdersAmountnumber
    Description
    Optional. Amount of all orders made in lifetime of membership in the currency specified by the transaction currencyCode field. Format = two decimals.
  - loyaltyProgramNamestring
    Example
    Members Plus
    Description
    Optional. Name of the program governing the points or loyalty program.
    
    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 the membership account was opened formatted yyyy-MMdd'T'HH:mm
    . This cannot be a future date.
    Format
    date-time
  - loyaltyNumberLastUsedDateTimestring<date-time>
    Example
    2021-01-22T17:07:24-07:00
    Description
    Optional. Date the membership account was last used formatted yyyy-MMdd'T'HH:mm
    . This cannot be a future date.
    Format
    date-time
  - loyaltyLastUsedPointsinteger
    Example
    123
    Description
    Optional. Amount of points last used in decimal numeric format. Maximum field length = 20 characters.
  - loyaltyPointsBalanceinteger
    Example
    987654321
    Description
    Optional. Member account points balance. Maximum field length = 20 characters.
  - loyaltyLastEarnedPointsinteger
    Example
    1234
    Description
    Optional. Number of points last earned on last transaction. Maximum field length = 20 characters.
  - loyaltyLastEarnedDateTimestring<date-time>
    Example
    2020-02-22T17:07:24-07:00
    Description
    Optional. Date the membership account last earned points formatted yyyy-MM-dd'T'HH:mm
    . This cannot be a future date.
    Format
    date-time
  - loyaltyPromotionMessageTypestring<postalMail | email | smsText | none>
    Description
    Optional. Promotion message type.
    
    Options are:
    
    postalMail
    
    email
    
    smsText
    
    none
    Allowed
    postalMailemailsmsTextnone