Serialized Form (Broadleaf Order Common 1.4.0-GA API)

Package com.broadleafcommerce.order.common.domain
- Class com.broadleafcommerce.order.common.domain.Address extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - firstName
```
String firstName
```
      The first name of the individual at this address.
    - lastName
```
String lastName
```
      The last 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.
    - emailAddress
```
String emailAddress
```
      The email address of the individual at this physical address.
    - companyName
```
String companyName
```
      The name of the company at this address.
    - 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.
    - stateProvinceRegion
```
String stateProvinceRegion
```
      The state, province or region of this address.
    - county
```
String county
```
      The county of this address.
    - country
```
String country
```
      The country for this address.
    - postalCode
```
String postalCode
```
      Postal code or ZIP code for this address.
    - phonePrimary
```
Phone phonePrimary
```
      The primary phone number for this address.
    - phoneSecondary
```
Phone phoneSecondary
```
      The secondary phone number for this address.
    - phoneFax
```
Phone phoneFax
```
      The fax number for this address.
    - isDefault
```
boolean isDefault
```
      Whether this address is the default address of the owner.
    - isActive
```
boolean isActive
```
      Whether this address is an active address of the owner.
    - additionalAttributes
```
Map<K,V> additionalAttributes
```
      Map holding any additional attributes passed in the request not matching any defined properties.
- Class com.broadleafcommerce.order.common.domain.Adjustment extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - offerRef
```
OfferRef offerRef
```
      A reference to the offer that originated this adjustment.
    - amount
```
javax.money.MonetaryAmount amount
```
      The amount of this adjustment.
    - codeUsed
```
String codeUsed
```
      The code used (if any) that triggered the application of the offer for this adjustment.
    - alternateAdjustmentSource
```
String alternateAdjustmentSource
```
      If this adjustment is not created by an offer this parameter will specify the source of adjustment.
      
      See Also:
      
      DefaultAlternateAdjustmentSource
- Class com.broadleafcommerce.order.common.domain.AttributeChoiceValue extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - optionLabel
```
String optionLabel
```
      The label shown to customers for the option.
    - label
```
String label
```
      What the customer sees for display. For example, text in the case of sizes or a hex value in the case of colors. Can diverge from AttributeChoiceValue.value which is what was added to the cart
    - value
```
String value
```
      The value based on what the user selected.
- Class com.broadleafcommerce.order.common.domain.CampaignRef extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - campaignTrackingId
```
String campaignTrackingId
```
      A text identifier used to track a specific campaign.
    - campaignCode
```
String campaignCode
```
      The user provided text code that refers to the campaign.
- Class com.broadleafcommerce.order.common.domain.FulfillmentOption extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - name
```
String name
```
      The name of this option.
    - description
```
String description
```
      The description of this option.
    - useFlatRates
```
boolean useFlatRates
```
      Whether to use flat rates for this option.
    - taxCode
```
String taxCode
```
      The tax code for this option.
    - taxable
```
boolean taxable
```
      Whether any shipping prices should be taxable for this option.
- Class com.broadleafcommerce.order.common.domain.OfferItemDetail extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - offerId
```
String offerId
```
      The offer id where this item is a qualifier or target of.
    - itemId
```
String itemId
```
      The id of the item that is a qualifier or target.
    - quantity
```
int quantity
```
      The quantity of the item that is a qualifier or target.
- Class com.broadleafcommerce.order.common.domain.OfferRef extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - id
```
String id
```
      The ID of the offer.
    - name
```
String name
```
      The name of the offer. Often used to indicate to a customer what offers are applied to their cart.
    - description
```
String description
```
      A description of what benefits the offer provides to a customer.
    - cartLabel
```
String cartLabel
```
      A label for this offer typically used by the storefront.
    - attributes
```
Map<K,V> attributes
```
      Dynamic attributes that are a part of the offer.
- Class com.broadleafcommerce.order.common.domain.OverrideDetail extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - userId
```
String userId
```
      The user ID of the admin user who performed the override.
    - author
