Package com.commercetools.api.models.order_edit

Interface StagedOrderSetLineItemTaxRateAction

All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction
public interface StagedOrderSetLineItemTaxRateAction extends StagedOrderUpdateAction

Can be used if the Cart has the External TaxMode.

Example to create an instance using the builder pattern 

     StagedOrderSetLineItemTaxRateAction stagedOrderSetLineItemTaxRateAction = StagedOrderSetLineItemTaxRateAction.builder()
             .build()

  • Field Details

    • SET_LINE_ITEM_TAX_RATE

      static final String SET_LINE_ITEM_TAX_RATE
      discriminator value for StagedOrderSetLineItemTaxRateAction
      See Also:

  • Method Details

    • getLineItemId

      String getLineItemId()

      id of the LineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemId

    • getLineItemKey

      String getLineItemKey()

      key of the LineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemKey

    • getExternalTaxRate

      @Valid @Valid ExternalTaxRateDraft getExternalTaxRate()

      Value to set. If empty, any existing value will be removed.

      Returns:
      externalTaxRate

    • getShippingKey

      String getShippingKey()

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

      Returns:
      shippingKey

    • setLineItemId

      void setLineItemId(String lineItemId)

      id of the LineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemId - value to be set

    • setLineItemKey

      void setLineItemKey(String lineItemKey)

      key of the LineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemKey - value to be set

    • setExternalTaxRate

      void setExternalTaxRate(ExternalTaxRateDraft externalTaxRate)

      Value to set. If empty, any existing value will be removed.

      Parameters:
      externalTaxRate - value to be set

    • setShippingKey

      void setShippingKey(String shippingKey)

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

      Parameters:
      shippingKey - value to be set

    • of

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

    • of

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

    • copyDeep

      StagedOrderSetLineItemTaxRateAction copyDeep()
      Specified by:
      copyDeep in interface StagedOrderUpdateAction

    • deepCopy

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

    • builder

      static StagedOrderSetLineItemTaxRateActionBuilder builder()
      builder factory method for StagedOrderSetLineItemTaxRateAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetLineItemTaxRateAction

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