ProductDetailsRepresentation Class

Get the details of a product definition.

runtime_industries_cpq

Learn more about the constructor that’s available with the ProductDetailsRepresentation class.

The ProductDetailsRepresentation class includes this constructor.

Constructor to get the product details for a product definition.

public ProductDetailsRepresentation()

Learn more about the properties available with the ProductDetailsRepresentation class.

The ProductDetailsRepresentation includes these properties.

  • 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.

  • attributes

    Get the list of uncategorized 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 the associated catalogs returned with the Product List API (POST) response. The Product By ID API (GET) returns an empty catalog list in the response. 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.

  • 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.

  • 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 the 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.

Get the key-value pair of additional standard or custom fields with their values.

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

Type: List<runtime_industries_cpq.AdditionalFieldsWrapper>

Get the list of categorized attributes related to the product.

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

Type: List<runtime_industries_cpq.AttributeCategoryOutputRepresentation>

Get the list of uncategorized attributes related to the product.

public List<runtime_industries_cpq.ProductAttributeOutputRepresentation> attributes {get; set;}

Type: List<runtime_industries_cpq.ProductAttributeOutputRepresentation>

Get the date when the part is used in the product or is made available for sale.

public Datetime availabilityDate {get; set;}

Type: Datetime

Get the list of the associated catalogs returned with the Product List API (POST) response. The Product By ID API (GET) returns an empty catalog list in the response. Returns the name and id values only.

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

Type: List<runtime_industries_cpq.CatalogOutputRepresentation>

Get the hierarchy of the child products.

public List<runtime_industries_cpq.ProductDetailsRepresentation> childProducts {get; set;}

Type: List<runtime_industries_cpq.ProductDetailsRepresentation>

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

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

Type: List<String>

Determines whether to allow or prevent configuration when a bundle is sold.

public String configureDuringSale {get; set;}

Type: String

Get the description of the product.

If data translation is set up and specified in the org, the translated description is available.

public String description {get; set;}

Type: String

Get the date from when the part can’t be used in the product or sold.

public Datetime discontinuedDate {get; set;}

Type: Datetime

Get the display image URL of the product.

public String displayUrl {get; set;}

Type: String

Get the date after which a product isn’t supported, ordered, or maintained.

public Datetime endOfLifeDate {get; set;}

Type: Datetime

Get the ID of the product.

public String id {get; set;}

Type: String

Indicates whether the product is active (true) or not (false).

public Boolean isActive {get; set;}

Type: Boolean

Indicates whether the product instance remains a customer asset after it’s purchased (true) or not (false).

public Boolean isAssetizable {get; set;}

Type: Boolean

Indicates whether the product component is required (true) or not (false).

public Boolean isComponentRequired {get; set;}

Type: Boolean

Indicates whether the product component is the default component (true) or not (false).

public Boolean isDefaultComponent {get; set;}

Type: Boolean

Indicates whether the product quantity is editable (true) or not (false).

public Boolean isQuantityEditable {get; set;}

Type: Boolean

Indicates whether the product can’t be sold separately (true) or not (false).

public Boolean isSoldOnlyWithOtherProds {get; set;}

Type: Boolean

Get the name of the product.

If data translation is set up and specified in the org, the translated name is available.

public String name {get; set;}

Type: String

Get the type of the node, such as a product or bundled product.

public String nodeType {get; set;}

Type: String

Get the price details associated with the products.

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

Type: List<runtime_industries_cpq.ProductPricesOutputRepresentation>

Get the class of the product.

public String productClass {get; set;}

Type: String

Get the details of the product classification that the product is based on.

public runtime_industries_cpq.ProductClassificationOutputRepresentation productClassification {get; set;}

Type: runtime_industries_cpq.ProductClassificationOutputRepresentation

Get 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 the logical grouping of the component products in a bundle and the group cardinality for ordering the product components.

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

Type: List<runtime_industries_cpq.ProductComponentGroupOutputRepresentation>

Get the details of a product.

public String productInformation {get; set;}

Type: String

Get the pricing details of a product.

public String productPricingInformation {get; set;}

Type: String

Get the quantity of a product.

public runtime_industries_cpq.ProductQuantityOutputRepresentation productQuantity {get; set;}

Type: runtime_industries_cpq.ProductQuantityOutputRepresentation

Get the details of the related components of a product.

public ConnectApi.CPQProductRelatedComponentOutputRepresentation productRelatedComponent {get; set;}

Type: ConnectApi.CPQProductRelatedComponentOutputRepresentation

Get the details of the product selling model options.

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

Type: List<runtime_industries_cpq.ProductSellingModelOptionOutputRepresentation>

Get the details of the product specification type.

public runtime_industries_cpq.ProductSpecificationTypeOutputRepresentation productSpecificationType {get; set;}

Type: runtime_industries_cpq.ProductSpecificationTypeOutputRepresentation

Get the product type.

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 the context details of a user, which are used for qualification rules.

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 details about the unit of measure for a specific set of records.

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