Serialized Form

  • Package com.broadleafcommerce.order.client.domain

    • Class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaim

      class FulfillmentCaptureClaim extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • amount
          javax.money.MonetaryAmount amount
          The amount that has been captured or claimed by the fulfillment against the payment.
        • attributes
          Map<String,Object> attributes
          Additional attributes for this claim.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • currency
          javax.money.CurrencyUnit currency
          The currency unit used for monetary amounts.
        • id
          String id
          The context ID of this claim.
        • orderFulfillmentId
          String orderFulfillmentId
          The context ID of the order fulfillment.
        • paymentId
          String paymentId
          The context ID of the payment that the claimed transaction belongs to.
        • requestId
          String requestId
          The id representing the request to claim/execute one or more transactions.
        • type
          String type
          Deprecated, for removal: This API element is subject to removal in a future version.
          In favor of using the TransactionSummary concept from PaymentTransactionServices, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
          Identifies whether the FulfillmentCaptureClaim.amount is for a new capture or for a claim against a previous capture.
          See Also:

    • Class com.broadleafcommerce.order.client.domain.FulfillmentCaptureClaimSummary

      class FulfillmentCaptureClaimSummary extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • claims
          List<FulfillmentCaptureClaim> claims
          The list of FulfillmentCaptureClaims for the OrderFulfillment.
        • discriminatorId
          String discriminatorId
          The id of the discriminating entity for filtering the claims, usually the id of the order fulfillment or payment.

          For example, if the summary was built for a list of FulfillmentCaptureClaims with the same order fulfillment, then the value would be the order fulfillment id.

        • discriminatorType
          String discriminatorType
          The type of discriminating entity for filtering the claims, usually order fulfillment or payment.
          See Also:
        • totalAmountCaptured
          javax.money.MonetaryAmount totalAmountCaptured
          Deprecated, for removal: This API element is subject to removal in a future version.
          In favor of using the TransactionSummary concept from PaymentTransactionServices to understand the amount captured for a fulfillment, instead of recording captured amounts for fulfillments in the FulfillmentCaptureClaim structure.
          Total amount captured.
        • totalAmountClaimed
          javax.money.MonetaryAmount totalAmountClaimed
          Total amount claimed.

    • Class com.broadleafcommerce.order.client.domain.ImageAssetRef

      class ImageAssetRef extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • altText
          String altText
          Text that corresponds to the HTML alt attribute that should be used when this asset is rendered in a browser. This is used as an alternative for screen-readers and as an SEO enhancement describing the asset.
        • contentUrl
          String contentUrl
          The fully-resolvable content-URL to the binary data of the asset. It should be possible for a browser to hit this URL to retrieve the binary data.
        • title
          String title
          Text that corresponds to the HTML title attribute that should be used when this asset is rendered in a browser. This is used a tooltip or caption.

    • Class com.broadleafcommerce.order.client.domain.Order

      class Order 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 query all the orders that belong to the same non-root account and its sub-accounts.

        • accountId
          String accountId
          The ID of the account the account member belongs to.
        • adjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> adjustments
          Adjustments to order pricing that were applied to OrderPricing.getSubtotal().
        • approverEmail
          String approverEmail
          The order approver's email address.

          This field is only needed for B2B orders to represent the order approver's email address. For B2C orders, we don't expect a value to be provided for this field.

        • attributeChoices
          Map<String,com.broadleafcommerce.order.common.domain.AttributeChoiceValue> attributeChoices
          Attribute choices for this order driven by its items' product options, where each key is the attributeName from an attribute choice.
        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this order.
        • campaignRefs
          List<com.broadleafcommerce.order.common.domain.CampaignRef> campaignRefs
          A list of campaign references that are attached to this order. Similar to Order.getOfferCodes(), the CampaignRef.getCampaignTrackingId() can be used to apply Adjustments to different aspects of the order. The difference is that these items need to be validated against a valid "Campaign" before being added to this list.
        • cartCreateDate
          Instant cartCreateDate
          The date that the originating cart was first created.
        • cartId
          String cartId
          The context ID of the original cart for this order.
        • cartType
          String cartType
          The type of cart for this order.
          See Also:
        • checkoutRequestId
          String checkoutRequestId
          The id of the latest checkout request for the originating cart.

          This is typically the latest checkout request id if there were multiple checkout submissions for the cart.

        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • customerId
          String customerId
          The ID of the customer that owns this order.
        • customerName
          String customerName
          The name of the customer that owns this order.
        • emailAddress
          String emailAddress
          The customer's email address.
        • id
          String id
          The context ID of the order.
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this item. Distinguished from Order.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf MicroServices. For example, attributes to help with processing the order's checkout.
        • locale
          Locale locale
          The locale for this order. Used to determine what locale this order was in for translations and other location-based functionality.
        • name
          String name
          A unique name for the order, used for retrieval. This field is not displayed anywhere.
        • offerCodes
          List<String> offerCodes
          A list of offer codes that were added to this order. Used to apply Adjustments to different aspects of the order.
        • orderItems
          List<OrderItem> orderItems
          Items that are contained within this order. Typically represents a good or service that the customer is purchasing.
        • orderNumber
          String orderNumber
          The unique number associated with this Order. Typically, this is generated and set on order submission. Used for record keeping and communicating with the customer instead of just using Order.getId() since that exposes unwanted information about your database.
        • orderPricing
          OrderPricing orderPricing
          Embedded container for all pricing information on this order.
        • paymentDistributionDetails
          List<PaymentDistributionDetail> paymentDistributionDetails
          A list of PaymentDistributionDetails representing how this order's total is split across different payments.
        • rootAccountId
          String rootAccountId
          The ID of the root account the account member belongs to.

          For example, if we have this account setup, rootAcct -> subAcct (child of rootAcct) -> subSubAcct (child of subAcct), this field would be rootAcct.

        • status
          String status
          The status of this order.
        • submitDate
          Instant submitDate
          The date that this order was submitted.
        • vouchers
          List<com.broadleafcommerce.order.common.domain.Voucher> vouchers
          A list of Vouchers that this order is qualified for.

    • Class com.broadleafcommerce.order.client.domain.OrderFulfillment

      class OrderFulfillment extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalShipments
          List<Shipment> additionalShipments
          All additional shipment details for this fulfillment.

          Use this when the fulfillment needs to be shipped in multiple parts. These can be defined in conjunction with a primary OrderFulfillment.shipment, or on their own with no primary OrderFulfillment.shipment.

        • address
          com.broadleafcommerce.order.common.domain.Address address
          The shipping address for this fulfillment.
        • adjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> adjustments
          Adjustments to fulfillment pricing that should be applied to OrderFulfillment.getFulfillmentCharge().
        • attributes
          Map<String,Object> attributes
          Additional attributes for this order fulfillment.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • currency
          javax.money.CurrencyUnit currency
          The currency unit used for the pricing of this OrderFulfillment.
        • externalId
          String externalId
          Intended to hold any unique identifier for this fulfillment as assigned by an external system. For example, many implementations may integrate or import/export data from external systems that manage their own unique identifiers.
        • fulfillmentAdjustmentsTotal
          javax.money.MonetaryAmount fulfillmentAdjustmentsTotal
          Sum of the fulfillment's adjustments.
        • fulfillmentCharge
          javax.money.MonetaryAmount fulfillmentCharge
          The shipping charge for this fulfillment before adjustments are applied. This is a charge specifically at the fulfillment level and does not include charges from OrderFulfillment.getFulfillmentItems().
        • fulfillmentItems
          List<OrderFulfillmentItem> fulfillmentItems
          Items within this fulfillment, each of which should relate back to a OrderItem.
        • fulfillmentOption
          com.broadleafcommerce.order.common.domain.FulfillmentOption fulfillmentOption
          The fulfillment option chosen for the OrderFulfillment.getType().
          See Also:
          • FulfillmentOption
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The total shipping price of this fulfillment, including adjustments and item shipping prices. This does not include taxes.
        • grandTotal
          javax.money.MonetaryAmount grandTotal
          The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.
        • groupReferenceNumber
          String groupReferenceNumber
          The reference number of the FulfillmentGroup this fulfillment was created from.

          By default, only one OrderFulfillment is created per FulfillmentGroup, but certain implementations may wish to create multiple OrderFulfillments from a single FulfillmentGroup (ex: to support fulfillment splitting, multi-vendor fulfillment, etc).

          This field would provide traceability into finding which OrderFulfillments came from the same FulfillmentGroup.

          See Also:
          • FulfillmentGroup.referenceNumber
        • id
          String id
          The unique identifier for this fulfillment.
        • includedFulfillmentTax
          javax.money.MonetaryAmount includedFulfillmentTax
          The amount of fulfillment taxes that are included in the item subtotal (VAT).
        • includedMerchandiseTax
          javax.money.MonetaryAmount includedMerchandiseTax
          The amount of merchandise taxes that are included in the item subtotal (VAT).
        • inventoryLocationReference
          String inventoryLocationReference
          This is an optional field where the ID or reference number of the expected InventoryLocation is stored. Specifically, this is required in situations where a customer will pick up this FulfillmentGroup (i.e. type == FulfillmentType.PICKUP). This could also be provided as a hint in the case that this is a SHIP location and the application knows from where this FulfillmentGroup should be fulfilled.
        • merchandiseTotal
          javax.money.MonetaryAmount merchandiseTotal
          The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.
        • orderFulfillmentNumber
          String orderFulfillmentNumber
          The number for this individual fulfillment, unique within the order.
        • orderId
          String orderId
          A soft reference to the parent Order this fulfillment belongs to.
        • overrideDetails
          List<com.broadleafcommerce.order.common.domain.OverrideDetail> overrideDetails
          List of details about any price overrides which have been performed on this fulfillment.
        • overrideFulfillmentPriceFlag
          boolean overrideFulfillmentPriceFlag
          Whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process.
        • pricedFulfillmentOption
          com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption
          The PricedFulfillmentOption chosen for the OrderFulfillment.getType().
          See Also:
          • PricedFulfillmentOption
        • proratedOrderFulfillmentAdjustments
          javax.money.MonetaryAmount proratedOrderFulfillmentAdjustments
          Prorated amount of the fulfillment adjustments that applies to the OrderFulfillment.fulfillmentCharge. Fulfillment-level adjustments are prorated between the charges of the Fulfillment and those of the individual items.
        • requiresCollectOnDelivery
          boolean requiresCollectOnDelivery
          Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.
        • shipment
          Shipment shipment
          The primary shipment details for this fulfillment.

          Unused if the fulfillment does not require shipping, or if OrderFulfillment.additionalShipments are being used exclusively.

        • status
          String status
          The status of this fulfillment.
          See Also:
        • taxTotal
          javax.money.MonetaryAmount taxTotal
          The total tax of this fulfillment, including merchandise and fulfillment tax.
        • type
          String type
          The type of means by which this fulfillment is fulfilled. This could be SHIP, PICKUP, or VIRTUAL, for example.
          See Also:
          • FulfillmentType
        • vendorRef
          String vendorRef
          A reference to the corresponding vendor for this fulfillment.
        • version
          Integer version
          The version of this OrderFulfillment. Used by components making use of the order fulfillment to ensure it is up-to-date and thus prevent race condition scenarios. This should never be manually incremented/decremented.

    • Class com.broadleafcommerce.order.client.domain.OrderFulfillmentItem

      class OrderFulfillmentItem extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this fulfillment item.
        • availableOnline
          boolean availableOnline
          Whether or not this product is available online - ie inventory is available somewhere to fulfill this product.
        • fulfillmentAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> fulfillmentAdjustments
          Adjustments to item fulfillment pricing that should be applied to the total of OrderFulfillmentItem.unitFulfillmentCharge.
        • fulfillmentAdjustmentsTotal
          javax.money.MonetaryAmount fulfillmentAdjustmentsTotal
          The total of all the item fulfillment adjustments for this item.
        • fulfillmentRefundAmount
          javax.money.MonetaryAmount fulfillmentRefundAmount
          The fulfillment amount to refund when this item is returned, note that prorated fulfillment group adjustments are included. For example, if this item has a fulfillment amount of $5 and has a prorated fulfillment group adjustment of $1, the fulfillment refund amount would be $4.

          This amount is calculated by default when OrderFulfillment is being generated and populated from the corresponding OrderFulfillmentItem.

        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The total fulfillment price of this item, including adjustments. This does not include taxes.
        • id
          String id
          The context ID of this fulfillment item.
        • includedFulfillmentTax
          javax.money.MonetaryAmount includedFulfillmentTax
          The amount of fulfillment taxes that are included in the item subtotal (VAT).
        • includedMerchandiseTax
          javax.money.MonetaryAmount includedMerchandiseTax
          The amount of merchandise taxes that are included in the item subtotal (VAT).
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this fulfillment item. Distinguished from OrderFulfillmentItem.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf Microservices. For example, attributes to help with returning free gift items.
        • inventoryCheckStrategy
          String inventoryCheckStrategy
          The inventory check strategy of the item. This value helps to determine when an inventory check is required.
        • inventoryReservationStrategy
          String inventoryReservationStrategy
          The reservation strategy of the item. This value helps to determine when an inventory reservation is required.
        • itemTotal
          javax.money.MonetaryAmount itemTotal
          The total amount attributed to this fulfillment item. This is the OrderFulfillmentItem.merchandiseTotal including OrderFulfillmentItem.proratedOrderAdjustments and the OrderFulfillmentItem.nonIncludedTaxTotal.
        • merchandiseAdjustmentsTotal
          javax.money.MonetaryAmount merchandiseAdjustmentsTotal
          The total of all the item adjustments for the merchandise. Does not include OrderFulfillmentItem.proratedOrderAdjustments.
        • merchandiseRefundAmount
          javax.money.MonetaryAmount merchandiseRefundAmount
          The merchandise amount to refund when this item is returned, note that prorated order adjustments are included. For example, if this item has a merchandise amount of $10 and has a prorated order adjustment of $2, the merchandise refund amount would be $8.

          This amount is calculated by default when Order is being generated and populated from the corresponding OrderItem.

          See Also:
        • merchandiseSubtotal
          javax.money.MonetaryAmount merchandiseSubtotal
          The OrderFulfillmentItem.unitMerchandisePrice multiplied by OrderFulfillmentItem.quantity.
        • merchandiseTaxTotal
          javax.money.MonetaryAmount merchandiseTaxTotal
          The total tax of the item merchandise based on the price of the related OrderItem.
        • merchandiseTotal
          javax.money.MonetaryAmount merchandiseTotal
          The merchandise total for the item quantity, including OrderFulfillmentItem.merchandiseSubtotal and item OrderFulfillmentItem.merchandiseAdjustmentsTotal. Does not include OrderFulfillmentItem.proratedOrderAdjustments.
        • nonIncludedFulfillmentTax
          javax.money.MonetaryAmount nonIncludedFulfillmentTax
          The amount of fulfillment taxes that are not included in the item subtotal.
        • nonIncludedMerchandiseTax
          javax.money.MonetaryAmount nonIncludedMerchandiseTax
          The amount of merchandise taxes that are not included in the item subtotal.
        • nonIncludedTaxTotal
          javax.money.MonetaryAmount nonIncludedTaxTotal
          The total amount of taxes that are not included in the item subtotal.
        • orderFulfillment
          OrderFulfillment orderFulfillment
          The owning order fulfillment of this item.
        • orderItemId
          String orderItemId
          The id of the OrderItem to be represented by this fulfillment item.
        • pricedFulfillmentOption
          com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption
          The PricedFulfillmentOption chosen for this item.
          See Also:
          • PricedFulfillmentOption
        • proratedFulfillmentCharge
          javax.money.MonetaryAmount proratedFulfillmentCharge
          The prorated shipping charge for this fulfillment item before adjustments are applied, derived from the FulfillmentGroup.getGroupFulfillmentPriceBeforeAdjustments(). This does not include additional shipping charges specific to the item.
        • proratedOrderAdjustments
          javax.money.MonetaryAmount proratedOrderAdjustments
          The amount prorated to this item from order adjustments.
        • proratedOrderFulfillmentAdjustments
          javax.money.MonetaryAmount proratedOrderFulfillmentAdjustments
          The amount prorated to this item from order fulfillment adjustments.
        • quantity
          int quantity
          The quantity of the item to be fulfilled by this fulfillment. This isn't necessarily going to equal OrderItem.getQuantity() since an OrderItem can be split across multiple OrderFulfillments.
        • referenceNumber
          String referenceNumber
          The reference number for this fulfillment item. This reference number should stay the same even if this item is split, so it could be shared between multiple items.
        • taxDetails
          List<OrderFulfillmentItemTaxDetail> taxDetails
          The tax details for this fulfillment item. This is a granular breakdown of tax, describing individual taxes, such as city, state, county, etc. The totals here should equal OrderFulfillmentItem.merchandiseTaxTotal.
        • unitFulfillmentCharge
          javax.money.MonetaryAmount unitFulfillmentCharge
          The unit shipping charge of each item before adjustments are applied. This is like OrderItem.getUnitPrice() but for fulfillment.
        • unitMerchandisePrice
          javax.money.MonetaryAmount unitMerchandisePrice
          The individual unit price for the merchandise. This is the same as OrderItem.unitPrice.

    • Class com.broadleafcommerce.order.client.domain.OrderFulfillmentItemTaxDetail

      class OrderFulfillmentItemTaxDetail extends Object implements Serializable

      • Serialized Fields

        • attributes
          Map<String,Object> attributes
          Additional attributes for this tax detail.
        • country
          String country
          The 2 digit country code.
        • currency
          javax.money.CurrencyUnit currency
          The currency for this tax detail.
        • fulfillmentItem
          OrderFulfillmentItem fulfillmentItem
          The fulfillment item for this tax detail
        • id
          String id
          The database id
        • isVat
          boolean isVat
          Declares whether the taxes were included in the provided subtotal. Note: this is a known misnomer.
        • jurisdictionName
          String jurisdictionName
          The tax jurisdiction name. This may be a state, city, county, etc. For example, "California", "New York City", etc.
        • jurisdictionType
          String jurisdictionType
          The jurisdiction type, e.g. city, state, county, etc.
        • rate
          BigDecimal rate
          The tax rate
        • region
          String region
          The region that this tax was calculated. This may be something like the state, country, etc. For example, if the jurisdiction is Dallas, then the region would be Texas.
        • taxableAmount
          javax.money.MonetaryAmount taxableAmount
          The amount that was taxable to determine the calculated tax.
        • taxCalculated
          javax.money.MonetaryAmount taxCalculated
          The amount of taxes calculated.
        • taxName
          String taxName
          The tax name for this tax detail. Describes the tax (e.g. TX STATE TAX)
        • transactionId
          String transactionId
          The transaction ID for this tax detail. Used to reconcile this tax detail with a specific transaction when using an external tax provider.

    • Class com.broadleafcommerce.order.client.domain.OrderItem

      class OrderItem extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The total adjustment price for all adjustments of an OrderItem.
        • attributeChoices
          Map<String,com.broadleafcommerce.order.common.domain.AttributeChoiceValue> attributeChoices
          Attribute choices for this item driven by product options, where each key is the attributeName from an attribute choice.
        • attributes
          Map<String,Object> attributes
          Miscellaneous attributes for this item.
        • brandId
          String brandId
          The id to the corresponding data driven enum for this item's product's brand. Used for validating offers.
        • categoryIds
          Set<String> categoryIds
          The ids to the corresponding categories for this item's product. Used for validating item choice configuration and offers.
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • dependentOrderItems
          List<OrderItem> dependentOrderItems
          OrderItems that depend on this OrderItem. Also could be called "child items".
        • discountable
          boolean discountable

          Whether or not this item can be applied to any offers or promotions.

          Defaults to true

        • id
          String id
          The context ID of the order.
        • imageAsset
          ImageAssetRef imageAsset
          The image asset for this item, usually sourced from the product.
        • internalAttributes
          Map<String,Object> internalAttributes
          Miscellaneous internal attributes for this item. Distinguished from OrderItem.getAttributes() in that this map is used for attributes that assist in the internal working of Broadleaf MicroServices. For example, attributes to help with pricing of dependent items.
        • itemAdjustments
          List<com.broadleafcommerce.order.common.domain.Adjustment> itemAdjustments
          Adjustments to item pricing that should be applied to OrderItem.getSubtotal().
        • merchandisingContext
          String merchandisingContext
          Defines the merchandising context of the item to signify where it is added from.

          This field is intended to be used for items added from SELECTOR products, which allows for the possibility of targeting the items for discounts based on the fact that they came from the SELECTOR product.

        • merchandisingTypeId
          String merchandisingTypeId
          The id to the corresponding data driven enum for this item's product's merchandising type. Used for validating offers.
        • name
          String name
          The name of this item. Typically derived from the product or sku name.
        • order
          Order order
          The owning order of this item.
        • overrideDetails
          List<com.broadleafcommerce.order.common.domain.OverrideDetail> overrideDetails
          List of details about any price overrides which have been performed on this item.
        • overridePriceFlag
          boolean overridePriceFlag
          Whether the price of this OrderItem was specifically overridden, whether from a CSR or an automatic process.
        • priceListId
          String priceListId
          The id of the price list used to get the pricing for this OrderItem.
        • pricingStrategy
          String pricingStrategy
          The pricing strategy for this item.
        • productId
          String productId
          The id to the corresponding product for this item.
        • productTags
          List<String> productTags
          The list of simple labels used to categorize the corresponding product for this item.
        • proratedOrderAdjustments
          javax.money.MonetaryAmount proratedOrderAdjustments
          The amount prorated to this item from order adjustments.
        • quantity
          int quantity
          The number of this item in the Order.
        • recurringPrice
          com.broadleafcommerce.order.common.domain.RecurringPriceDetail recurringPrice
          This is the recurring price if any from the same source as the OrderItem.unitPrice. The recurring price is used for subscriptions and is not expected to be charged at checkout typically.
          Since:
          Order Client 2.0.3
          See Also:
          • OrderItem.termDurationType
          • OrderItem.termDurationLength
        • recurringPriceTypeOverride
          String recurringPriceTypeOverride
          Overrides OrderItem.unitPriceType for the OrderItem.recurringPrice in cases where they must diverge. Usually only in Offer use cases where an offer cannot apply to a sale recurring price but can apply to the standard recurring price and we need to leave the upfront price as the sale price—or vice versa.
          Since:
          Order Client 2.0.3
        • refundAmount
          javax.money.MonetaryAmount refundAmount
          The pre-calculated merchandise amount to refund when this OrderItem is returned.

          By default, the OrderItem.proratedOrderAdjustments are included. For example, if this item has an amount of $10 and has a prorated order adjustment of $2, the refund amount would be $8.

        • sku
          String sku
          Represents a SKU code, similar to productId or variantId, except this is a unified, unique concept across both products and variants.
        • subtotal
          javax.money.MonetaryAmount subtotal
          The subtotal price of this OrderItem. Typically calculated from OrderItem.getUnitPrice() * OrderItem.getQuantity().
        • targetDemographicId
          String targetDemographicId
          The id to the corresponding data driven enum for this item's product's target demographic. Used for validating offers.
        • termDurationLength
          Integer termDurationLength
          The length of the terms, e.g., if this is 36 and OrderItem.termDurationType is MONTHS, then the OrderItem.recurringPrice should be charged for 36 months.
          Since:
          Order Client 2.0.3
          See Also:
          • OrderItem.termDurationType
          • OrderItem.recurringPrice
        • termDurationType
          String termDurationType
          The term duration type, e.g. DAYS, WEEKS, MONTHS, YEARS.
          Since:
          Order Client 2.0.3
          See Also:
          • OrderItem.termDurationLength
          • OrderItem.recurringPrice
        • total
          javax.money.MonetaryAmount total
          The total price of this OrderItem. Typically calculated from OrderItem.getSubtotal() - OrderItem.getAdjustmentsTotal().
        • type
          String type
          The type of this item. See DefaultOrderItemTypes.
        • unitPrice
          javax.money.MonetaryAmount unitPrice
          The individual unit price for an OrderItem.
        • unitPriceType
          String unitPriceType
          The type of the unit price for an OrderItem. Typically "salePrice", "standardPrice", or "basePrice".
        • uri
          String uri
          The navigable uri of the corresponding catalog entry (e.g. product) for this order item.
        • usagePrice
          com.broadleafcommerce.order.common.domain.UsagePriceDetail usagePrice
          This is the usage price if any from the same source as the OrderItem.unitPrice. The usage price represents a charge when an item is used, e.g., when using minutes above the base allowance. This is generally just information from a Cart's perspective.
          Since:
          Order Client 2.0.3
        • variantId
          String variantId
          The id to the corresponding variant for this item.
        • vendorRef
          String vendorRef
          A reference to the corresponding vendor for this item.

    • Class com.broadleafcommerce.order.client.domain.OrderPricing

      class OrderPricing extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • adjustmentsTotal
          javax.money.MonetaryAmount adjustmentsTotal
          The total adjustment price for all adjustments of an Order and its Order.getOrderItems(). This should not include fulfillment adjustments since those are already included in OrderPricing.fulfillmentTotal.
        • currency
          javax.money.CurrencyUnit currency
          The currency unit used for the pricing of this Order.
        • feesTotal
          javax.money.MonetaryAmount feesTotal
          The total fees of this Order. This would include the sum of all CartItem.getSubtotalWithDependentItems() for items of type CartItem.getType() of DefaultCartItemTypes.isExtraFee(String).
        • fulfillmentTotal
          javax.money.MonetaryAmount fulfillmentTotal
          The total fulfillment price of this Order, including adjustments.
        • includedTaxAmount
          javax.money.MonetaryAmount includedTaxAmount
          The amount of taxes that are included in the subtotal (VAT).
        • subtotal
          javax.money.MonetaryAmount subtotal
          The subtotal price of this Order. Typically calculated from summing the individual totals from Order.getOrderItems().
        • taxIncludedType
          String taxIncludedType
          Indicates if any taxes are included in the subtotal.
          See Also:
          • TaxIncludedType
        • total
          javax.money.MonetaryAmount total
          The total price of this Order. Typically calculated from OrderPricing.getSubtotal() - OrderPricing.getAdjustmentsTotal() + OrderPricing.getTotalTax() + OrderPricing.getFulfillmentTotal().
        • totalTax
          javax.money.MonetaryAmount totalTax
          The total tax amount for this Order.

    • Class com.broadleafcommerce.order.client.domain.ReturnAuthorization

      class ReturnAuthorization extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • currency
          javax.money.CurrencyUnit currency
          The currency unit used for monetary amounts.
        • estimatedFulfillmentTotalToRefund
          javax.money.MonetaryAmount estimatedFulfillmentTotalToRefund
          The estimated fulfillment total which can be refunded.
        • estimatedMerchandiseTotalToRefund
          javax.money.MonetaryAmount estimatedMerchandiseTotalToRefund
          The estimated merchandise total which can be refunded.
        • estimatedReturnShippingCharge
          javax.money.MonetaryAmount estimatedReturnShippingCharge
          The estimated charge to the customer to ship back the items to return.
        • estimatedTaxTotalToRefund
          javax.money.MonetaryAmount estimatedTaxTotalToRefund
          The estimated tax total which can be refunded. This contains all taxes, including merchandise and fulfillment taxes.
        • estimatedTotalToRefund
          javax.money.MonetaryAmount estimatedTotalToRefund
          The estimated grand total which can be refunded.
        • fulfillmentTotalRefunded
          javax.money.MonetaryAmount fulfillmentTotalRefunded
          The fulfillment total which has been refunded.
        • id
          String id
          The context ID of the return authorization.
        • items
          List<ReturnAuthorizationItem> items
          The items which are being returned.
        • merchandiseTotalRefunded
          javax.money.MonetaryAmount merchandiseTotalRefunded
          The merchandise total which has been refunded.
        • orderId
          String orderId
          The context ID of the order from which items are returned.
        • returnShippingCharged
          javax.money.MonetaryAmount returnShippingCharged
          The amount charged to the customer to ship back the items to return.
        • status
          String status
          The status of the return.
          See Also:
        • taxTotalRefunded
          javax.money.MonetaryAmount taxTotalRefunded
          The tax total which has been refunded. This contains all taxes, including merchandise and fulfillment taxes.
        • totalFailedToRefund
          javax.money.MonetaryAmount totalFailedToRefund
          The grand total which has failed to be refunded.
        • totalRefundAwaitingResult
          javax.money.MonetaryAmount totalRefundAwaitingResult
          The grand total of refund that is awaiting result.

          This value should only be present if asynchronous transaction is supported.

        • totalRefunded
          javax.money.MonetaryAmount totalRefunded
          The grand total which has been refunded.
        • trackingNumber
          String trackingNumber
          Optional tracking number for the return shipment of items.
        • version
          Integer version
          The version of this ReturnAuthorization. Used by components making use of the return authorization to ensure it is up-to-date and thus prevent race condition scenarios. This should never be manually incremented/decremented.

    • Class com.broadleafcommerce.order.client.domain.ReturnAuthorizationItem

      class ReturnAuthorizationItem extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • confirmations
          List<ReturnConfirmation> confirmations
          The portions of this item which have been confirmed as returned.
        • estimatedFulfillmentTotalToRefund
          javax.money.MonetaryAmount estimatedFulfillmentTotalToRefund
          The estimated fulfillment total which can be refunded.
        • estimatedMerchandiseTotalToRefund
          javax.money.MonetaryAmount estimatedMerchandiseTotalToRefund
          The estimated merchandise total which can be refunded.
        • estimatedTaxTotalToRefund
          javax.money.MonetaryAmount estimatedTaxTotalToRefund
          The estimated tax total which can be refunded. This contains all taxes, including merchandise and fulfillment taxes.
        • estimatedTotalToRefund
          javax.money.MonetaryAmount estimatedTotalToRefund
          The estimated grand total which can be refunded.
        • expectedCondition
          String expectedCondition
          The condition of the item expected when returned.

          This is usually populated from an enum.

        • id
          String id
          The id of this return authorization item.
        • note
          String note
          An optional note containing extra information about the item being returned.
        • orderFulfillmentItemId
          String orderFulfillmentItemId
          The context ID of the OrderFulfillmentItem being returned.
        • primaryReturnReason
          String primaryReturnReason
          The primary reason for the return.

          This is usually populated from an enum.

        • quantity
          int quantity
          The quantity of the item being returned.
        • returnType
          String returnType
          The type of the return, indicating how it should be processed.

          This is usually populated from an enum. For example, DefaultReturnAuthorizationItemReturnTypes.REFUND indicates that this return should result in a refund.

          See Also:
        • secondaryReturnReason
          String secondaryReturnReason
          The secondary reason for the return, providing more detail in addition to the ReturnAuthorizationItem.primaryReturnReason.

          This is usually populated from an enum associated with the ReturnAuthorizationItem.primaryReturnReason.

    • Class com.broadleafcommerce.order.client.domain.ReturnConfirmation

      class ReturnConfirmation extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • actualCondition
          String actualCondition
          The actual condition of the returned item received.

          This is usually populated from an enum.

        • fulfillmentTotalToRefund
          javax.money.MonetaryAmount fulfillmentTotalToRefund
          The fulfillment total which can be refunded.
        • id
          String id
          The id of this return confirmation.
        • merchandiseTotalToRefund
          javax.money.MonetaryAmount merchandiseTotalToRefund
          The merchandise total which can be refunded.
        • note
          String note
          An optional note containing extra information about the item being returned.
        • overrideTotalToRefund
          javax.money.MonetaryAmount overrideTotalToRefund
          The overridden grand total to refund.
        • quantity
          int quantity
          The quantity of the item which was returned.
        • refundFulfillmentCharge
          boolean refundFulfillmentCharge
          Whether the fulfillment charge should be refunded.
        • status
          String status
          The status of the returned item.
          See Also:
        • taxTotalToRefund
          javax.money.MonetaryAmount taxTotalToRefund
          The tax total which can be refunded. This contains all taxes, including merchandise and fulfillment taxes.
        • totalFailedToRefund
          javax.money.MonetaryAmount totalFailedToRefund
          The grand total which has failed to be refunded.
        • totalRefundAwaitingResult
          javax.money.MonetaryAmount totalRefundAwaitingResult
          The grand total of refund that is awaiting result.

          This value should only be present if asynchronous transaction is supported.

        • totalRefunded
          javax.money.MonetaryAmount totalRefunded
          The estimated grand total which has been refunded.
        • totalToRefund
          javax.money.MonetaryAmount totalToRefund
          The grand total which can be refunded.

    • Class com.broadleafcommerce.order.client.domain.Shipment

      class Shipment extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • shipDate
          Instant shipDate
          The date the shipment was shipped.
        • shipperType
          String shipperType
          The shipper responsible for the shipment, for example a carrier.
        • trackingNumber
          String trackingNumber
          The tracking number for this shipment.
        • trackingUrl
          String trackingUrl
          The URL to the tracking page for this shipment.

  • Package com.broadleafcommerce.order.client.domain.payment

    • Class com.broadleafcommerce.order.client.domain.payment.PaymentDistributionDetail

      class PaymentDistributionDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,String> additionalAttributes
          General use map to capture any additional attributes needed for this detail.
        • paymentDisplayType
          String paymentDisplayType
          The type of the payment. Used for display purposes.
        • paymentId
          String paymentId
          The id of the payment.
        • ratio
          BigDecimal ratio
          The percentage of the order total that is distributed to this payment, represented as a decimal. For example, if a payment is responsible for 75% of the order total, then its ratio would be 0.75