Serialized Form

Package com.broadleafcommerce.pricing.client.domain

Class com.broadleafcommerce.pricing.client.domain.PriceableTarget

class PriceableTarget extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Additional attributes. These are primarily useful for targeting by price list rules and will be excluded from the response from the PriceInfosEndpoint to reduce payload size.

characteristics

Map<String,String> characteristics

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getCharacteristics()

priceableFields

Map<String,javax.money.MonetaryAmount> priceableFields

List of priceable fields for the target. This can include such fields as basePrice and baseCost.

targetId

String targetId

See Also:

• BasePriceableTarget.getTargetId()

targetQuantity

Integer targetQuantity

The quantity of the entity to be priced. This is used to determine when a price data tier should apply as the best overall price.

Since:

Pricing Client 2.0.3

targetType

String targetType

See Also:

• BasePriceableTarget.getTargetType()

termDurationLength

Integer termDurationLength

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationLength()

termDurationType

String termDurationType

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationType()

vendorRef

String vendorRef

See Also:

• BasePriceableTarget.getVendorRef()

Class com.broadleafcommerce.pricing.client.domain.PriceableTargetRef

class PriceableTargetRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

characteristics

Map<String,String> characteristics

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getCharacteristics()

targetId

String targetId

See Also:

• BasePriceableTarget.getTargetId()

targetQuantity

Integer targetQuantity

The quantity of the entity to be priced. This is used to determine when a price data tier should apply as the best overall price.

targetType

String targetType

See Also:

• BasePriceableTarget.getTargetType()

termDurationLength

Integer termDurationLength

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationLength()

termDurationType

String termDurationType

Since:

Pricing Client 2.0.3

See Also:

• BasePriceableTarget.getTermDurationType()

vendorRef

String vendorRef

See Also:

• BasePriceableTarget.getVendorRef()

Class com.broadleafcommerce.pricing.client.domain.PriceDataTierRef

class PriceDataTierRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

minQuantity

Integer minQuantity

The quantity that defines the minimum threshold of this tier.

price

javax.money.MonetaryAmount price

The one-time price.

recurringPrice

javax.money.MonetaryAmount recurringPrice

The amount of the recurring price. Optional.

Since:

Pricing Client 2.0.3

usagePrice

javax.money.MonetaryAmount usagePrice

The amount of the usage price. Optional.

Since:

Pricing Client 2.0.3

Class com.broadleafcommerce.pricing.client.domain.PriceDetail

class PriceDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

Defines the ending time for which this price is active

Since:

Pricing Client 2.0.3

activeStartDate

Instant activeStartDate

Defines the beginning time for which this price is active.

Since:

Pricing Client 2.0.3

availableQuantity

Integer availableQuantity

The available quantity that can use this price data. This is used for events such as a flash sale where the sale price is limited to a certain amount of quantity.

Since:

Pricing Client 2.0.3

price

javax.money.MonetaryAmount price

See Also:

• PriceDetailComparable.getPrice()

priceDataId

String priceDataId

Id of the specific PriceData that this price came from.

Only applicable if the PriceDetail.priceSource is DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA.

Since:

Pricing Client 2.0.3

priceDataTierList

List<PriceDataTierRef> priceDataTierList

PriceDataTiers for the PriceInfo.getTarget().

See Also:

• PriceDataTierRef

priceList

PriceListRef priceList

See Also:

• PriceListRef

priceListPriority

Integer priceListPriority

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getPriceListPriority()

priceSource

String priceSource

The source of this price within the price list, e.g. price list formula, price list price data, etc.

This may be helpful for consuming services to determine the priority of the price. For example, a price from DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA may have a higher precedence over DefaultPriceListPriceSources.BLC_PRICE_LIST_FORMULA.

Since:

1.4.1, 2.0.1

See Also:

• DefaultPriceListPriceSources

priceType

String priceType

The originating type of this corresponding price.

priority

Integer priority

Since:

PricingService 2.0.3

See Also:

• PriceDetailComparable.getPriority()

recurringPriceDetail

RecurringPriceDetail recurringPriceDetail

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getRecurringPriceDetail()

startingQuantity

Integer startingQuantity

Defines the initial quantity available for this price data before a pricing event such as a flash sale. It only serves an informational purpose.

Since:

Pricing Client 2.0.3

usagePriceDetail

UsagePriceDetail usagePriceDetail

Since:

Pricing Client 2.0.3

See Also:

• PriceDetailComparable.getUsagePriceDetail()

Class com.broadleafcommerce.pricing.client.domain.PriceInfo

class PriceInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

Defines the ending time for which this price is active

Since:

Pricing Client 2.0.3

activeStartDate

Instant activeStartDate

Defines the beginning time for which this price is active.

Since:

Pricing Client 2.0.3

availableQuantity

Integer availableQuantity

The available quantity that can use this price data. This is used for events such as a flash sale where the sale price is limited to a certain amount of quantity.

Since:

Pricing Client 2.0.3

backupPriceInfo

PriceInfo backupPriceInfo

If this PriceInfo is limited for events such as a flash sale, the backup is used for any remaining items that cannot get the sale price. The backup is the second best price that does not have a quantity restriction, if no other price lists exist, the item's base price is used.

For example, if the sale price is only available for 2 more items, and the customer has 5 items in the cart, only 2 of them should get the sale price and the remaining items should get the backup price.

Since:

Pricing Client 2.0.3

price

javax.money.MonetaryAmount price

Determined best price for PriceInfo.target.

priceDataId

String priceDataId

Id of the specific PriceData that this price came from.

Only applicable if the PriceInfo.priceListPriceSource is DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA.

Since:

Pricing Client 2.0.3

priceDataType

String priceDataType

priceListId

String priceListId

String representation of the PriceList that provided the best price.

See Also:

• PriceListRef.getId()

priceListPriceSource

String priceListPriceSource

If this price is from a price list, this field indicates the source of the price within the price list. E.g. price list formula, price list price data, etc.

Since:

1.4.1, 2.0.1

See Also:

• DefaultPriceListPriceSources

priceType

String priceType

The type of PriceInfo.price whether salePrice, standardPrice, contractPrice, etc.

priceTypeDetails

Map<String,PriceTypeDetail> priceTypeDetails

Map of each type of price to each corresponding PriceTypeDetail, which contains the best overall price for that type along with all the PriceDetails for the candidate PriceLists.

recurringPrice

RecurringPriceDetail recurringPrice

This is the recurring price if any from the same source as the PriceInfo.price. The recurring price is used for subscriptions and is not expected to be charged at checkout typically.

Since:

Pricing Client 2.0.3

startingQuantity

Integer startingQuantity

Defines the initial quantity available for this price data before a pricing event such as a flash sale. It only serves an informational purpose.

Since:

Pricing Client 2.0.3

target

PriceableTarget target

The PriceableTarget to which this info corresponds.

See Also:

• PriceableTarget

usagePrice

UsagePriceDetail usagePrice

This is the usage price if any from the same source as the PriceInfo.price. The usage price represents a charge when a priceable target is used, e.g., when using minutes above the base allowance.

Since:

Pricing Client 2.0.3

Class com.broadleafcommerce.pricing.client.domain.PriceListRef

class PriceListRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currency

javax.money.CurrencyUnit currency

The currency to which this price list applies.

id

String id

The id of this price list.

name

String name

The user-friendly name of this price list.

priority

Integer priority

When multiple price lists match a PriceContext, the price list with the higher priority wins out, where smaller integer values represent higher priorities. Nulls are implicitly given lower precedence than any other value - they will appear last.

type

String type

The type of this price list. By default, this can be "STANDARD", "SALE", or "CONTRACT".

Class com.broadleafcommerce.pricing.client.domain.PriceTypeDetail

class PriceTypeDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

bestPrice

javax.money.MonetaryAmount bestPrice

The determined best price value for this type of price from amongst all the candidates.

bestRecurringPriceDetail

RecurringPriceDetail bestRecurringPriceDetail

Represents the details related to a recurring (or subscription) price include the terms.

Since:

Pricing Client 2.0.3

bestUsagePriceDetail

UsagePriceDetail bestUsagePriceDetail

Represents the details related to a usage price including the units.

Since:

Pricing Client 2.0.3

priceDetails

Map<String,PriceDetail> priceDetails

A map for every candidate PriceList for the PriceTypeDetail.type, with the key being a PriceListRef.getId().

See Also:

• PriceDetail

priceListId

String priceListId

String representation of the PriceList that provided PriceTypeDetail.bestPrice.

See Also:

• PriceListRef.getId()

type

String type

The corresponding type of the price: salePrice, standardPrice, contractPrice, etc.

Class com.broadleafcommerce.pricing.client.domain.RecurringPriceDetail

class RecurringPriceDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

periodFrequency

int periodFrequency

The frequency with which the recurring RecurringPriceDetail.price should be charged., e.g., a value of 1 combined with RecurringPriceDetail.periodType of MONTH would indicate to a subscription service that the RecurringPriceDetail.price should be charged every 1 month.

See Also:

• RecurringPriceDetail.periodType

periodLimit

Integer periodLimit

Defines the number of periods the price should recur. Only applicable for non-standard price lists, particularly sales where a discount may be applied for the first 'n' periods after which the price reverts to a standard price list's.

See Also:

• RecurringPriceDetail.periodFrequency
• RecurringPriceDetail.periodType

periodType

String periodType

The period type for the price, e.g. DAY, MONTH, YEAR

See Also:

• RecurringPriceDetail.periodFrequency

price

javax.money.MonetaryAmount price

The amount of the recurring price.

termDurationLength

Integer termDurationLength

The length of the terms, e.g., if this is 36 and RecurringPriceDetail.termDurationType is MONTHS, then the RecurringPriceDetail.price should be charged for 36 months.

See Also:

• RecurringPriceDetail.termDurationType

termDurationType

String termDurationType

The term duration type, e.g. DAYS, WEEKS, MONTHS, YEARS.

See Also:

• RecurringPriceDetail.termDurationLength

Class com.broadleafcommerce.pricing.client.domain.UsagePriceDetail

class UsagePriceDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

BigDecimal amount

The amount of UsagePriceDetail.units to charge for, e.g., charge $2 for every 1 GB used.

price

javax.money.MonetaryAmount price

The price to charge for usage.

units

String units

The units (e.g., minutes, texts, GB) defining what is getting used against which to charge the UsagePriceDetail.amount.

Class com.broadleafcommerce.pricing.client.domain.UserTargetRef

class UserTargetRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

targetType

String targetType

This could be "customer", "account", etc.

targetValue

String targetValue

Package com.broadleafcommerce.pricing.client.domain.context

Class com.broadleafcommerce.pricing.client.domain.context.PriceContext

class PriceContext extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,Object> attributes

Additional, unspecified attributes.

currency

javax.money.CurrencyUnit currency

The currency by which to retrieve pricing info.

locale

Locale locale

The Locale used in this context

userTargets

Set<UserTargetRef> userTargets

UserTargetRefs associated with the API request.

Class com.broadleafcommerce.pricing.client.domain.context.PriceInfoContext

class PriceInfoContext extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

priceableTargets

Set<PriceableTarget> priceableTargets

PriceableTargets to be priced.

priceLists

Set<PriceListRef> priceLists

PriceListRefs to query for prices for the targets.

skipDetails

boolean skipDetails

Whether to exclude PriceInfo.getPriceTypeDetails() from the response.

Package com.broadleafcommerce.pricing.client.domain.usage

Class com.broadleafcommerce.pricing.client.domain.usage.PriceDataUsage

class PriceDataUsage extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

priceDataId

String priceDataId

The id of the limited PriceData.

priceListId

String priceListId

The id of the PriceList that the limited price data was from.

target

PriceableTarget target

The PriceableTarget to which this usage corresponds to.

usageQuantity

Integer usageQuantity

Defines the quantity that was used by this target.

Class com.broadleafcommerce.pricing.client.domain.usage.RecordPriceDataUsageRequest

class RecordPriceDataUsageRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalAttributes

Map<String,Object> additionalAttributes

Miscellaneous attributes that can be added to this request in order to provide more information.

customerReferenceId

String customerReferenceId

The ID of the customer this audit is for.

customerReferenceType

String customerReferenceType

The transaction type this audit is for, e.g. DefaultPriceDataCustomerReferenceTypes.

See Also:

• DefaultPriceDataCustomerReferenceTypes

priceDataUsages

List<PriceDataUsage> priceDataUsages

The list of PriceDataUsages to record

transactionReferenceId

String transactionReferenceId

The ix of the transaction that the price data was used in, e.g. cart id.

transactionReferenceType

String transactionReferenceType

The type of the transaction that the price data was used in, e.g. DefaultPriceDataTransactionReferenceTypes.BLC_CART.

See Also:

• DefaultPriceDataTransactionReferenceTypes

usageDate

Instant usageDate

The usage date.

Class com.broadleafcommerce.pricing.client.domain.usage.RecordPriceDataUsageResponse

class RecordPriceDataUsageResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

additionalAttributes

Map<String,Object> additionalAttributes

Miscellaneous attributes that can be added to this request in order to provide more information.

errorByPriceDataId

Map<String,String> errorByPriceDataId

A map of failed PriceDataUsage.getPriceDataId() to the corresponding error.

See Also:

• DefaultRecordPriceDataUsageFailureTypes

success

boolean success

Whether the all usages were successfully recorded.