Package com.broadleafcommerce.fulfillment.common.domain

Class FulfillmentPricingItem

java.lang.Object
com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingItem
All Implemented Interfaces:
Serializable
public class FulfillmentPricingItem extends Object implements Serializable
DTO for fields that are used for getting fulfillment prices for FulfillmentItems.
See Also:

  • Constructor Details

    • FulfillmentPricingItem

      public FulfillmentPricingItem()

  • Method Details

    • getItemReference

      public String getItemReference()
      This is the reference number of the Fulfillment Item.

    • getSku

      public String getSku()
      String representing the SKU.

    • getWeight

      public Weight getWeight()
      Weight per unit.

    • getDimensions

      public Dimensions getDimensions()
      Dimensions per unit.

    • getQuantity

      public int getQuantity()
      Quantity or number of units.

    • getUnitPrice

      public javax.money.MonetaryAmount getUnitPrice()
      The Cart price of one unit of this item.

    • getFlatRates

      public Map<String,javax.money.MonetaryAmount> getFlatRates()
      A List of Flat Rates to consider when pricing Fulfillment Options. This is a Map keyed by the service level with a MonetaryAmount. Note that the Inventory Type and Fulfillment Type are implicit on the FulfillmentPricingGroup, so the service level in this map is for a service level that is associated with the Fulfillment Pricing Group's inventory type and fulfillment type.

    • getFulfillmentType

      @Nullable public String getFulfillmentType()
      The fulfillment type for this item if it has been assigned a PricedFulfillmentOption.

    • getServiceLevel

      @Nullable public String getServiceLevel()
      The service level for this item if it has been assigned a PricedFulfillmentOption.

    • getInventoryType

      @Nullable public String getInventoryType()
      The inventory type of this item.

    • getFulfillmentOriginInfos

      public List<FulfillmentOriginInfo> getFulfillmentOriginInfos()
      Used to allow targeting of fulfillment pricing based on a location where the application expects the item to be shipped from. The request can include multiple fulfillmentSourceInfos to allow the pricing algorithm to attempt pricing for multiple scenarios. For example, an application might implement algorithms to price the order using the closest locations or fulfill from a single location, etc.

    • setItemReference

      public void setItemReference(String itemReference)
      This is the reference number of the Fulfillment Item.

    • setSku

      public void setSku(String sku)
      String representing the SKU.

    • setWeight

      public void setWeight(Weight weight)
      Weight per unit.

    • setDimensions

      public void setDimensions(Dimensions dimensions)
      Dimensions per unit.

    • setQuantity

      public void setQuantity(int quantity)
      Quantity or number of units.

    • setUnitPrice

      public void setUnitPrice(javax.money.MonetaryAmount unitPrice)
      The Cart price of one unit of this item.

    • setFlatRates

      public void setFlatRates(Map<String,javax.money.MonetaryAmount> flatRates)
      A List of Flat Rates to consider when pricing Fulfillment Options. This is a Map keyed by the service level with a MonetaryAmount. Note that the Inventory Type and Fulfillment Type are implicit on the FulfillmentPricingGroup, so the service level in this map is for a service level that is associated with the Fulfillment Pricing Group's inventory type and fulfillment type.

    • setFulfillmentType

      public void setFulfillmentType(@Nullable String fulfillmentType)
      The fulfillment type for this item if it has been assigned a PricedFulfillmentOption.

    • setServiceLevel

      public void setServiceLevel(@Nullable String serviceLevel)
      The service level for this item if it has been assigned a PricedFulfillmentOption.

    • setInventoryType

      public void setInventoryType(@Nullable String inventoryType)
      The inventory type of this item.

    • setFulfillmentOriginInfos

      public void setFulfillmentOriginInfos(List<FulfillmentOriginInfo> fulfillmentOriginInfos)
      Used to allow targeting of fulfillment pricing based on a location where the application expects the item to be shipped from. The request can include multiple fulfillmentSourceInfos to allow the pricing algorithm to attempt pricing for multiple scenarios. For example, an application might implement algorithms to price the order using the closest locations or fulfill from a single location, etc.