Package com.commercetools.api.models.order_edit

Interface StagedOrderRemoveCustomLineItemAction

All Superinterfaces:
ResourceUpdateAction<StagedOrderUpdateAction>, StagedOrderUpdateAction
public interface StagedOrderRemoveCustomLineItemAction extends StagedOrderUpdateAction

This update action does not support specifying a quantity, unlike the Remove LineItem update action.

If shippingDetails must be partially removed, use the Change CustomLineItem Quantity update action.

Example to create an instance using the builder pattern 

     StagedOrderRemoveCustomLineItemAction stagedOrderRemoveCustomLineItemAction = StagedOrderRemoveCustomLineItemAction.builder()
             .build()

  • Field Details

    • REMOVE_CUSTOM_LINE_ITEM

      static final String REMOVE_CUSTOM_LINE_ITEM
      discriminator value for StagedOrderRemoveCustomLineItemAction
      See Also:

  • Method Details

    • getCustomLineItemId

      String getCustomLineItemId()

      id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Returns:
      customLineItemId

    • getCustomLineItemKey

      String getCustomLineItemKey()

      key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Returns:
      customLineItemKey

    • setCustomLineItemId

      void setCustomLineItemId(String customLineItemId)

      id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Parameters:
      customLineItemId - value to be set

    • setCustomLineItemKey

      void setCustomLineItemKey(String customLineItemKey)

      key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

      Parameters:
      customLineItemKey - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static StagedOrderRemoveCustomLineItemActionBuilder builder()
      builder factory method for StagedOrderRemoveCustomLineItemAction
      Returns:
      builder

    • builder

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

    • withStagedOrderRemoveCustomLineItemAction

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