Package com.commercetools.api.models.order

Interface ShippingInfoImportDraft

All Superinterfaces:
Draft<ShippingInfoImportDraft>
public interface ShippingInfoImportDraft extends Draft<ShippingInfoImportDraft>

Becomes the shippingInfo of the imported Order.

Example to create an instance using the builder pattern 

     ShippingInfoImportDraft shippingInfoImportDraft = ShippingInfoImportDraft.builder()
             .shippingMethodName("{shippingMethodName}")
             .price(priceBuilder -> priceBuilder)
             .shippingRate(shippingRateBuilder -> shippingRateBuilder)
             .build()

  • Method Details

    • getShippingMethodName

      @NotNull @NotNull String getShippingMethodName()

      Name of the Shipping Method.

      Returns:
      shippingMethodName

    • getPrice

      @NotNull @Valid @NotNull @Valid Money getPrice()

      The base price for the Shipping Method.

      Returns:
      price

    • getShippingRate

      @NotNull @Valid @NotNull @Valid ShippingRateDraft getShippingRate()

      Shipping rate information for the Order.

      Returns:
      shippingRate

    • getTaxRate

      @Valid @Valid TaxRate getTaxRate()

      Include a Tax Rate for the Shipping Method.

      Returns:
      taxRate

    • getTaxCategory

      @Valid @Valid TaxCategoryResourceIdentifier getTaxCategory()

      Include a value to associate a Tax Category with the shipping information.

      Returns:
      taxCategory

    • getShippingMethod

      @Valid @Valid ShippingMethodResourceIdentifier getShippingMethod()

      Include a value to associate a Shipping Method with the Order.

      Returns:
      shippingMethod

    • getDeliveries

      @Valid @Valid List<DeliveryDraft> getDeliveries()

      Information on how items are to be delivered to customers.

      Returns:
      deliveries

    • getDiscountedPrice

      @Valid @Valid DiscountedLineItemPriceDraft getDiscountedPrice()

      Discounted Price of the Shipping Method.

      Returns:
      discountedPrice

    • getShippingMethodState

      ShippingMethodState getShippingMethodState()

      Indicates if the ShippingMethod referenced is allowed for the Order or not.

      Returns:
      shippingMethodState

    • setShippingMethodName

      void setShippingMethodName(String shippingMethodName)

      Name of the Shipping Method.

      Parameters:
      shippingMethodName - value to be set

    • setPrice

      void setPrice(Money price)

      The base price for the Shipping Method.

      Parameters:
      price - value to be set

    • setShippingRate

      void setShippingRate(ShippingRateDraft shippingRate)

      Shipping rate information for the Order.

      Parameters:
      shippingRate - value to be set

    • setTaxRate

      void setTaxRate(TaxRate taxRate)

      Include a Tax Rate for the Shipping Method.

      Parameters:
      taxRate - value to be set

    • setTaxCategory

      void setTaxCategory(TaxCategoryResourceIdentifier taxCategory)

      Include a value to associate a Tax Category with the shipping information.

      Parameters:
      taxCategory - value to be set

    • setShippingMethod

      void setShippingMethod(ShippingMethodResourceIdentifier shippingMethod)

      Include a value to associate a Shipping Method with the Order.

      Parameters:
      shippingMethod - value to be set

    • setDeliveries

      void setDeliveries(DeliveryDraft... deliveries)

      Information on how items are to be delivered to customers.

      Parameters:
      deliveries - values to be set

    • setDeliveries

      void setDeliveries(List<DeliveryDraft> deliveries)

      Information on how items are to be delivered to customers.

      Parameters:
      deliveries - values to be set

    • setDiscountedPrice

      void setDiscountedPrice(DiscountedLineItemPriceDraft discountedPrice)

      Discounted Price of the Shipping Method.

      Parameters:
      discountedPrice - value to be set

    • setShippingMethodState

      void setShippingMethodState(ShippingMethodState shippingMethodState)

      Indicates if the ShippingMethod referenced is allowed for the Order or not.

      Parameters:
      shippingMethodState - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ShippingInfoImportDraftBuilder builder()
      builder factory method for ShippingInfoImportDraft
      Returns:
      builder

    • builder

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

    • withShippingInfoImportDraft

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