Package com.commercetools.api.models.cart

Interface CartRecalculateAction

All Superinterfaces:
CartUpdateAction, ResourceUpdateAction<CartUpdateAction>
public interface CartRecalculateAction extends CartUpdateAction

This update action does not set any Cart field in particular, but it triggers several Cart updates to bring prices and discounts to the latest state. Those can become stale over time when no Cart updates have been performed for a while and prices on related Products have changed in the meanwhile.

If the priceMode of the Product related to a Line Item is of Embedded ProductPriceMode, the updated price of that LineItem may not correspond to a Price in the variant.prices anymore.

Example to create an instance using the builder pattern 

     CartRecalculateAction cartRecalculateAction = CartRecalculateAction.builder()
             .build()

  • Field Details

  • Method Details

    • getUpdateProductData

      Boolean getUpdateProductData()
      • Leave empty or set as false to update only the Prices and TaxRates of the Line Items.
      • Set as true to update the Product data (such as name, variant, productType, and Product Attributes) of the Line Items.
      Returns:
      updateProductData

    • setUpdateProductData

      void setUpdateProductData(Boolean updateProductData)
      • Leave empty or set as false to update only the Prices and TaxRates of the Line Items.
      • Set as true to update the Product data (such as name, variant, productType, and Product Attributes) of the Line Items.
      Parameters:
      updateProductData - value to be set

    • of

      static CartRecalculateAction of()
      factory method
      Returns:
      instance of CartRecalculateAction

    • of

      static CartRecalculateAction of(CartRecalculateAction template)
      factory method to create a shallow copy CartRecalculateAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      CartRecalculateAction copyDeep()
      Specified by:
      copyDeep in interface CartUpdateAction

    • deepCopy

      @Nullable static CartRecalculateAction deepCopy(@Nullable CartRecalculateAction template)
      factory method to create a deep copy of CartRecalculateAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static CartRecalculateActionBuilder builder()
      builder factory method for CartRecalculateAction
      Returns:
      builder

    • builder

      static CartRecalculateActionBuilder builder(CartRecalculateAction template)
      create builder for CartRecalculateAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withCartRecalculateAction

      default <T> T withCartRecalculateAction(Function<CartRecalculateAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<CartRecalculateAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference