Package com.commercetools.api.models.order_edit

Interface StagedOrderChangeLineItemQuantityAction

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

When multiple shipping addresses are set for a Line Item, use the Remove LineItem and Add LineItem update action to change the shipping details. Since it is not possible for the API to infer how the overall change in the Line Item quantity should be distributed over the sub-quantities, the shippingDetails field is kept in its current state to avoid data loss.

To change the Line Item quantity and shipping details together, use this update action in combination with the Set LineItem ShippingDetails update action in a single Order update command.

The LineItem price is updated as described in Line Item price selection.

Example to create an instance using the builder pattern 

     StagedOrderChangeLineItemQuantityAction stagedOrderChangeLineItemQuantityAction = StagedOrderChangeLineItemQuantityAction.builder()
             .quantity(0.3)
             .build()

  • Field Details

    • CHANGE_LINE_ITEM_QUANTITY

      static final String CHANGE_LINE_ITEM_QUANTITY
      discriminator value for StagedOrderChangeLineItemQuantityAction
      See Also:

  • Method Details

    • getLineItemId

      String getLineItemId()

      id of the LineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemId

    • getLineItemKey

      String getLineItemKey()

      key of the LineItem to update. Either lineItemId or lineItemKey is required.

      Returns:
      lineItemKey

    • getQuantity

      @NotNull @NotNull Long getQuantity()

      New value to set. If 0, the LineItem is removed from the Order.

      Returns:
      quantity

    • getExternalPrice

      @Valid @Valid Money getExternalPrice()

      Required when the Line Item uses ExternalPrice LineItemPriceMode. Sets the LineItem price to the given value when changing the quantity of a Line Item.

      The LineItem price is updated as described in Line Item price selection.

      To set the money value in high precision, use HighPrecisionMoneyDraft.

      Returns:
      externalPrice

    • getExternalTotalPrice

      @Valid @Valid ExternalLineItemTotalPrice getExternalTotalPrice()

      Sets the LineItem price and totalPrice to the given value when changing the quantity of a Line Item with the ExternalTotal LineItemPriceMode. If externalTotalPrice is not given and the priceMode is ExternalTotal, the external price is unset and the priceMode is set to Platform.

      Returns:
      externalTotalPrice

    • setLineItemId

      void setLineItemId(String lineItemId)

      id of the LineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemId - value to be set

    • setLineItemKey

      void setLineItemKey(String lineItemKey)

      key of the LineItem to update. Either lineItemId or lineItemKey is required.

      Parameters:
      lineItemKey - value to be set

    • setQuantity

      void setQuantity(Long quantity)

      New value to set. If 0, the LineItem is removed from the Order.

      Parameters:
      quantity - value to be set

    • setExternalPrice

      void setExternalPrice(Money externalPrice)

      Required when the Line Item uses ExternalPrice LineItemPriceMode. Sets the LineItem price to the given value when changing the quantity of a Line Item.

      The LineItem price is updated as described in Line Item price selection.

      To set the money value in high precision, use HighPrecisionMoneyDraft.

      Parameters:
      externalPrice - value to be set

    • setExternalTotalPrice

      void setExternalTotalPrice(ExternalLineItemTotalPrice externalTotalPrice)

      Sets the LineItem price and totalPrice to the given value when changing the quantity of a Line Item with the ExternalTotal LineItemPriceMode. If externalTotalPrice is not given and the priceMode is ExternalTotal, the external price is unset and the priceMode is set to Platform.

      Parameters:
      externalTotalPrice - value to be set

    • of

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

    • of

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

    • copyDeep

      StagedOrderChangeLineItemQuantityAction copyDeep()
      Specified by:
      copyDeep in interface StagedOrderUpdateAction

    • deepCopy

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

    • builder

      static StagedOrderChangeLineItemQuantityActionBuilder builder()
      builder factory method for StagedOrderChangeLineItemQuantityAction
      Returns:
      builder

    • builder

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

    • withStagedOrderChangeLineItemQuantityAction

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