Package com.commercetools.api.models.order

Interface OrderSetShippingCustomFieldAction

All Superinterfaces:
OrderUpdateAction, ResourceUpdateAction<OrderUpdateAction>
public interface OrderSetShippingCustomFieldAction extends OrderUpdateAction
OrderSetShippingCustomFieldAction
Example to create an instance using the builder pattern 

     OrderSetShippingCustomFieldAction orderSetShippingCustomFieldAction = OrderSetShippingCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_SHIPPING_CUSTOM_FIELD

      static final String SET_SHIPPING_CUSTOM_FIELD
      discriminator value for OrderSetShippingCustomFieldAction
      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

    • getName

      @NotNull @NotNull String getName()

      Name of the Custom Field.

      Returns:
      name

    • getValue

      Object getValue()

      If value is absent or null, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Returns:
      value

    • 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

    • setName

      void setName(String name)

      Name of the Custom Field.

      Parameters:
      name - value to be set

    • setValue

      void setValue(Object value)

      If value is absent or null, this field will be removed if it exists. Trying to remove a field that does not exist will fail with an InvalidOperation error. If value is provided, it is set for the field defined by name.

      Parameters:
      value - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static OrderSetShippingCustomFieldActionBuilder builder()
      builder factory method for OrderSetShippingCustomFieldAction
      Returns:
      builder

    • builder

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

    • withOrderSetShippingCustomFieldAction

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