Package com.commercetools.api.models.product

Interface ProductRemovePriceAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
All Known Implementing Classes:
ProductRemovePriceActionImpl
public interface ProductRemovePriceAction extends ProductUpdateAction
ProductRemovePriceAction
Example to create an instance using the builder pattern 

     ProductRemovePriceAction productRemovePriceAction = ProductRemovePriceAction.builder()
             .priceId("{priceId}")
             .build()

  • Field Details

  • Method Details

    • getPriceId

      @NotNull @NotNull String getPriceId()

      The id of the Embedded Price to remove.

      Returns:
      priceId

    • getSku

      String getSku()

      The sku of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" when priceId is not provided. This field is now deprecated, use 'priceId' instead.

      Returns:
      sku

    • getVariantId

      Long getVariantId()

      The id of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" when priceId is not provided. This field is now deprecated, use 'priceId' instead.

      Returns:
      variantId

    • getPrice

      @Valid @Valid PriceDraft getPrice()

      The Price identical to the one to be removed from the ProductVariant. This field is now deprecated, use 'priceId' instead.

      Returns:
      price

    • getStaged

      Boolean getStaged()

      If true, only the staged Embedded Price is removed. If false, both the current and staged Embedded Price are removed.

      Returns:
      staged

    • setPriceId

      void setPriceId(String priceId)

      The id of the Embedded Price to remove.

      Parameters:
      priceId - value to be set

    • setSku

      void setSku(String sku)

      The sku of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" when priceId is not provided. This field is now deprecated, use 'priceId' instead.

      Parameters:
      sku - value to be set

    • setVariantId

      void setVariantId(Long variantId)

      The id of the ProductVariant the provided Price should be removed from. Either 'variantId' or 'sku' is required" when priceId is not provided. This field is now deprecated, use 'priceId' instead.

      Parameters:
      variantId - value to be set

    • setPrice

      void setPrice(PriceDraft price)

      The Price identical to the one to be removed from the ProductVariant. This field is now deprecated, use 'priceId' instead.

      Parameters:
      price - value to be set

    • setStaged

      void setStaged(Boolean staged)

      If true, only the staged Embedded Price is removed. If false, both the current and staged Embedded Price are removed.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • deepCopy

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

    • builder

      static ProductRemovePriceActionBuilder builder()
      builder factory method for ProductRemovePriceAction
      Returns:
      builder

    • builder

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

    • withProductRemovePriceAction

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