Package com.commercetools.api.models.order_edit

Interface StagedOrderSetCustomLineItemTaxAmountAction

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

Can be used if the Cart has the ExternalAmount TaxMode.

Example to create an instance using the builder pattern 

     StagedOrderSetCustomLineItemTaxAmountAction stagedOrderSetCustomLineItemTaxAmountAction = StagedOrderSetCustomLineItemTaxAmountAction.builder()
             .build()

  • Field Details

    • SET_CUSTOM_LINE_ITEM_TAX_AMOUNT

      static final String SET_CUSTOM_LINE_ITEM_TAX_AMOUNT
      discriminator value for StagedOrderSetCustomLineItemTaxAmountAction
      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

    • getExternalTaxAmount

      @Valid @Valid ExternalTaxAmountDraft getExternalTaxAmount()

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

      Returns:
      externalTaxAmount

    • 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

    • setExternalTaxAmount

      void setExternalTaxAmount(ExternalTaxAmountDraft externalTaxAmount)

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

      Parameters:
      externalTaxAmount - 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 StagedOrderSetCustomLineItemTaxAmountAction of()
      factory method
      Returns:
      instance of StagedOrderSetCustomLineItemTaxAmountAction

    • of

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

    • deepCopy

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

    • builder

      static StagedOrderSetCustomLineItemTaxAmountActionBuilder builder()
      builder factory method for StagedOrderSetCustomLineItemTaxAmountAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetCustomLineItemTaxAmountAction

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