```
String author
```
      The admin user who performed the override.
    - type
```
String type
```
      The type of override performed, e.g. a Cart Item Price override or a Fulfillment Group Price override.
      
      See Also:
      
      DefaultOverrideTypes
    - originalAmount
```
javax.money.MonetaryAmount originalAmount
```
      The amount contained in the field prior to being overridden.
    - overrideAmount
```
javax.money.MonetaryAmount overrideAmount
```
      The amount which the field has been overridden to.
    - reason
```
String reason
```
      The reason the override was performed, for example, "Price Match".
    - comment
```
String comment
```
      The optional, long-form comment explaining any extra context for the override.
- Class com.broadleafcommerce.order.common.domain.Payment extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The id of this payment.
    - name
```
String name
```
      The name of this payment. This name is typically something like "Visa ending in 1234".
    - customerPaymentAccountId
```
String customerPaymentAccountId
```
      The id of the customer's saved payment account that was used to build this payment object. Note: This property is only relevant if the user desires to use a saved payment account to pay for their order. Otherwise, this value should remain unset.
    - isSingleUsePaymentMethod
```
boolean isSingleUsePaymentMethod
```
      Whether or not the underlying payment method can only be used once. In most cases, we're managing a single-use token that represents a credit card. This flag is especially important for managing payments with successful transactions. In those cases, the token has already been used and cannot be reused. If we need modify the payment's amount, then we may actually need to archive the existing payment, and create a new payment, with a new underlying token. Additionally, this flag is helpful when needing to re-authorize an expired authorization transaction. In that case, if the payment represents a single-use payment method, then the re-authorization may not be possible, and you'll need to seek an alternative form of payment.
    - shouldSavePaymentToCustomer
```
boolean shouldSavePaymentToCustomer
```
      Should the payment method be saved to the customer
    - status
```
String status
```
      Deprecated. in favor of PaymentSummary
      
      The status of the payment. This status is not populated by default or persisted- it is determined during runtime based on the statuses of the transactions of this payment.
    - type
```
String type
```
      The type of this payment like Credit Card or Gift Card.
    - gatewayType
```
String gatewayType
```
      The gateway used to process this payment. Only a SINGLE payment gateway can modify transactions on a particular payment.
    - amount
```
javax.money.MonetaryAmount amount
```
      The amount for which this payment is allotted. The summation of all of the payments for a particular cart should equal the cart's total. If specified, the amount details (Payment.subtotal, Payment.adjustmentsTotal, Payment.fulfillmentTotal, & Payment.taxTotal) should sum together to equal this amount.
    - subtotal
```
javax.money.MonetaryAmount subtotal
```
      The payment's total usually excluding adjustments, tax, and shipping.
    - adjustmentsTotal
```
javax.money.MonetaryAmount adjustmentsTotal
```
      The payment's adjustments (a.k.a discounts) total, usually excluding shipping/fulfillment discounts.
    - fulfillmentTotal
```
javax.money.MonetaryAmount fulfillmentTotal
```
      The payment's total fulfillment cost
    - taxTotal
```
javax.money.MonetaryAmount taxTotal
```
      The payment's total tax cost
    - billingAddress
```
Address billingAddress
```
      The billing address associated with this payment.
    - paymentGatewayProperties
```
Map<K,V> paymentGatewayProperties
```
      Map to capture any gateway-specific information needed to perform gateway transactions
    - attributes
```
Map<K,V> attributes
```
      General use map to capture any additional attributes needed for this Payment
    - displayAttributes
```
Map<K,V> displayAttributes
```
      General use map to capture any display properties for this Payment
    - transactions
```
List<E> transactions
```
      Transaction data representing each payment gateway interaction related to this payment.
    - archived
```
boolean archived
```
      Whether or not this payment has been archived.
- Class com.broadleafcommerce.order.common.domain.PaymentSummary extends Object implements Serializable
  - Serialized Fields
    - paymentId
```
String paymentId
```
      See Also:
      
      Payment.getId()
    - name
```
String name
```
      See Also:
      
      Payment.getName()
    - gatewayType
```
String gatewayType
```
      See Also:
      
      Payment.getGatewayType()
    - attributes
```
Map<K,V> attributes
```
      See Also:
      
      Payment.getAttributes()
    - displayAttributes
```
Map<K,V> displayAttributes
```
      See Also:
      
      Payment.getDisplayAttributes()
    - isSingleUsePaymentMethod
```
Boolean isSingleUsePaymentMethod
```
      See Also:
      
      Payment.isSingleUsePaymentMethod()
    - amount
```
javax.money.MonetaryAmount amount
```
      See Also:
      
      Payment.getAmount()
    - subtotal
```
javax.money.MonetaryAmount subtotal
```
      See Also:
      
      Payment.getSubtotal()
    - adjustmentsTotal
```
javax.money.MonetaryAmount adjustmentsTotal
```
      See Also:
      
      Payment.getAdjustmentsTotal()
    - fulfillmentTotal
```
javax.money.MonetaryAmount fulfillmentTotal
```
      See Also:
      
      Payment.getFulfillmentTotal()
    - taxTotal
```
javax.money.MonetaryAmount taxTotal
```
      See Also:
      
      Payment.getTaxTotal()
    - amountAuthorized
```
javax.money.MonetaryAmount amountAuthorized
```
      The total authorized amount for capture. This value is calculated as "total authorized - total reverse-authed".
    - amountCaptured
```
javax.money.MonetaryAmount amountCaptured
```
      The total captured amount. This value is calculated as "total captured - total refunded - total voided".
    - amountRefunded
```
javax.money.MonetaryAmount amountRefunded
```
      The total refunded amount.
    - amountVoided
```
javax.money.MonetaryAmount amountVoided
```
      The total voided amount.
    - amountSettled
```
javax.money.MonetaryAmount amountSettled
```
      The total settled amount.
    - amountCredited
```
javax.money.MonetaryAmount amountCredited
```
      The total detached credit amount.
- Class com.broadleafcommerce.order.common.domain.PaymentTransaction extends Object implements Serializable
  - Serialized Fields
    - id
```
String id
```
      The id of this payment transaction.
    - type
```
String type
```
      The type of this transaction (authorize, capture, refund, etc.)
    - managementState
```
String managementState
```
      The state of this transaction - e.g. whether the transaction is scheduled for reversal or if it's being used in an active checkout. If the transaction was not successful, then we expect this value to be null.
      
      See Also:
      
      TransactionManagementState
    - status
```
String status
```
      The status of the transaction
      
      See Also:
      
      TransactionStatus
    - transactionReferenceId
```
String transactionReferenceId
```
      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.
    - requestId
```
String requestId
```
      The id used to represent the request that produced this transaction. This is normally related to a checkout submission request.
    - amount
```
javax.money.MonetaryAmount amount
```
      The amount related to this transaction. Depending on the PaymentTransaction.type, this may be the amount authorized, captured, refunded, etc.
    - dateRecorded
```
Instant dateRecorded
```
      The timestamp when this transaction response was recorded
    - gatewayResponseCode
```
String gatewayResponseCode
```
      The response code provided by the payment gateway which may represent a success or failure
    - failureType
```
String failureType
```
      The type of transaction failure
    - declineType
```
String declineType
```
      The type of transaction failure (hard vs soft failure)
    - rawResponse
```
String rawResponse
```
      The string representation of the serialized response from the gateway. This is usually the complete request parameter map serialized in string form.
    - parentTransactionId
```
String parentTransactionId
```
      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
      
      Void -> Capture
      
      Void -> AuthorizeAndCapture
      
      Settle -> Capture
      
      Refund -> Capture
      
      Refund -> AuthorizeAndCapture
      
      Refund -> Settle
    - attributes
```
Map<K,V> attributes
```
      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.
      
      See Also:
      
      PaymentTransactionAdditionalFieldType
    - customerIpAddress
