Package com.commercetools.api.models.cart

Interface Shipping

public interface Shipping
Shipping
Example to create an instance using the builder pattern 

     Shipping shipping = Shipping.builder()
             .shippingKey("{shippingKey}")
             .shippingInfo(shippingInfoBuilder -> shippingInfoBuilder)
             .shippingAddress(shippingAddressBuilder -> shippingAddressBuilder)
             .build()

  • Method Details

    • getShippingKey

      @NotNull @NotNull String getShippingKey()

      User-defined unique identifier of the Shipping in a Cart with Multiple ShippingMode.

      Returns:
      shippingKey

    • getShippingInfo

      @NotNull @Valid @NotNull @Valid ShippingInfo getShippingInfo()

      Automatically set when the Shipping Method is added.

      Returns:
      shippingInfo

    • getShippingAddress

      @NotNull @Valid @NotNull @Valid Address getShippingAddress()

      Determines the shipping rates and Tax Rates of associated Line Items.

      Returns:
      shippingAddress

    • getShippingRateInput

      @Valid @Valid ShippingRateInput getShippingRateInput()

      Used as an input to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

      • If CartClassification, it is ClassificationShippingRateInput.
      • If CartScore, it is ScoreShippingRateInput.
      • If CartValue, it cannot be used.
      Returns:
      shippingRateInput

    • getShippingCustomFields

      @Valid @Valid CustomFields getShippingCustomFields()

      Custom Fields of Shipping with Multiple ShippingMode.

      Returns:
      shippingCustomFields

    • setShippingKey

      void setShippingKey(String shippingKey)

      User-defined unique identifier of the Shipping in a Cart with Multiple ShippingMode.

      Parameters:
      shippingKey - value to be set

    • setShippingInfo

      void setShippingInfo(ShippingInfo shippingInfo)

      Automatically set when the Shipping Method is added.

      Parameters:
      shippingInfo - value to be set

    • setShippingAddress

      void setShippingAddress(Address shippingAddress)

      Determines the shipping rates and Tax Rates of associated Line Items.

      Parameters:
      shippingAddress - value to be set

    • setShippingRateInput

      void setShippingRateInput(ShippingRateInput shippingRateInput)

      Used as an input to select a ShippingRatePriceTier. The data type of this field depends on the shippingRateInputType.type configured in the Project:

      • If CartClassification, it is ClassificationShippingRateInput.
      • If CartScore, it is ScoreShippingRateInput.
      • If CartValue, it cannot be used.
      Parameters:
      shippingRateInput - value to be set

    • setShippingCustomFields

      void setShippingCustomFields(CustomFields shippingCustomFields)

      Custom Fields of Shipping with Multiple ShippingMode.

      Parameters:
      shippingCustomFields - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ShippingBuilder builder()
      builder factory method for Shipping
      Returns:
      builder

    • builder

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

    • withShipping

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