Package com.commercetools.api.models.cart

Interface CartSetShippingRateInputAction

All Superinterfaces:
CartUpdateAction, ResourceUpdateAction<CartUpdateAction>
All Known Implementing Classes:
CartSetShippingRateInputActionImpl
public interface CartSetShippingRateInputAction extends CartUpdateAction

Input used to select a ShippingRatePriceTier. If no matching tier can be found, or the input is not set, the default price for the shipping rate is used.

Example to create an instance using the builder pattern 

     CartSetShippingRateInputAction cartSetShippingRateInputAction = CartSetShippingRateInputAction.builder()
             .build()

  • Field Details

    • SET_SHIPPING_RATE_INPUT

      static final String SET_SHIPPING_RATE_INPUT
      discriminator value for CartSetShippingRateInputAction
      See Also:

  • Method Details

    • getShippingRateInput

      @Valid @Valid ShippingRateInputDraft getShippingRateInput()

      The data type of this field depends on the shippingRateInputType.type configured in the Project:

      • If CartClassification, it must be ClassificationShippingRateInputDraft.
      • If CartScore, it must be ScoreShippingRateInputDraft.
      • If CartValue, it cannot be set.
      Returns:
      shippingRateInput

    • setShippingRateInput

      void setShippingRateInput(ShippingRateInputDraft shippingRateInput)

      The data type of this field depends on the shippingRateInputType.type configured in the Project:

      • If CartClassification, it must be ClassificationShippingRateInputDraft.
      • If CartScore, it must be ScoreShippingRateInputDraft.
      • If CartValue, it cannot be set.
      Parameters:
      shippingRateInput - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static CartSetShippingRateInputActionBuilder builder()
      builder factory method for CartSetShippingRateInputAction
      Returns:
      builder

    • builder

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

    • withCartSetShippingRateInputAction

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

    • ofUnset

      static CartSetShippingRateInputAction ofUnset()

    • typeReference

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