SearchProductsRepresentation Class

Represents the results of a product search operation, including the list of products, search facets, pagination information, and total count of matching products.

runtime_industries_cpq

Learn more about the properties available with the SearchProductsRepresentation class.

The SearchProductsRepresentation class includes these properties.

  • additionalFields

    Get or set additional custom fields for the product in the search results.

  • attributeCategories

    Get or set the list of attribute categories that contain product attributes for configuration.

  • availabilityDate

    Get or set the date when the product becomes available for sale.

  • catalogs

    Get or set the list of catalogs that this product belongs to.

  • childVariationIds

    Get the list of IDs of the child variations of the product.

  • configureDuringSale

    Get or set whether the product can be configured during the sales process.

  • description

    Get or set the description of the product in the search results. If data translation is set up and specified in the org, the translated description is available.

  • discontinuedDate

    Get or set the date when the product was discontinued.

  • displayUrl

    Get or set the URL to display additional information about the product.

  • endOfLifeDate

    Get or set the end of life date for the product.

  • id

    Get or set the ID of the product in the search results.

  • isActive

    Get or set whether the product is active (true) or not (false) in the search results.

  • isAssetizable

    Get or set whether the product can be converted to an asset after sale.

  • isComponentRequired

    Get or set whether this component is required in a bundle or product relationship.

  • isDefaultComponent

    Get or set whether this component is selected by default in a bundle or product relationship.

  • isQuantityEditable

    Get or set whether the quantity of this product can be edited.

  • isSoldOnlyWithOtherProds

    Get or set whether this product can only be sold with other products.

  • name

    Get or set the name of the product in the search results. If data translation is set up and specified in the org, the translated name is available.

  • nodeType

    Get or set the node type of the product, such as “Product” or “Bundle”.

  • prices

    Get or set the list of prices available for this product.

  • productCategories

    Get the list of categories that the product belongs to.

  • productClass

    Get the class of the product.

  • productClassification

    Get or set the product classification information for this product.

  • productCode

    Get or set the universal product code that’s used to track the part that’s used in the product.

  • productComponentGroups

    Get or set the list of product component groups that organize related components.

  • productInformation

    Get or set additional product information details.

  • productPricingInformation

    Get or set the pricing information for this product, including price lists and pricing models.

  • productQuantity

    Get or set the quantity constraints and current quantity for this product.

  • productRelatedComponent

    Get or set the related component information for this product in bundle or product relationships.

  • productSellingModelOptions

    Get or set the list of selling model options available for this product.

  • productSpecificationType

    Get or set the product specification type that defines the structure and attributes for configuring this product.

  • productType

    Get or set the type of product, such as “Product”, “Service”, or “Bundle”.

  • productUnitOfMeasures

    Get the list of units of measure for the product.

  • qualificationContext

    Get or set the qualification context that contains the qualification result and reason for this product.

  • status

    Get or set the status of the product, such as “Active” or “Inactive”.

  • unitOfMeasure

    Get or set the unit of measure for the quantity of this product.

  • variationAttributeSet

    Get the variation attribute set of the product.

  • variationsCount

    Get the number of variations of the product.

Get or set additional custom fields for the product in the search results.

public List<runtime_industries_cpq.AdditionalFieldsWrapper> additionalFields {get; set;}

Type: List<runtime_industries_cpq.AdditionalFieldsWrapper>

Get or set the list of attribute categories that contain product attributes for configuration.

public List<runtime_industries_cpq.AttributeCategoryOutputRepresentation> attributeCategories {get; set;}

Type: List<runtime_industries_cpq.AttributeCategoryOutputRepresentation>

Get or set the date when the product becomes available for sale.

public Datetime availabilityDate {get; set;}

Type: Datetime

Get or set the list of catalogs that this product belongs to.

public List<runtime_industries_cpq.CatalogOutputRepresentation> catalogs {get; set;}

Type: List<runtime_industries_cpq.CatalogOutputRepresentation>

Get the list of IDs of the child variations of the product.

public List<String> childVariationIds {get; set;}

Type: List<String>

Get or set whether the product can be configured during the sales process.

public String configureDuringSale {get; set;}

Type: String

Get or set the description of the product in the search results. If data translation is set up and specified in the org, the translated description is available.

public String description {get; set;}

Type: String

Get or set the date when the product was discontinued.

public Datetime discontinuedDate {get; set;}

Type: Datetime

Get or set the URL to display additional information about the product.

public String displayUrl {get; set;}

Type: String

Get or set the end of life date for the product.

public Datetime endOfLifeDate {get; set;}

Type: Datetime

