Serialized Form

Package com.broadleafcommerce.shipping

Class com.broadleafcommerce.shipping.FulfillmentOption

class FulfillmentOption extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

The description of this option. Used to display information to a customer.

name

String name

The name of this option. This is expected to be unique across all options. It is used to determine which option is used for a fulfillment group and what options a specific FulfillmentPricingProvider can provide pricing for.

taxable

boolean taxable

Whether any shipping prices should be taxable for this option.

taxCode

String taxCode

The tax code for this option.

useFlatRates

boolean useFlatRates

Whether to use flat rates for this option.

Package com.broadleafcommerce.shipping.banded

Class com.broadleafcommerce.shipping.banded.BandedFulfillmentPricingConfig

class BandedFulfillmentPricingConfig extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

sampleConfig

boolean sampleConfig

Deprecated.

Whether this configuration is the out-of-the-box sample. If true, a warning will be logged.

shipTables

List<BandedFulfillmentPricingOption> shipTables

Deprecated.

List of banded pricing fulfillment options that can be chosen.

Class com.broadleafcommerce.shipping.banded.BandedFulfillmentPricingOption

class BandedFulfillmentPricingOption extends FulfillmentOption implements Serializable

serialVersionUID:

1L

Serialized Fields

bands

List<FulfillmentOptionBand> bands

Deprecated.

bandType

String bandType

Deprecated.

What type of band this option represents. This drives what FulfillmentOptionBand.getMinimum() is compared against.

daysToShip

Integer daysToShip

Deprecated.

The number of days this option is expected to ship.

units

String units

Deprecated.

The units to specify the FulfillmentOptionBand.getMinimum() in.

Class com.broadleafcommerce.shipping.banded.FulfillmentOptionBand

class FulfillmentOptionBand extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

fixedPricePerGroup

Set<FulfillmentPriceAmount> fixedPricePerGroup

Deprecated.

Fixed prices (by currency) to add per FulfillmentPricingRequest.

fixedPricePerItem

Set<FulfillmentPriceAmount> fixedPricePerItem

Deprecated.

Fixed prices (by currency) to add per FulfillmentPricingItem in a group.

minimum

BigDecimal minimum

Deprecated.

The minimum amount required for the corresponding band type that determines if this band should apply.

percentagePerItem

BigDecimal percentagePerItem

Deprecated.

Percentage to multiply against a FulfillmentPricingItem.getMerchandiseTotalAmount() () FulfillmentItem's total}.

Package com.broadleafcommerce.shipping.domain

Class com.broadleafcommerce.shipping.domain.FulfillmentOptionPricedResponse

class FulfillmentOptionPricedResponse extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

estimatedDeliveryDate

Instant estimatedDeliveryDate

The estimated delivery date.

fulfillmentOption

FulfillmentOption fulfillmentOption

fulfillmentPriceCalculated

javax.money.MonetaryAmount fulfillmentPriceCalculated

The total fulfillment price calculated.

fulfillmentPriceInfos

Map<String,FulfillmentPriceInfo> fulfillmentPriceInfos

The pricing infos for each of the line items, keyed by item id.

Class com.broadleafcommerce.shipping.domain.FulfillmentPriceInfo

class FulfillmentPriceInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

isEstimated

boolean isEstimated

Whether the calculated price is an estimate.

itemId

String itemId

The id of the line item for this fulfillment pricing info.

pricePerUnit

javax.money.MonetaryAmount pricePerUnit

Deprecated.

this is deprecated as the accurate calculation of this value is not feasible for the bundle item, see FulfillmentPricingItem.getMerchandiseTotalAmount()

The fulfillment price calculated for a unit of the item.

skuCode

String skuCode

The sku code for the item.

total

javax.money.MonetaryAmount total

The combined total for all units.

Class com.broadleafcommerce.shipping.domain.FulfillmentPricingItem

class FulfillmentPricingItem extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

description

String description

The description for this item.

fulfillmentFlatRates

Map<String,javax.money.MonetaryAmount> fulfillmentFlatRates

Gets the flat rate for fulfilling this item for a particular fulfillment option type. Depending on if the option is configured to use flat rates, this flat rate will be used in calculating the cost of fulfilling this item.

itemId

String itemId

The unique identifier for this line item.

merchandiseTotalAmount

javax.money.MonetaryAmount merchandiseTotalAmount

The total price of all the items. This value is used instead of multiplying the FulfillmentPricingItem.unitPrice by FulfillmentPricingItem.quantity since calculating an accurate unit price from the fulfillment isn't feasible for the bundle products when the bundle's price is prorated to the bundle items.

For example, the price of the bundle is $30, the first item has quantity 2 and price $9.99, the second has quantity 1 and price $15. The prorated price of the first 2 items will be $17.13 and the second $12.87. In this case if calculate $17.13 / 2 = $8,565, rounded value will be $8,57 and then $8,57 * 2 = $17,14 that is not the same as $17.13.

quantity

int quantity

The number of units that make up this item.

An item can represent multiple units of the same product or variant such as 3 large, red t-shirts. The quantity would thus be 3.

skuCode

String skuCode

The sku code for this item.

subtotal

javax.money.MonetaryAmount subtotal

The subtotal of this item being paid for by a customer.

See Also:

• FulfillmentPricingItem.unitPrice

taxCode

String taxCode

The tax code for this item.

totalWeight

BigDecimal totalWeight

The total weight of this item being paid for by a customer.

See Also:

• FulfillmentPricingItem.unitWeight
• FulfillmentPricingItem.weightUnits

unitPrice

javax.money.MonetaryAmount unitPrice

Deprecated.

this is deprecated as the accurate calculation of this value is not feasible for the bundle item, see FulfillmentPricingItem.getMerchandiseTotalAmount()

The individual unit price for this item.

An item can represent multiple units of the same product or variant such as 3 large, red t-shirts. The unitPrice would be the price of just 1 of those shirts whereas the FulfillmentPricingItem.subtotal would be the combined price of all 3.

unitWeight

BigDecimal unitWeight

The weight per unit of the item.

An item can represent multiple units of the same product or variant such as 3 large, red t-shirts. The unitWeight would be the weight of just 1 of those shirts whereas the FulfillmentPricingItem.totalWeight would be the combined weight of all 3.

See Also:

• FulfillmentPricingItem.weightUnits

weightUnits

String weightUnits

The units of measure for FulfillmentPricingItem.unitWeight and FulfillmentPricingItem.totalWeight such as POUNDS or KILOGRAMS.

Class com.broadleafcommerce.shipping.domain.FulfillmentPricingRequest

class FulfillmentPricingRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

attributes

Map<String,String> attributes

Additional attributes for this request.

currency

javax.money.CurrencyUnit currency

The CurrencyUnit that should be used for this request.

customer

String customer

The customer that these pricing will apply to.

fromAddress

ShippingAddress fromAddress

The address that the items will be shipped from.

fulfillmentOption

String fulfillmentOption

The address that the items will be shipped to.

fulfillmentPricingItems

List<FulfillmentPricingItem> fulfillmentPricingItems

The list of items to be priced.

fulfillmentType

String fulfillmentType

The type of means by which this fulfillment group is fulfilled. This could be SHIP, PICKUP, or VIRTUAL, for example.

See Also:

• DefaultFulfillmentTypes

toAddress

ShippingAddress toAddress

The address that the items will be shipped to.

Class com.broadleafcommerce.shipping.domain.ShipISOCountry

class ShipISOCountry extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

alpha2

String alpha2

The two letter code for this country.

See Also:

• ISO 3166-1 alpha-2

alpha3

String alpha3

The three letter code for this country.

See Also:

• ISO 3166-1 alpha-3

name

String name

numericCode

Integer numericCode

The three digit code for this country.

See Also:

• ISO 3166-1 numeric

Class com.broadleafcommerce.shipping.domain.ShippingAddress

class ShippingAddress extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

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.

country

String country

The country for this address.

county

String county

The county of 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.shipping.domain.Weight

class Weight extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

unit

String unit

value

BigDecimal value

Package com.broadleafcommerce.shipping.fixed

Class com.broadleafcommerce.shipping.fixed.FixedFulfillmentPricingConfig

class FixedFulfillmentPricingConfig extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

sampleConfig

boolean sampleConfig

Deprecated.

Whether this configuration is the out-of-the-box sample. If true, a warning will be logged.

shipTables

List<FixedFulfillmentPricingOption> shipTables

Deprecated.

List of fixed pricing fulfillment options that can be chosen.

Class com.broadleafcommerce.shipping.fixed.FixedFulfillmentPricingOption

class FixedFulfillmentPricingOption extends FulfillmentOption implements Serializable

serialVersionUID:

1L

Serialized Fields

daysToShip

Integer daysToShip

Deprecated.

The number of days this option is expected to ship.

fixedPricePerGroup

Set<FulfillmentPriceAmount> fixedPricePerGroup

Deprecated.

Fixed prices (by currency) to add per FulfillmentPricingRequest.

fixedPricePerItem

Set<FulfillmentPriceAmount> fixedPricePerItem

Deprecated.

Fixed prices (by currency) to add per FulfillmentPricingItem in a group.

percentagePerItem

BigDecimal percentagePerItem

Deprecated.

Percentage to multiply against a FulfillmentPricingItem.getMerchandiseTotalAmount() () FulfillmentItem's total}.

Package com.broadleafcommerce.shipping.virtual

Class com.broadleafcommerce.shipping.virtual.VirtualFulfillmentPricingConfig

class VirtualFulfillmentPricingConfig extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

fulfillmentOptions

List<VirtualFulfillmentPricingOption> fulfillmentOptions

Deprecated.

List of virtual pricing fulfillment options that can be chosen.

sampleConfig

boolean sampleConfig

Deprecated.

Whether this configuration is the out-of-the-box sample. If true, a warning will be logged.

Class com.broadleafcommerce.shipping.virtual.VirtualFulfillmentPricingOption

class VirtualFulfillmentPricingOption extends FulfillmentOption implements Serializable

serialVersionUID:

1L

Serialized Fields

fixedPricePerGroup

Set<FulfillmentPriceAmount> fixedPricePerGroup

Deprecated.

Fixed prices (by currency) to add per FulfillmentPricingRequest.

fixedPricePerItem

Set<FulfillmentPriceAmount> fixedPricePerItem

Deprecated.

Fixed prices (by currency) to add per FulfillmentPricingItem in a group.

percentagePerItem

BigDecimal percentagePerItem

Deprecated.

Percentage to multiply against a FulfillmentItem's total.