Package com.commercetools.api.models.cart

Interface CartSetCustomLineItemTaxRateAction

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

Can be used if the Cart has the External TaxMode.

Example to create an instance using the builder pattern 

     CartSetCustomLineItemTaxRateAction cartSetCustomLineItemTaxRateAction = CartSetCustomLineItemTaxRateAction.builder()
             .build()

  • Field Details

    • SET_CUSTOM_LINE_ITEM_TAX_RATE

      static final String SET_CUSTOM_LINE_ITEM_TAX_RATE
      discriminator value for CartSetCustomLineItemTaxRateAction
      See Also:

  • Method Details

    • getCustomLineItemId

      String getCustomLineItemId()

      id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Returns:
      customLineItemId

    • getCustomLineItemKey

      String getCustomLineItemKey()

      key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Returns:
      customLineItemKey

    • getExternalTaxRate

      @Valid @Valid ExternalTaxRateDraft getExternalTaxRate()

      Value to set. If empty, an existing value is removed.

      Returns:
      externalTaxRate

    • getShippingKey

      String getShippingKey()

      key of the ShippingMethod used for this Custom Line Item. This is required for Carts with Multiple ShippingMode.

      Returns:
      shippingKey

    • setCustomLineItemId

      void setCustomLineItemId(String customLineItemId)

      id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Parameters:
      customLineItemId - value to be set

    • setCustomLineItemKey

      void setCustomLineItemKey(String customLineItemKey)

      key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Parameters:
      customLineItemKey - value to be set

    • setExternalTaxRate

      void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

      Value to set. If empty, an existing value is removed.

      Parameters:
      externalTaxRate - value to be set

    • setShippingKey

      void setShippingKey(String shippingKey)

      key of the ShippingMethod used for this Custom Line Item. This is required for Carts with Multiple ShippingMode.

      Parameters:
      shippingKey - value to be set

    • of

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

    • of

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

    • copyDeep

      CartSetCustomLineItemTaxRateAction copyDeep()
      Specified by:
      copyDeep in interface CartUpdateAction

    • deepCopy

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

    • builder

      static CartSetCustomLineItemTaxRateActionBuilder builder()
      builder factory method for CartSetCustomLineItemTaxRateAction
      Returns:
      builder

    • builder

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

    • withCartSetCustomLineItemTaxRateAction

      default <T> T withCartSetCustomLineItemTaxRateAction(Function<CartSetCustomLineItemTaxRateAction,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<CartSetCustomLineItemTaxRateAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference