Package com.commercetools.api.models.order_edit

Interface StagedOrderSetShippingCustomFieldAction

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

     StagedOrderSetShippingCustomFieldAction stagedOrderSetShippingCustomFieldAction = StagedOrderSetShippingCustomFieldAction.builder()
             .name("{name}")
             .build()

  • Field Details

    • SET_SHIPPING_CUSTOM_FIELD

      static final String SET_SHIPPING_CUSTOM_FIELD
      discriminator value for StagedOrderSetShippingCustomFieldAction
      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 StagedOrderSetShippingCustomFieldAction of()
      factory method
      Returns:
      instance of StagedOrderSetShippingCustomFieldAction

    • of

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

    • copyDeep

      StagedOrderSetShippingCustomFieldAction copyDeep()
      Specified by:
      copyDeep in interface StagedOrderUpdateAction

    • deepCopy

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

    • builder

      static StagedOrderSetShippingCustomFieldActionBuilder builder()
      builder factory method for StagedOrderSetShippingCustomFieldAction
      Returns:
      builder

    • builder

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

    • withStagedOrderSetShippingCustomFieldAction

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