runtime_industries_cpq Namespace

The runtime_industries_cpq namespace provides classes and methods to search products or to manage products, catalogs, and categories.

The runtime_industries_cpq namespace includes these classes.

Usage

You can access the runtime_industries_cpq classes if your org has the Product Discovery feature.

AdditionalContextData Class

Contains properties to include a list of additional context data nodes. These nodes are used along with the context definition nodes for data hydration.
AdditionalFields Class

Contains properties to include a map where the key is a string and the value is an instance of the AdditionalFieldsInput class.
AdditionalFieldsInput Class

Contains properties to include the additional standard or custom fields in the request.
ApiStatusRepresentation Class

Stores details of the API request such as execution messages, status code, and status message.
AttributeCategoryOutputRepresentation Class

Stores details of an attribute such as code, description, usage type, and so on.
AttributePickListOutputRepresentation Class

Stores details of an attribute picklist.
AttributePickListValueOutputRepresentation Class

Stores details of an attribute picklist value.
BulkProductDetailsInputBody Class

Contains the details of the request to retrieve product details by using product ID and product selling model ID.
BulkProductDetailsInputBodyList Class

Contains details of the request to retrieve a list of products.
BulkProductDetailsRepresentation Class

Get the details of multiple product definitions in a single request. This class is used for bulk product retrieval operations in Product Discovery.
CatalogOutputRepresentation Class

Contains properties to store details of a catalog definition.
ConfigRuleResult Class

Contains the results of configuration rule evaluation, including message rules, product recommendation rules, and visibility rules that are applied during product configuration.
CategoryOutputRepresentation Class

Contains properties to store details of a category.
ContextDataInput Class

Get details of a context.
FacetValueRepresentation Class

Get details of the facet values that are found in the search result.
Filter Class

Contains the criteria property to store the details of a filter criteria, which is used to filter records.
FilterCriteriaInputRepresentation Class

Contains properties to store criteria details to filter records based on supported properties.
FilterInputRepresentation Class

Contains the filter property to filters records based on supported criteria.
GuidedSelectionRepresentation Class

Contains properties to represent a product in a guided selection flow. This class is used in Product Discovery to provide structured product information during guided product selection processes.
GuidedSelectionSearchTerm Class

Represents a search term used in guided product selection. Contains the search term text and associated tags for filtering and searching products in Product Discovery.
GuidedSelectionSearchTermList Class

Contains a list of search terms used in guided product selection. This class is used to pass multiple search terms for filtering and searching products in Product Discovery.
MessageRule Class

Represents a message rule that is evaluated during product configuration. Message rules display informational, warning, or error messages to users based on configuration conditions.
PricingModelOutputRepresentation Class

Contains details of a pricing model in a product configuration.
ProductAttributeOutputRepresentation Class

Contains details about the attribute in a product configuration.
ProductClassificationOutputRepresentation Class

Get details of the product classification in a product configuration.
ProductComponentGroupOutputRepresentation Class

Get details of the product component group in a product classification.
ProductComponentGroupRepresentation Class

Represents a product component group used in bulk product operations. This class is similar to ProductComponentGroupOutputRepresentation but is used specifically for bulk product detail representations where components are represented as BulkProductDetailsRepresentation objects.
ProductDetailsRepresentation Class

Get the details of a product definition.
ProductListRepresentation Class

Get the list of retrieved products.
ProductOutputRepresentation Class

Get the details of a product definition.
ProductPricesOutputRepresentation Class

Get the price details of a product.
ProductQuantityOutputRepresentation Class

Represents the quantity constraints and current quantity for a product in the product discovery context.
ProductRecommendationRule Class

Represents a product recommendation rule that is evaluated during product configuration. Product recommendation rules suggest additional products to users based on configuration conditions.
ProductRelatedComponentOutputRepresentation Class

Represents a related component product in a bundle or product relationship, including component configuration details such as quantity constraints, required status, and relationship metadata.
ProductSellingModelOptionOutputRepresentation Class

Represents a selling model option available for a product, which defines how the product can be sold (such as subscription, one-time, or usage-based).
ProductSellingModelOutputRepresentation Class

Represents a product selling model that defines how a product is sold, including the selling model type, pricing term, and status.
ProductSpecificationRecordTypeOutputRepresentation Class

Represents the record type information for a product specification, which defines the type of record used to store product specification data.
ProductSpecificationTypeOutputRepresentation Class

Represents a product specification type that defines the structure and attributes available for configuring a product.
ProductUnitOfMeasureOutputRepresentation Class

Represents a unit of measure that’s available for a product, including whether it’s the base or default unit and whether it’s orderable.
ProductVariantAttributeOutputRepresentation Class

Stores details of an attribute that defines a product variation, including the field and its label.
ProductVariantAttributeSetOutputRepresentation Class

Stores the set of attributes that define the variations of a product.
ProductVariantAttributeValueOutputRepresentation Class

Stores the value of a product variation attribute.
QocQualificationOutputRepresentation Class

Represents a quote, order, or contract qualification that determines whether a product can be sold based on specific business rules and conditions.
QualificationContextOutputRepresentation Class

Represents the context information used for product qualification, including account, opportunity, and other relevant context data for determining product eligibility.
RelatedObjectFilter Class

Represents a filter for related objects used in product search and discovery, allowing you to filter products based on related object criteria.
RelatedObjectFilterInputRepresentation Class

Represents input criteria for filtering products based on related object information, such as account, opportunity, or contract data.
SearchProductsFacetRepresentation Class

Represents a search facet that provides filtering and categorization options for product search results, such as categories, attributes, or other product characteristics.
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.
UnitOfMeasureOutputRepresentation Class

Represents the unit of measure for a product. This class contains information about how product quantities are measured, including the unit code, name, scale, and rounding method.
VisibilityRule Class

Represents a visibility rule that is evaluated during product configuration. Visibility rules control the visibility of products, attributes, or other UI elements based on configuration conditions.