Package com.commercetools.api.models.order

Interface OrderSetShippingCustomTypeAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderSetShippingCustomTypeAction extends OrderUpdateAction

This action sets, overwrites, or removes any existing Custom Type and Custom Fields for the Order's shippingMethod or shipping.

Example to create an instance using the builder pattern 

     OrderSetShippingCustomTypeAction orderSetShippingCustomTypeAction = OrderSetShippingCustomTypeAction.builder()
             .build()

  • Field Details

    • SET_SHIPPING_CUSTOM_TYPE

      static final String SET_SHIPPING_CUSTOM_TYPE
      discriminator value for OrderSetShippingCustomTypeAction
      See Also:

  • Method Details

    • getShippingKey

      String getShippingKey()

      The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize on a Order with Multiple ShippingMode. Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Order.

      Returns:
      shippingKey

    • getType

      @Valid @Valid TypeResourceIdentifier getType()

      Defines the Type that extends the specified ShippingMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the ShippingMethod.

      Returns:
      type

    • getFields

      @Valid @Valid FieldContainer getFields()

      Sets the Custom Fields fields for the shippingMethod.

      Returns:
      fields

    • setShippingKey

      void setShippingKey(String shippingKey)

      The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize on a Order with Multiple ShippingMode. Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Order.

      Parameters:
      shippingKey - value to be set

    • setType

      void setType(TypeResourceIdentifier type)

      Defines the Type that extends the specified ShippingMethod with Custom Fields. If absent, any existing Type and Custom Fields are removed from the ShippingMethod.

      Parameters:
      type - value to be set

    • setFields

      void setFields(FieldContainer fields)

      Sets the Custom Fields fields for the shippingMethod.

      Parameters:
      fields - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderSetShippingCustomTypeActionBuilder builder()
      builder factory method for OrderSetShippingCustomTypeAction
      Returns:
      builder

    • builder

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

    • withOrderSetShippingCustomTypeAction

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