```
String customerIpAddress
```
      The customer IP address that instigated this transaction
    - indeterminateResult
```
boolean indeterminateResult
```
      Tells if this transaction has an indeterminate result.
      Having an indeterminate result means that the true outcome of the transaction is not known. For example, if a transaction is sent to the payment processor but a network error occurred, it is not known to us whether the user was actually charged or not (thus, the result is indeterminate).
      Transactions should be marked as indeterminate when sending to the payment processor, and then unmarked once a response is received, understood, and recorded. This means that a transaction in an indeterminate result state is expected during the sending to processor phase. However, if the transaction remains in that state for an excessive amount of time, something likely went wrong and the transaction will need to be reconciled. If the transaction changes from the sending to processor status but remains indeterminate, the transaction will also require reconciliation in that scenario.
      Some situations which may lead to an indeterminate result:
      
      A transaction is sent to the processor, but a network error prevents us from receiving the response
      
      A transaction is sent to the processor, but the processor returns an unexpected error (e.g. 500 internal server error)
      
      A transaction is sent to the processor and a response is received, but cannot be recorded because Cart Services is down
      
      A transaction is sent to the processor and a response is received, but cannot be recorded because the database is down
- Class com.broadleafcommerce.order.common.domain.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.
    - phoneNumber
```
String phoneNumber
```
      The telephone number, including the area code.
    - extension
```
String extension
```
      The internal extension for this phone.
- Class com.broadleafcommerce.order.common.domain.Voucher extends Object implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - offerId
```
String offerId
```
      The OfferRef.getId() of the voucher offer.
    - voucherCampaignId
```
String voucherCampaignId
```
      The id of the voucher campaign, which will be used for voucher code generation later on.
    - generatedCampaignCode
```
String generatedCampaignCode
```
      The generated campaign code for this voucher.
    - validationSuccessful
```
boolean validationSuccessful
```
      Indicates whether the post-checkout voucher validation was successful.
    - generationSuccessful
```
boolean generationSuccessful
```
      Indicates whether the post-checkout voucher code generation was successful.
    - errorMessage
```
String errorMessage
```
      The error message from voucher code generation for this voucher.

Serialized Form

Package com.broadleafcommerce.order.common.domain

Class com.broadleafcommerce.order.common.domain.Address extends Object implements Serializable

Serialized Fields

firstName

lastName

fullName

emailAddress

companyName

addressLine1

addressLine2

addressLine3

city

stateProvinceRegion

county

country

postalCode

phonePrimary

phoneSecondary

phoneFax

isDefault

isActive

additionalAttributes

Class com.broadleafcommerce.order.common.domain.Adjustment extends Object implements Serializable

Serialized Fields

offerRef

amount

codeUsed

alternateAdjustmentSource

Class com.broadleafcommerce.order.common.domain.AttributeChoiceValue extends Object implements Serializable

Serialized Fields

optionLabel

label

value

Class com.broadleafcommerce.order.common.domain.CampaignRef extends Object implements Serializable

Serialized Fields

campaignTrackingId

campaignCode

Class com.broadleafcommerce.order.common.domain.FulfillmentOption extends Object implements Serializable

Serialized Fields

name

description

useFlatRates

taxCode

taxable

Class com.broadleafcommerce.order.common.domain.OfferItemDetail extends Object implements Serializable

Serialized Fields

offerId

itemId

quantity

Class com.broadleafcommerce.order.common.domain.OfferRef extends Object implements Serializable

Serialized Fields

id

name

description

cartLabel

attributes

Class com.broadleafcommerce.order.common.domain.OverrideDetail extends Object implements Serializable

Serialized Fields

userId

author

type

originalAmount

overrideAmount

reason

comment

Class com.broadleafcommerce.order.common.domain.Payment extends Object implements Serializable

Serialized Fields

id

name

customerPaymentAccountId

isSingleUsePaymentMethod

shouldSavePaymentToCustomer

status

type

gatewayType

amount

subtotal

adjustmentsTotal

fulfillmentTotal