Get or set the ID of the product in the search results.

public String id {get; set;}

Type: String

Get or set whether the product is active (true) or not (false) in the search results.

public Boolean isActive {get; set;}

Type: Boolean

Get or set whether the product can be converted to an asset after sale.

public Boolean isAssetizable {get; set;}

Type: Boolean

Get or set whether this component is required in a bundle or product relationship.

public Boolean isComponentRequired {get; set;}

Type: Boolean

Get or set whether this component is selected by default in a bundle or product relationship.

public Boolean isDefaultComponent {get; set;}

Type: Boolean

Get or set whether the quantity of this product can be edited.

public Boolean isQuantityEditable {get; set;}

Type: Boolean

Get or set whether this product can only be sold with other products.

public Boolean isSoldOnlyWithOtherProds {get; set;}

Type: Boolean

Get or set the name of the product in the search results. If data translation is set up and specified in the org, the translated name is available.

public String name {get; set;}

Type: String

Get or set the node type of the product, such as “Product” or “Bundle”.

public String nodeType {get; set;}

Type: String

Get or set the list of prices available for this product.

public List<runtime_industries_cpq.ProductPricesOutputRepresentation> prices {get; set;}

Type: List<runtime_industries_cpq.ProductPricesOutputRepresentation>

Get the list of categories that the product belongs to.

public List<runtime_industries_cpq.CategoryOutputRepresentation> productCategories {get; set;}

Type: List<runtime_industries_cpq.CategoryOutputRepresentation>

Get the class of the product.

public String productClass {get; set;}

Type: String

Get or set the product classification information for this product.

public runtime_industries_cpq.ProductClassificationOutputRepresentation productClassification {get; set;}

Type: runtime_industries_cpq.ProductClassificationOutputRepresentation

Get or set the universal product code that’s used to track the part that’s used in the product.

public String productCode {get; set;}

Type: String

Get or set the list of product component groups that organize related components.

public List<runtime_industries_cpq.ProductComponentGroupOutputRepresentation> productComponentGroups {get; set;}

Type: List<runtime_industries_cpq.ProductComponentGroupOutputRepresentation>

Get or set additional product information details.

public String productInformation {get; set;}

Type: String

Get or set the pricing information for this product, including price lists and pricing models.

public String productPricingInformation {get; set;}

Type: String

Get or set the quantity constraints and current quantity for this product.

public runtime_industries_cpq.ProductQuantityOutputRepresentation productQuantity {get; set;}

Type: runtime_industries_cpq.ProductQuantityOutputRepresentation

Get or set the related component information for this product in bundle or product relationships.

public ConnectApi.CPQProductRelatedComponentOutputRepresentation productRelatedComponent {get; set;}

Type: ConnectApi.CPQProductRelatedComponentOutputRepresentation

Get or set the list of selling model options available for this product.

public List<runtime_industries_cpq.ProductSellingModelOptionOutputRepresentation> productSellingModelOptions {get; set;}

Type: List<runtime_industries_cpq.ProductSellingModelOptionOutputRepresentation>

Get or set the product specification type that defines the structure and attributes for configuring this product.

public runtime_industries_cpq.ProductSpecificationTypeOutputRepresentation productSpecificationType {get; set;}

Type: runtime_industries_cpq.ProductSpecificationTypeOutputRepresentation

Get or set the type of product, such as “Product”, “Service”, or “Bundle”.

public String productType {get; set;}

Type: String

Get the list of units of measure for the product.

public List<runtime_industries_cpq.ProductUnitOfMeasureOutputRepresentation> productUnitOfMeasures {get; set;}

Type: List<runtime_industries_cpq.ProductUnitOfMeasureOutputRepresentation>

Get or set the qualification context that contains the qualification result and reason for this product.

public runtime_industries_cpq.QualificationContextOutputRepresentation qualificationContext {get; set;}

Type: runtime_industries_cpq.QualificationContextOutputRepresentation

Get or set the status of the product, such as “Active” or “Inactive”.

public String status {get; set;}

Type: String

Get or set the unit of measure for the quantity of this product.

public ConnectApi.UnitOfMeasureOutputRepresentation unitOfMeasure {get; set;}

Type: ConnectApi.UnitOfMeasureOutputRepresentation

Get the variation attribute set of the product.

public runtime_industries_cpq.ProductVariantAttributeSetOutputRepresentation variationAttributeSet {get; set;}

Type: runtime_industries_cpq.ProductVariantAttributeSetOutputRepresentation

Get the number of variations of the product.

public Integer variationsCount {get; set;}

Type: Integer