ProductListRepresentation Class
Get the list of retrieved products.
Namespace
runtime_industries_cpq
ProductListRepresentation Properties
Learn more about the properties available with the ProductListRepresentation class.
The following are properties for ProductListRepresentation.
-
additionalFields
Get the key-value pair of additional standard or custom fields with their values.
-
attributeCategories
Get the list of categorized attributes related to the product.
-
availabilityDate
Get the date when the part is used in the product or is made available for sale.
-
catalogs
Get the list of associated catalogs. Returns the name and id values only.
-
categories
Get the list of associated categories. Returns the name and id values only.
-
childProducts
Get the hierarchy of the child products.
-
childVariationIds
Get the list of IDs of the child variations of the product.
-
configureDuringSale
Determines whether to allow or prevent configuration when a bundle is sold.
-
description
Get the description of the product. If data translation is set up and specified in the org, the translated description is available.
-
discontinuedDate
Get the date from when the part can’t be used in the product or sold.
-
displayUrl
Get the display image URL of the product.
-
endOfLifeDate
Get the date after which a product isn’t supported, ordered, or maintained.
-
id
Get the ID of the product.
-
isActive
Indicates whether the product is active (true) or not (false).
-
isAssetizable
Indicates whether the product instance remains a customer asset after it’s purchased (true) or not (false).
-
isComponentRequired
Indicates whether the product component is required (true) or not (false).
-
isDefaultComponent
Indicates whether the product component is the default component (true) or not (false).
-
isQuantityEditable
Indicates whether the product quantity is editable (true) or not (false).
-
isSoldOnlyWithOtherProds
Indicates whether the product can’t be sold separately (true) or not (false).
-
name
Get the name of the product. If data translation is set up and specified in the org, the translated name is available.
-
nodeType
Get the type of the node, such as a product or bundled product.
-
prices
Get the price details associated with the products.
-
productClass
Get the class of the product.
-
productClassification
Get the details of the product classification that the product is based on.
-
productCode
Get the universal product code that’s used to track the part that’s used in the product.
-
productComponentGroups
Get the logical grouping of the component products in a bundle and group cardinality for ordering the product components.
-
productInformation
Get the details of a product.
-
productPricingInformation
Get the pricing details of a product.
-
productQuantity
Get the quantity of a product.
-
productRelatedComponent
Get the details of the related components of a product.
-
productSellingModelOptions
Get the details of the product selling model options.
-
productSpecificationType
Get the details of the product specification type.
-
productType
Get the product type.
-
productUnitOfMeasures
Get the list of units of measure for the product.
-
qualificationContext
Get the context details of a user, which are used for qualification rules.
-
status
Get or set the status of the product, such as Active or Inactive.
-
unitOfMeasure
Get details about the unit of measure for a specific set of records.
-
variationAttributeSet
Get the variation attribute set of the product.
-
variationsCount
Get the number of variations of the product.
additionalFields
Get the key-value pair of additional standard or custom fields with their values.
Signature
public List<runtime_industries_cpq.AdditionalFieldsWrapper> additionalFields {get; set;}
Property Value
Type: List<runtime_industries_cpq.AdditionalFieldsWrapper>
attributeCategories
Get the list of categorized attributes related to the product.
Signature
public List<runtime_industries_cpq.AttributeCategoryOutputRepresentation> attributeCategories {get; set;}
Property Value
Type: List<runtime_industries_cpq.AttributeCategoryOutputRepresentation>
availabilityDate
Get the date when the part is used in the product or is made available for sale.
Signature
public Datetime availabilityDate {get; set;}
Property Value
Type: Datetime
catalogs
Get the list of associated catalogs. Returns the name and id values only.
Signature
public List<runtime_industries_cpq.CatalogOutputRepresentation> catalogs {get; set;}
Property Value
Type: List<runtime_industries_cpq.CatalogOutputRepresentation>
categories
Get the list of associated categories. Returns the name and id values only.
Signature
public List<runtime_industries_cpq.CategoryOutputRepresentation> categories {get; set;}
Property Value
Type: List<runtime_industries_cpq.CategoryOutputRepresentation>
childProducts
Get the hierarchy of the child products.
Signature
public List<runtime_industries_cpq.ProductListRepresentation> childProducts {get; set;}
Property Value
Type: List<runtime_industries_cpq.ProductListRepresentation>
childVariationIds
Get the list of IDs of the child variations of the product.
Signature
public List<String> childVariationIds {get; set;}
Property Value
Type: List<String>
configureDuringSale
Determines whether to allow or prevent configuration when a bundle is sold.
Signature
public String configureDuringSale {get; set;}
Property Value
Type: String
description
Get the description of the product. If data translation is set up and specified in the org, the translated description is available.
Signature
public String description {get; set;}
Property Value
Type: String
discontinuedDate
Get the date from when the part can’t be used in the product or sold.
Signature
public Datetime discontinuedDate {get; set;}
Property Value
Type: Datetime
displayUrl
Get the display image URL of the product.
Signature
public String displayUrl {get; set;}
Property Value
Type: String
endOfLifeDate
Get the date after which a product isn’t supported, ordered, or maintained.
Signature
public Datetime endOfLifeDate {get; set;}
Property Value
Type: Datetime
id
Get the ID of the product.
Signature
public String id {get; set;}
Property Value
Type: String
isActive
Indicates whether the product is active (true) or not (false).
Signature
public Boolean isActive {get; set;}
Property Value
Type: Boolean
isAssetizable
Indicates whether the product instance remains a customer asset after it’s purchased (true) or not (false).
Signature
public Boolean isAssetizable {get; set;}
Property Value
Type: Boolean
isComponentRequired
Indicates whether the product component is required (true) or not (false).
Signature
public Boolean isComponentRequired {get; set;}
Property Value
Type: Boolean
isDefaultComponent
Indicates whether the product component is the default component (true) or not (false).
Signature
public Boolean isDefaultComponent {get; set;}
Property Value
Type: Boolean
isQuantityEditable
Indicates whether the product quantity is editable (true) or not (false).
Signature
public Boolean isQuantityEditable {get; set;}
Property Value
Type: Boolean
isSoldOnlyWithOtherProds
Indicates whether the product can’t be sold separately (true) or not (false).
Signature
public Boolean isSoldOnlyWithOtherProds {get; set;}
Property Value
Type: Boolean
name
Get the name of the product. If data translation is set up and specified in the org, the translated name is available.
Signature
public String name {get; set;}
Property Value
Type: String
nodeType
Get the type of the node, such as a product or bundled product.
Signature
public String nodeType {get; set;}
Property Value
Type: String
prices
Get the price details associated with the products.
Signature
public List<runtime_industries_cpq.ProductPricesOutputRepresentation> prices {get; set;}
Property Value
Type: List<runtime_industries_cpq.ProductPricesOutputRepresentation>
productClass
Get the class of the product.
Signature
public String productClass {get; set;}
Property Value
Type: String
productClassification
Get the details of the product classification that the product is based on.
Signature
public runtime_industries_cpq.ProductClassificationOutputRepresentation productClassification {get; set;}
Property Value
Type: runtime_industries_cpq.ProductClassificationOutputRepresentation
productCode
Get the universal product code that’s used to track the part that’s used in the product.
Signature
public String productCode {get; set;}
Property Value
Type: String
productComponentGroups
Get the logical grouping of the component products in a bundle and group cardinality for ordering the product components.
Signature
public List<runtime_industries_cpq.ProductComponentGroupOutputRepresentation> productComponentGroups {get; set;}
Property Value
Type: List<runtime_industries_cpq.ProductComponentGroupOutputRepresentation>
productInformation
Get the details of a product.
Signature
public String productInformation {get; set;}
Property Value
Type: String
productPricingInformation
Get the pricing details of a product.
Signature
public String productPricingInformation {get; set;}
Property Value
Type: String
productQuantity
Get the quantity of a product.
Signature
public runtime_industries_cpq.ProductQuantityOutputRepresentation productQuantity {get; set;}
Property Value
Type: runtime_industries_cpq.ProductQuantityOutputRepresentation
productRelatedComponent
Get the details of the related components of a product.
Signature
public ConnectApi.CPQProductRelatedComponentOutputRepresentation productRelatedComponent {get; set;}
Property Value
Type: ConnectApi.CPQProductRelatedComponentOutputRepresentation
productSellingModelOptions
Get the details of the product selling model options.
Signature
public List<runtime_industries_cpq.ProductSellingModelOptionOutputRepresentation> productSellingModelOptions {get; set;}
Property Value
Type: List<runtime_industries_cpq.ProductSellingModelOptionOutputRepresentation>
productSpecificationType
Get the details of the product specification type.
Signature
public runtime_industries_cpq.ProductSpecificationTypeOutputRepresentation productSpecificationType {get; set;}
Property Value
Type: runtime_industries_cpq.ProductSpecificationTypeOutputRepresentation
productType
Get the product type.
Signature
public String productType {get; set;}
Property Value
Type: String
productUnitOfMeasures
Get the list of units of measure for the product.
Signature
public List<runtime_industries_cpq.ProductUnitOfMeasureOutputRepresentation> productUnitOfMeasures {get; set;}
Property Value
Type: List<runtime_industries_cpq.ProductUnitOfMeasureOutputRepresentation>
qualificationContext
Get the context details of a user, which are used for qualification rules.
Signature
public runtime_industries_cpq.QualificationContextOutputRepresentation qualificationContext {get; set;}
Property Value
Type: runtime_industries_cpq.QualificationContextOutputRepresentation
status
Get or set the status of the product, such as Active or Inactive.
Signature
public String status {get; set;}
Property Value
Type: String
unitOfMeasure
Get details about the unit of measure for a specific set of records.
Signature
public ConnectApi.UnitOfMeasureOutputRepresentation unitOfMeasure {get; set;}
Property Value
Type: ConnectApi.UnitOfMeasureOutputRepresentation
variationAttributeSet
Get the variation attribute set of the product.
Signature
public runtime_industries_cpq.ProductVariantAttributeSetOutputRepresentation variationAttributeSet {get; set;}
Property Value
Type: runtime_industries_cpq.ProductVariantAttributeSetOutputRepresentation
variationsCount
Get the number of variations of the product.
Signature
public Integer variationsCount {get; set;}
Property Value
Type: Integer
j