Package com.commercetools.api.models.product

Interface ProductSetPricesAction

All Superinterfaces:
ProductUpdateAction, ResourceUpdateAction<ProductUpdateAction>
public interface ProductSetPricesAction extends ProductUpdateAction

Either variantId or sku is required.

Example to create an instance using the builder pattern 

     ProductSetPricesAction productSetPricesAction = ProductSetPricesAction.builder()
             .plusPrices(pricesBuilder -> pricesBuilder)
             .build()

  • Field Details

  • Method Details

    • getVariantId

      Long getVariantId()

      The id of the ProductVariant to update.

      Returns:
      variantId

    • getSku

      String getSku()

      The sku of the ProductVariant to update.

      Returns:
      sku

    • getPrices

      @NotNull @Valid @NotNull @Valid List<PriceDraft> getPrices()

      The Embedded Prices to set.

      If any two Embedded Prices in this array have the same key, a DuplicatePriceKey error is returned.

      If any two Embedded Prices in this array have the same price scope, a DuplicatePriceScope error is returned.

      If any two Embedded Prices in this array have overlapping validity periods within the same price scope, an OverlappingPriceValidity error is returned. An Embedded Price without validity period does not conflict with an Embedded Price defined for a time period.

      Returns:
      prices

    • getStaged

      Boolean getStaged()

      Whether only the staged ProductVariant is updated. If false, both the current and staged ProductVariant are updated.

      Returns:
      staged

    • setVariantId

      void setVariantId(Long variantId)

      The id of the ProductVariant to update.

      Parameters:
      variantId - value to be set

    • setSku

      void setSku(String sku)

      The sku of the ProductVariant to update.

      Parameters:
      sku - value to be set

    • setPrices

      void setPrices(PriceDraft... prices)

      The Embedded Prices to set.

      If any two Embedded Prices in this array have the same key, a DuplicatePriceKey error is returned.

      If any two Embedded Prices in this array have the same price scope, a DuplicatePriceScope error is returned.

      If any two Embedded Prices in this array have overlapping validity periods within the same price scope, an OverlappingPriceValidity error is returned. An Embedded Price without validity period does not conflict with an Embedded Price defined for a time period.

      Parameters:
      prices - values to be set

    • setPrices

      void setPrices(List<PriceDraft> prices)

      The Embedded Prices to set.

      If any two Embedded Prices in this array have the same key, a DuplicatePriceKey error is returned.

      If any two Embedded Prices in this array have the same price scope, a DuplicatePriceScope error is returned.

      If any two Embedded Prices in this array have overlapping validity periods within the same price scope, an OverlappingPriceValidity error is returned. An Embedded Price without validity period does not conflict with an Embedded Price defined for a time period.

      Parameters:
      prices - values to be set

    • setStaged

      void setStaged(Boolean staged)

      Whether only the staged ProductVariant is updated. If false, both the current and staged ProductVariant are updated.

      Parameters:
      staged - value to be set

    • of

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

    • of

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

    • copyDeep

      ProductSetPricesAction copyDeep()
      Specified by:
      copyDeep in interface ProductUpdateAction

    • deepCopy

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

    • builder

      static ProductSetPricesActionBuilder builder()
      builder factory method for ProductSetPricesAction
      Returns:
      builder

    • builder

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

    • withProductSetPricesAction

      default <T> T withProductSetPricesAction(Function<ProductSetPricesAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static tools.jackson.core.type.TypeReference<ProductSetPricesAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference