Serialized Form

  • Package com.broadleafcommerce.customer.dataexport.serializer

  • Package com.broadleafcommerce.customer.domain

    • Class com.broadleafcommerce.customer.domain.Account

      class Account extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountNumber
          String accountNumber
          A business-driven unique identifier for the account
        • accountType
          String accountType
          A simple categorization that can be used to group accounts or enforce business logic
        • attributes
          Map<String,Attribute> attributes
          Dynamic attributes that are a part of the account. This is an admin-entered field.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • id
          String id
          The context ID of the account.
        • name
          String name
          The name of the account
        • parentAccount
          AccountRef parentAccount
          The account's parent account. Users with access to the parent account also have access to this account.
        • status
          String status
          The status of this account. By default, the account is active.
          See Also:
        • taxId
          String taxId
          The unique tax id for the account's related organization
        • vatRegistrationId
          String vatRegistrationId
          Optional VAT Registration ID, which may be used by Tax Providers to calculate VAT taxes or apply VAT rules for B2B transactions in certain countries. This field should not be used for anything except a VAT registration ID. Contact Tax Provider (e.g. Avalara) for additional information.

    • Class com.broadleafcommerce.customer.domain.AccountAddress

      class AccountAddress extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountRef
          AccountRef accountRef
          The account in the relationship.
        • additionalAttributes
          Map<String,Object> additionalAttributes
          Map holding any additional attributes passed in the request not matching any defined properties.
        • addressLine1
          String addressLine1
          Primary address information, typically street name and building number.
        • addressLine2
          String addressLine2
          Secondary address information, like apartment, suite, or unit number.
        • addressLine3
          String addressLine3
          Tertiary address information, typically for international addresses.
        • city
          String city
          The city, town or village of this address.
        • companyName
          String companyName
          The name of the company at this address.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • country
          String country
          The country for this address.
        • county
          String county
          The county of this address.
        • emailAddress
          String emailAddress
          The email address of the individual at this physical address.
        • firstName
          String firstName
          The first name of the individual at this address.
        • fullName
          String fullName
          The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.
        • id
          String id
          The context ID of the relationship.
        • isActive
          boolean isActive
          Whether this address is an active address of the owner.
        • isDefault
          boolean isDefault
          Specifies whether or not this is the default for this type of address.
        • lastName
          String lastName
          The last name of the individual at this address.
        • name
          String name
          The user-provided name of the address.
        • phoneFax
          Phone phoneFax
          The fax number for this address.
        • phonePrimary
          Phone phonePrimary
          The primary phone number for this address.
        • phoneSecondary
          Phone phoneSecondary
          The secondary phone number for this address.
        • postalCode
          String postalCode
          Postal code or ZIP code for this address.
        • stateProvinceRegion
          String stateProvinceRegion
          The state, province or region of this address.
        • type
          String type
          The type of address for this account. For example, in a B2B context, this type may be DefaultB2BAccountAddressTypes.SHIP_TO or DefaultB2BAccountAddressTypes.BILL_TO
          See Also:
        • visibleToChildren
          String visibleToChildren
          Whether this address is visible to Children.
          See Also:

    • Class com.broadleafcommerce.customer.domain.AccountMember

      class AccountMember extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • account
          Account account
          The account in the relationship.
        • accountRoleIds
          Set<String> accountRoleIds
          The customer's roles within the account. These map to role IDs in the auth service.
        • active
          boolean active
          Specifies whether this account member represents an invite (false) or an actual account member who has accepted the invite or was added via the Admin portal (true).
        • additionalPhones
          List<AdditionalPhone> additionalPhones
          Deprecated, for removal: This API element is subject to removal in a future version.
          Use the customer's additional phones instead
          Additional phone numbers associated with the account member.
        • attributes
          Map<String,Object> attributes
          Additional attributes that are used to describe the account member
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • customer
          Customer customer
          The customer in the relationship.
        • defaultCommunicationPreference
          String defaultCommunicationPreference
          The default communication preference of the account member.
        • email
          String email
          The email address of the account member if they are not a registered customer at the time of invite.
        • id
          String id
          The context ID of the relationship.
        • phone
          Phone phone
          The main phone number of the account member if they are not a registered customer at the time of invite.

    • Class com.broadleafcommerce.customer.domain.AccountRef

      class AccountRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • id
          String id
          The account's id.
        • name
          String name
          The account's name.

    • Class com.broadleafcommerce.customer.domain.AdditionalPhone

      class AdditionalPhone extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • phone
          Phone phone
        • type
          String type
          The type of the additional phone. For example "FAX", "MOBILE", etc. or "OTHER"

    • Class com.broadleafcommerce.customer.domain.Attribute

      class Attribute extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • contextState
          com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState
          A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.
        • value
          Object value
          The value represented by this attribute. Attributes are generally placed on domain objects as a map of attribute names to attribute values: Map<String, Attribute>.

    • Class com.broadleafcommerce.customer.domain.Customer

      class Customer extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • active
          boolean active
          Is this customer active? Inactive customers can be thought of as "disabled" and will not be able to login. A customer set to inactive must be manually re-activated.

          Note: If manually setting this to false (e.g. via a direct database update), the auth user record (JpaUser#active in the auth database) must also be set to false.

          See also Customer.locked

        • additionalPhones
          List<AdditionalPhone> additionalPhones
          Additional phone numbers associated with the customer.
        • attributes
          Map<String,Object> attributes
          Dynamic attributes that are a part of the customer. This is an admin-entered field.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • defaultAccountId
          String defaultAccountId
          The default account for the customer. If set, the customer will automatically have this account selected on login.
        • defaultCommunicationPreference
          String defaultCommunicationPreference
          The default communication preference of the customer.
        • defaultPaymentAccountId
          String defaultPaymentAccountId
          Deprecated, for removal: This API element is subject to removal in a future version.
          since 1.7.2, in favor of using SavedPaymentMethod in PaymentTransactionServices to manage saved payment methods.
          The id of the default payment account.
        • email
          String email
          The email address of the customer.
        • externalId
          String externalId
          The id that associates this user with an external system.
        • firstName
          String firstName
          The first name of the customer, if the fullName is not being used for the customer.
        • fullName
          String fullName
          The full name of the customer, if the component parts firstName, middleName, and lastName are not being used to comprise the full name.
        • id
          String id
          The context ID of the customer.
        • lastName
          String lastName
          The last name of the customer, if the fullName is not being used for the customer.
        • locked
          boolean locked
          Is this user locked? A user may be locked due to too many failed login attempts. Note that, depending on user lock configuration, this may have no effect. If permanently disabling a customer is desired, the Customer.active flag should be used instead.
        • middleName
          String middleName
          The middle name of the customer, if the fullName is not being used for the customer.
        • phone
          Phone phone
          The main phone number of the customer.
        • specialType
          String specialType
          The type of the customer, if it's in a special circumstance.
          See Also:
        • taxId
          String taxId
          The tax id for this customer
        • username
          String username
          The username of the customer, used to log in.
        • vatRegistrationId
          String vatRegistrationId
          Optional VAT registration ID.
          See Also:

    • Class com.broadleafcommerce.customer.domain.CustomerAddress

      class CustomerAddress extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Map holding any additional attributes passed in the request not matching any defined properties.
        • addressLine1
          String addressLine1
          Primary address information, typically street name and building number.
        • addressLine2
          String addressLine2
          Secondary address information, like apartment, suite, or unit number.
        • addressLine3
          String addressLine3
          Tertiary address information, typically for international addresses.
        • city
          String city
          The city, town or village of this address.
        • companyName
          String companyName
          The name of the company at this address.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • country
          String country
          The country for this address.
        • county
          String county
          The county of this address.
        • customerRef
          CustomerRef customerRef
          The customer in the relationship.
        • defaultBillingAddress
          boolean defaultBillingAddress
          Specifies whether or not the address is the default billing address for the customer.
        • defaultShippingAddress
          boolean defaultShippingAddress
          Specifies whether or not the address is the default shipping address for the customer.
        • emailAddress
          String emailAddress
          The email address of the individual at this physical address.
        • firstName
          String firstName
          The first name of the individual at this address.
        • fullName
          String fullName
          The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.
        • id
          String id
          The context ID of the relationship.
        • isActive
          boolean isActive
          Whether this address is an active address of the owner.
        • lastName
          String lastName
          The last name of the individual at this address.
        • name
          String name
          The customer-provided name of the address.
        • phoneFax
          Phone phoneFax
          The fax number for this address.
        • phonePrimary
          Phone phonePrimary
          The primary phone number for this address.
        • phoneSecondary
          Phone phoneSecondary
          The secondary phone number for this address.
        • postalCode
          String postalCode
          Postal code or ZIP code for this address.
        • stateProvinceRegion
          String stateProvinceRegion
          The state, province or region of this address.

    • Class com.broadleafcommerce.customer.domain.CustomerNote

      class CustomerNote extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • author
          String author
          The user that created this note
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • created
          Instant created
          When this note was created
        • customerId
          String customerId
          The link to the customer that this note applies to
        • id
          String id
          The context ID of the customer note.
        • note
          String note
          The content of the note

    • Class com.broadleafcommerce.customer.domain.CustomerRef

      class CustomerRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • email
          String email
          The customer's email address.
        • id
          String id
          The customer's id.
        • name
          String name
          The customer's name
        • phoneNumber
          String phoneNumber
          The customer's phone number.
        • username
          String username
          The customer's username.

    • Class com.broadleafcommerce.customer.domain.CustomerSegment

      class CustomerSegment extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • active
          boolean active
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • customerSegmentType
          CustomerSegmentType customerSegmentType
          The type of this customer segment. This could be a customer set, rule-based, or external.
          See Also:
          • CustomerSegment.segmentMatchRule
          • CustomerSegment.realtimeMatchRule
          • CustomerSegment.ruleEvaluationType
        • description
          String description
          The description of this customer segment.
        • externalRef
          String externalRef
          If the CustomerSegment.customerSegmentType is CustomerSegmentType.EXTERNAL, then this stores the identifier for the external segment.
        • id
          String id
        • identifierType
          String identifierType
          Deprecated, for removal: This API element is subject to removal in a future version.
          This field is unused.
          For CustomerSegmentType.CUSTOMER_SET segment types, this represents the method used to associate a customer with this segment.

          Examples include email, customer ID, login username, etc.

        • internalEvaluationRequired
          boolean internalEvaluationRequired
          When CustomerSegment.ruleEvaluationType is DefaultCustomerSegmentRuleEvaluationType.REAL_TIME, indicates whether evaluation of the rule should be done in Customer Services specifically because it requires information that is only available in that service and not in the authorization token claims or a request attribute. This is typically something to avoid.
        • name
          String name
          The name of this customer segment.
        • priority
          Integer priority
          The priority of this customer segment. This is to enforce ordering when a customer may belong to multiple segments. A lower value indicates higher priority.
        • processingState
          String processingState
          The current processing state of this segment.

          While this value is set on every segment for simplicity, the default behavior is that this value is only used of on rule based customer segments. This field not applicable for static segments, such as customer sets.

          The following describes the default processing states, and how these states are determined:

          See Also:
        • realtimeMatchRule
          String realtimeMatchRule
          The rule(s) for this customer segment if rule based and using real-time evaluation. The default behavior is an SpEL filter. This is separate from CustomerSegment.segmentMatchRule so that it can be validating using RuleValidate.
          See Also:
          • CustomerSegment.ruleEvaluationType
        • ruleEvaluationType
          String ruleEvaluationType
          Indicates whether the CustomerSegment.segmentMatchRule is evaluated or CustomerSegment.realtimeMatchRule. This also determines the format of the rule such as RSQL for offline or SpEL for real-time.
          See Also:
        • segmentMatchRule
          String segmentMatchRule
          The rule(s) for this customer segment if rule based and using offline evaluation. The default behavior is an RSQL filter.
          See Also:
          • CustomerSegment.ruleEvaluationType

    • Class com.broadleafcommerce.customer.domain.CustomerSegmentRef

      class CustomerSegmentRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • externalRef
          String externalRef
          If the customerSegmentType is CustomerSegmentType.EXTERNAL, then this stores the identifier for the external segment.
        • id
          String id
        • name
          String name
          The name of this customer segment.
        • priority
          Integer priority
          The priority of this customer segment. This is to enforce ordering when a customer may belong to multiple segments. A lower value indicates higher priority.

    • Class com.broadleafcommerce.customer.domain.ISOCountry

      class ISOCountry extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.customer.domain.PaymentAccount

      class PaymentAccount extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountType
          String accountType
          Deprecated, for removal: This API element is subject to removal in a future version.
          This represents the type of payment that is associated with this account.
        • addressLine1
          String addressLine1
          Deprecated, for removal: This API element is subject to removal in a future version.
          Primary address information associated with this payment account, typically street name and building number.
        • addressLine2
          String addressLine2
          Deprecated, for removal: This API element is subject to removal in a future version.
          Secondary address information associated with this payment account, typically apartment, suite, or unit number.
        • addressLine3
          String addressLine3
          Deprecated, for removal: This API element is subject to removal in a future version.
          Tertiary address information associated with this payment account, typically for international addresses.
        • cardType
          String cardType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The specific card type, i.e. Visa, Mastercard, Discover, etc.
        • city
          String city
          Deprecated, for removal: This API element is subject to removal in a future version.
          The city, town or village of this billing address.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          Deprecated, for removal: This API element is subject to removal in a future version.
          A subset of Tracking information to expose the context state for this object.
        • country
          String country
          Deprecated, for removal: This API element is subject to removal in a future version.
          The country for this billing address.
        • county
          String county
          Deprecated, for removal: This API element is subject to removal in a future version.
          The county of this billing address.
        • customerRef
          CustomerRef customerRef
          Deprecated, for removal: This API element is subject to removal in a future version.
          The customer associated with this payment account.
        • deactivated
          boolean deactivated
          Deprecated, for removal: This API element is subject to removal in a future version.
          Whether this account is deactivated.
        • displayAttributes
          Map<String,String> displayAttributes
          Deprecated, for removal: This API element is subject to removal in a future version.
          General use map to capture any display properties for the Payment
        • displayName
          String displayName
          Deprecated, for removal: This API element is subject to removal in a future version.
          The user-friendly name provided for the payment account.
        • expirationMonth
          Integer expirationMonth
          Deprecated, for removal: This API element is subject to removal in a future version.
          The month the payment gateway account associated with this payment account will expire.
        • expirationYear
          Integer expirationYear
          Deprecated, for removal: This API element is subject to removal in a future version.
          The year the payment gateway account associated with this payment account will expire.
        • fullName
          String fullName
          Deprecated, for removal: This API element is subject to removal in a future version.
          The combined names of the individual at this billing address. It is considered better UX to use a full name field in place of separate first and last name fields.
        • gatewayType
          String gatewayType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The payment gateway associated with this payment account.
        • id
          String id
          Deprecated, for removal: This API element is subject to removal in a future version.
          The context ID of the payment account.
        • lastTransactionDateTime
          Instant lastTransactionDateTime
          Deprecated, for removal: This API element is subject to removal in a future version.
          The timestamp of the last successful transaction made by this payment account.
        • lastTransactionResultCode
          String lastTransactionResultCode
          Deprecated, for removal: This API element is subject to removal in a future version.
          The result code returned from the gateway on the last successful transaction.
        • maskedAccountNumber
          String maskedAccountNumber
          Deprecated, for removal: This API element is subject to removal in a future version.
          Partial information about the payment account, e.g. last four numbers of a credit card.
        • nameOnAccount
          String nameOnAccount
          Deprecated, for removal: This API element is subject to removal in a future version.
          The name associated with this payment account.
        • originatingPaymentId
          String originatingPaymentId
          Deprecated, for removal: This API element is subject to removal in a future version.
          The Payment.getId() that this payment account was created from. This is typically populated when a multi-use payment token is produced by executing a transaction against a single-use token via a checkout interaction.
        • paymentGatewayProperties
          Map<String,String> paymentGatewayProperties
          Deprecated, for removal: This API element is subject to removal in a future version.
          Map to capture any gateway-specific information needed to perform gateway transactions
        • phonePrimary
          Phone phonePrimary
          Deprecated, for removal: This API element is subject to removal in a future version.
          The primary phone number for this billing address.
        • phoneSecondary
          Phone phoneSecondary
          Deprecated, for removal: This API element is subject to removal in a future version.
          The secondary phone number for this billing address.
        • postalCode
          String postalCode
          Deprecated, for removal: This API element is subject to removal in a future version.
          Postal code or ZIP code for this billing address.
        • stateProvinceRegion
          String stateProvinceRegion
          Deprecated, for removal: This API element is subject to removal in a future version.
          The state, province or region of this address.

    • Class com.broadleafcommerce.customer.domain.PaymentAccountSummary

      class PaymentAccountSummary extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountType
          String accountType
          Deprecated, for removal: This API element is subject to removal in a future version.
          This represents the type of payment that is associated with this account.
        • addressLine1
          String addressLine1
          Deprecated, for removal: This API element is subject to removal in a future version.
          Primary address information associated with this payment account, typically street name and building number.
        • addressLine2
          String addressLine2
          Deprecated, for removal: This API element is subject to removal in a future version.
          Secondary address information associated with this payment account, typically apartment, suite, or unit number.
        • addressLine3
          String addressLine3
          Deprecated, for removal: This API element is subject to removal in a future version.
          Tertiary address information associated with this payment account, typically for international addresses.
        • cardType
          String cardType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The specific card type, i.e. Visa, Mastercard, Discover, etc.
        • city
          String city
          Deprecated, for removal: This API element is subject to removal in a future version.
          The city, town or village of this billing address.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          Deprecated, for removal: This API element is subject to removal in a future version.
          A subset of Tracking information to expose the context state for this object.
        • country
          String country
          Deprecated, for removal: This API element is subject to removal in a future version.
          The country for this billing address.
        • county
          String county
          Deprecated, for removal: This API element is subject to removal in a future version.
          The county of this billing address.
        • customerRef
          CustomerRef customerRef
          Deprecated, for removal: This API element is subject to removal in a future version.
          The customer associated with this payment account.
        • deactivated
          boolean deactivated
          Deprecated, for removal: This API element is subject to removal in a future version.
          Whether this account is deactivated.
        • displayAttributes
          Map<String,String> displayAttributes
          Deprecated, for removal: This API element is subject to removal in a future version.
          General use map to capture any display properties for the Payment
        • displayName
          String displayName
          Deprecated, for removal: This API element is subject to removal in a future version.
          The user-friendly name provided for the payment account.
        • expirationMonth
          Integer expirationMonth
          Deprecated, for removal: This API element is subject to removal in a future version.
          The month the payment gateway account associated with this payment account will expire.
        • expirationYear
          Integer expirationYear
          Deprecated, for removal: This API element is subject to removal in a future version.
          The year the payment gateway account associated with this payment account will expire.
        • fullName
          String fullName
          Deprecated, for removal: This API element is subject to removal in a future version.
          The combined names of the individual at this billing address. It is considered better UX to use a full name field in place of separate first and last name fields.
        • gatewayType
          String gatewayType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The payment gateway associated with this payment account.
        • id
          String id
          Deprecated, for removal: This API element is subject to removal in a future version.
          The context ID of the payment account.
        • lastTransactionDateTime
          Instant lastTransactionDateTime
          Deprecated, for removal: This API element is subject to removal in a future version.
          The timestamp of the last successful transaction made by this payment account.
        • lastTransactionResultCode
          String lastTransactionResultCode
          Deprecated, for removal: This API element is subject to removal in a future version.
          The result code returned from the gateway on the last successful transaction.
        • maskedAccountNumber
          String maskedAccountNumber
          Deprecated, for removal: This API element is subject to removal in a future version.
          Partial information about the payment account, e.g. last four numbers of a credit card.
        • nameOnAccount
          String nameOnAccount
          Deprecated, for removal: This API element is subject to removal in a future version.
          The name associated with this payment account.
        • originatingPaymentId
          String originatingPaymentId
          Deprecated, for removal: This API element is subject to removal in a future version.
          The Payment.getId() that this payment account was created from. This is typically populated when a multi-use payment token is produced by executing a transaction against a single-use token via a checkout interaction.
        • phonePrimary
          Phone phonePrimary
          Deprecated, for removal: This API element is subject to removal in a future version.
          The primary phone number for this billing address.
        • phoneSecondary
          Phone phoneSecondary
          Deprecated, for removal: This API element is subject to removal in a future version.
          The secondary phone number for this billing address.
        • postalCode
          String postalCode
          Deprecated, for removal: This API element is subject to removal in a future version.
          Postal code or ZIP code for this billing address.
        • stateProvinceRegion
          String stateProvinceRegion
          Deprecated, for removal: This API element is subject to removal in a future version.
          The state, province or region of this address.

    • Class com.broadleafcommerce.customer.domain.Phone

      class Phone extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • countryCode
          String countryCode
          The country calling code that acts as a prefix to the main telephone number.
        • extension
          String extension
          The internal extension for this phone.
        • phoneNumber
          String phoneNumber
          The telephone number, including the area code.

    • Class com.broadleafcommerce.customer.domain.ResolveCustomerSegmentResponse

      class ResolveCustomerSegmentResponse extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.customer.domain.ResolveCustomerSegmentsRequest

      class ResolveCustomerSegmentsRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountHierarchy
          List<String> accountHierarchy
          The hierarchy of accounts, from the root account to the account member's account.

          For example, if we have this account setup, rootAcct -> subAcct (child of rootAcct) -> subSubAcct (child of subAcct), this field would be [rootAcct, subAcct, subSubAcct]. This is useful to have queries include sub-accounts.

        • accountId
          String accountId
          The ID of the account the user belongs to.
        • attributes
          Map<String,Object> attributes
          Additional, arbitrary request attributes.
        • email
          String email
          The user's email.
        • fullName
          String fullName
          The user's full name.
        • phoneNumber
          String phoneNumber
          The user's phone number.
        • prefetchedSegmentIdsToEvaluate
          List<String> prefetchedSegmentIdsToEvaluate
          List of ids of any prefetched CustomerSegments to evaluate whether they apply to the request. This list will be used instead of looking up all rule-based or directly assigned customer segments.

          Typically, this will only include the ids of rule-based segments with evaluation type DefaultCustomerSegmentRuleEvaluationType.REAL_TIME as other segments should already be known from the user's auth token claims.

        • registered
          boolean registered
          Defines whether the user is registered. If false, then the user is considered anonymous.
        • rootAccountId
          String rootAccountId
          The ID of the root account the account member belongs to.
        • userId
          String userId
          The user's id.
        • username
          String username
          The user's username.

    • Class com.broadleafcommerce.customer.domain.SegmentMember

      class SegmentMember extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
        • customer
          Customer customer
          The customer assigned to the SegmentMember.customerSegment.
        • customerSegment
          CustomerSegment customerSegment
          The customer segment the SegmentMember.customer belongs to.
        • id
          String id
          The id of this SegmentMember
        • source
          String source
          The source of creation of this segment customer relationship.
          See Also:

    • Class com.broadleafcommerce.customer.domain.SegmentProcessHistory

      class SegmentProcessHistory extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • bulkUpdate
          com.broadleafcommerce.bulk.domain.BulkUpdate bulkUpdate
          The Bulk process performed on the segment.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • created
          Instant created
          The creation time of this segment process
        • customerSegment
          CustomerSegment customerSegment
          The Segment the bulk process was performed on.
        • id
          String id

  • Package com.broadleafcommerce.customer.messaging.domain

    • Class com.broadleafcommerce.customer.messaging.domain.AccountRole

      class AccountRole extends Object implements Serializable

    • Class com.broadleafcommerce.customer.messaging.domain.AccountRole.UserRoleRef

      class UserRoleRef extends Object implements Serializable

    • Class com.broadleafcommerce.customer.messaging.domain.User

      class User extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountRoles
          List<AccountRole> accountRoles
          Roles this user has under specific Account contexts.
        • attributes
          Map<String,Object> attributes
          Additional attributes of a user. All of a User's attributes that are available at the time of registration are available.
        • customerContextId
          String customerContextId
          This field only applies to UserType.CUSTOMER users.

          The id of the customer context this user is a member of. If this is set, this user is restricted to this customer context.

        • email
          String email
          The user's email address.
        • externalId
          String externalId
          Intended to hold any unique identifier for this user as known by an external (non-BLC) system. For example, many implementations may integrate or import/export data from other systems that manage their own unique identifiers.
        • firstName
          String firstName
          The first name of the user, if the fullName is not being used for the user.
          See Also:
        • fullName
          String fullName
          The full name of the user.
          See Also:
        • id
          String id
        • lastName
          String lastName
          The last name of the user, if the fullName is not being used for the user.
          See Also:
        • lastUpdated
          Instant lastUpdated
          Indicates when this record was last updated.
        • locked
          boolean locked
          Indicates the user has been locked due to too many failed login attempts.
        • middleName
          String middleName
          The middle name of the user, if the fullName is not being used for the user.
          See Also:
        • phone
          String phone
          The user's phone number
        • serviceId
          String serviceId
          If the auth service received this user from a BLC service (ex: the admin user service or the customer service), this field will be the ID value used by that service for this user.

          If this value is set, there should also be a value set for User.type.

          Only if both values are non-null, a combination of this field and User.type will be unique across all records in the authentication service. There is no uniqueness guarantee for records which have a null service ID or null User.type.

          See Also:
          • User.type
        • tenantId
          String tenantId
          The id of the tenant this user is associated with.
        • type
          String type
          Represents the type of user this is. This value must be supplied if User.serviceId is set.
          See Also:
        • username
          String username
          What this user uses to actually log in. Often the same as User.email.

    • Class com.broadleafcommerce.customer.messaging.domain.UserCreatedEvent

      class UserCreatedEvent extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • attributes
          Map<String,Object> attributes
          Additional custom information that was provided as part of the user registration process.

          Client implementations may choose to populate and utilize this field for custom behavior.

        • preview
          boolean preview
          Indicates whether the user was created from a preview context.
        • user
          User user

  • Package com.broadleafcommerce.customer.provider.jpa.domain

  • Package com.broadleafcommerce.customer.provider.jpa.messaging.search

  • Package com.broadleafcommerce.customer.segments

  • Package com.broadleafcommerce.customer.service

  • Package com.broadleafcommerce.customer.service.bulk

  • Package com.broadleafcommerce.customer.service.exception

  • Package com.broadleafcommerce.customer.service.provider.domain

    • Class com.broadleafcommerce.customer.service.provider.domain.Address

      class Address extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,Object> additionalAttributes
          Map holding any additional attributes passed in the request not matching any defined properties.
        • addressLine1
          String addressLine1
          Primary address information, typically street name and building number.
        • addressLine2
          String addressLine2
          Secondary address information, like apartment, suite, or unit number.
        • addressLine3
          String addressLine3
          Tertiary address information, typically for international addresses.
        • city
          String city
          The city, town or village of this address.
        • companyName
          String companyName
          The name of the company at this address.
        • country
          String country
          The country for this address.
        • county
          String county
          The county of this address.
        • emailAddress
          String emailAddress
          The email address of the individual at this physical address.
        • firstName
          String firstName
          The first name of the individual at this address.
        • fullName
          String fullName
          The combined names of the individual at this address. It is considered better UX to use a full name field in place of separate first and last name fields.
        • id
          String id
          The ID of the address.
        • isActive
          boolean isActive
          Whether this address is an active address of the owner.
        • lastName
          String lastName
          The last name of the individual at this address.
        • phoneFax
          Phone phoneFax
          The fax number for this address.
        • phonePrimary
          Phone phonePrimary
          The primary phone number for this address.
        • phoneSecondary
          Phone phoneSecondary
          The secondary phone number for this address.
        • postalCode
          String postalCode
          Postal code or ZIP code for this address.
        • stateProvinceRegion
          String stateProvinceRegion
          The state, province or region of this address.

    • Class com.broadleafcommerce.customer.service.provider.domain.Payment

      class Payment extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • addressByType
          Map<String,Address> addressByType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The collection of related addresses that may include billing or shipping addresses
        • attributes
          Map<String,String> attributes
          Deprecated, for removal: This API element is subject to removal in a future version.
          General use map to capture any additional attributes needed for this Payment
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          Deprecated, for removal: This API element is subject to removal in a future version.
          A subset of Tracking information to expose the context state for this object.
        • customerRef
          CustomerRef customerRef
          Deprecated, for removal: This API element is subject to removal in a future version.
          A reference to the customer that owns this payment.
        • displayAttributes
          Map<String,String> displayAttributes
          Deprecated, for removal: This API element is subject to removal in a future version.
          General use map to capture any display properties for this Payment
        • gatewayType
          String gatewayType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
        • id
          String id
          Deprecated, for removal: This API element is subject to removal in a future version.
          The id of this payment.
        • name
          String name
          Deprecated, for removal: This API element is subject to removal in a future version.
          The name of this payment. This name is typically something like "Visa ending in 1234".
        • ownerId
          String ownerId
          Deprecated, for removal: This API element is subject to removal in a future version.
          The id of the entity that owns this payment. For example, this may be a cart id, or a subscription billing cycle id.
        • ownerType
          String ownerType
          Deprecated, for removal: This API element is subject to removal in a future version.
          Describes the owner of the payment. For example, the payment could have originated with a cart or a subscription, therefore this value might be CART or SUBSCRIPTION.
        • paymentMethodProperties
          Map<String,String> paymentMethodProperties
          Deprecated, for removal: This API element is subject to removal in a future version.
          Map to capture any information about the payment method needed to perform gateway transactions
        • shouldSavePaymentForFutureUse
          boolean shouldSavePaymentForFutureUse
          Deprecated, for removal: This API element is subject to removal in a future version.
          Should the payment method be saved to the owning user.
        • shouldSavePaymentToCustomer
          boolean shouldSavePaymentToCustomer
          Deprecated, for removal: This API element is subject to removal in a future version.
          since 1.7.2, in favor of Payment.shouldSavePaymentForFutureUse to support owning user types other than a customer (i.e. account).
        • transactions
          List<PaymentTransaction> transactions
          Deprecated, for removal: This API element is subject to removal in a future version.
          Transaction data representing each payment gateway interaction related to this payment.
        • type
          String type
          Deprecated, for removal: This API element is subject to removal in a future version.
          The type of this payment like Credit Card or Gift Card.

    • Class com.broadleafcommerce.customer.service.provider.domain.PaymentTransaction

      class PaymentTransaction extends Object implements Serializable

      • Serialized Fields

        • attributes
          Map<String,String> attributes
          Deprecated, for removal: This API element is subject to removal in a future version.
          Map of specific attributes that have been gathered from the raw response. This should be used for data points that are to be used programmatically. For example, a gateway-specific transaction id that can be used to capture or refund the transaction.
        • dateRecorded
          Instant dateRecorded
          Deprecated, for removal: This API element is subject to removal in a future version.
          The timestamp when this transaction response was recorded
        • declineType
          String declineType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The type of transaction failure (hard vs soft failure)
        • failureType
          String failureType
          Deprecated, for removal: This API element is subject to removal in a future version.
          The type of transaction failure
        • gatewayResponseCode
          String gatewayResponseCode
          Deprecated, for removal: This API element is subject to removal in a future version.
          The response code provided by the payment gateway which may represent a success or failure
        • id
          String id
          Deprecated, for removal: This API element is subject to removal in a future version.
          The id of this payment transaction.
        • parentTransactionId
          String parentTransactionId
          Deprecated, for removal: This API element is subject to removal in a future version.
          The id of the parent PaymentTransaction. Necessary for operations on a payment that require something to have happened beforehand. For instance, an authorize transaction would not have a parent but a capture must have an authorize parent transaction and a refund must have a capture parent transaction. The full set of expected parent-child transaction relationships are as follows:
          • Child Transaction -> Parent Transaction
          • Reverse Authorize -> Authorize
          • Capture -> Authorize
          • Refund -> Capture
          • Refund -> AuthorizeAndCapture
        • status
          String status
          Deprecated, for removal: This API element is subject to removal in a future version.
          The status of the transaction
        • transactionReferenceId
          String transactionReferenceId
          Deprecated, for removal: This API element is subject to removal in a future version.
          The transaction id known by the payment gateway. This reference can be used to link the request to the gateway's record of the transaction in the case that the calling application does not receive a response from the gateway.
        • type
          String type
          Deprecated, for removal: This API element is subject to removal in a future version.
          The type of this transaction (authorize, capture, refund, etc.)

  • Package com.broadleafcommerce.customer.web

  • Package com.broadleafcommerce.customer.web.endpoint.domain

    • Class com.broadleafcommerce.customer.web.endpoint.domain.RegisterAccountMemberRequest

      class RegisterAccountMemberRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • account
          AccountRef account
          The account in the relationship.
        • accountRoleIds
          Set<String> accountRoleIds
          The roles assigned to this AccountMember.
        • active
          boolean active
          Specifies whether this register request for an account member represents an invite (false) or an actual account member who has accepted the invite or was added via the Admin portal (true).
        • additionalPhones
          List<AdditionalPhone> additionalPhones
          Deprecated, for removal: This API element is subject to removal in a future version.
          Use the customer's phone numbers instead
          Additional phone numbers associated with the account member.
        • attributes
          Map<String,Object> attributes
          Additional attributes that are used to describe the account member
        • customer
          CustomerRef customer
          A pre-existing customer that is being granted access to the account.
        • email
          String email
          Deprecated, for removal: This API element is subject to removal in a future version.
          We use the customer's email instead.
          Email address for the account member.
        • firstName
          String firstName
          Deprecated, for removal: This API element is subject to removal in a future version.
          We use the customer's name instead.
          First name the account member. This field is only relevant if a pre-existing customer is not identified by RegisterAccountMemberRequest.customer.
        • lastName
          String lastName
          Deprecated, for removal: This API element is subject to removal in a future version.
          We use the customer's name instead.
          Last name the account member. This field is only relevant if a pre-existing customer is not identified by RegisterAccountMemberRequest.customer.
        • phone
          Phone phone
          Deprecated, for removal: This API element is subject to removal in a future version.
          Use the customer's phone numbers instead
          The primary phone number of the account member.
        • username
          String username
          Deprecated, for removal: This API element is subject to removal in a future version.
          We use the customer's username instead.
          Username for the account member. This field is only relevant if a pre-existing customer is not identified by RegisterAccountMemberRequest.customer.

    • Class com.broadleafcommerce.customer.web.endpoint.domain.UpdateAccountMemberRequest

      class UpdateAccountMemberRequest extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountRoleIds
          Set<String> accountRoleIds
          The roles assigned to this AccountMember.
        • additionalPhones
          List<AdditionalPhone> additionalPhones
          Deprecated, for removal: This API element is subject to removal in a future version.
          Use the customer's phone numbers instead
          Additional phone numbers associated with the account member.
        • attributes
          Map<String,Object> attributes
          Additional attributes that are used to describe the account member
        • email
          String email
          Deprecated, for removal: This API element is subject to removal in a future version.
          We use the customer's email instead.
          An updated email address for the account member.
        • phone
          Phone phone
          Deprecated, for removal: This API element is subject to removal in a future version.
          Use the customer's phone numbers instead
          An updated primary phone number of the account member.