Configurator Product Related Component | REST Reference | Communications, Media, Energy and Utilities (CME) Developer Guide

Output representation of the product related component in a product configuration.

JSON Example

1"productRelatedComponent": {
2           "childProductId": "01txx0000006jmWAAQ",
3           "childSellingModelId": "0jPxx000000004rEAA",
4           "doesBundlePriceIncludeChild": true,
5           "id": "0dSxx000000001dEAA",
6           "isComponentRequired": false,
7           "isDefaultComponent": false,
8           "isQuantityEditable": false,
9           "parentProductId": "01txx0000006jkuAAA",
10           "parentSellingModelId": "0jPxx000000004rEAA",
11           "productComponentGroupId": "0y7xx000000001dAAA",
12           "productRelationshipTypeId": "0yoxx00000001IfAAI",
13           "quantity": 1,
14           "quantityScaleMethod": "Proportional",
15           "quoteVisibility": "Quote Document Only"
16         }

Property Name	Type	Description	Filter Group and Version	Available Version
`childProductId`	String	ID of the child product in the bundle.	Small, 60.0	60.0
`childSellingModelId`	String	ID of the child product selling model record.	Small, 60.0	60.0
`doesBundlePriceIncludeChild`	Boolean	Indicates whether the price of the bundle includes the child product (`true`) or not (`false`).	Small, 60.0	60.0
`id`	String	ID of the product related component.	Small, 60.0	60.0
`isComponentRequired`	Boolean	Indicates whether the component is required in the bundle (`true`) or not (`false`).	Small, 60.0	60.0
`isDefaultComponent`	Boolean	Indicates whether to select the component in the bundle group by default (`true`) or not (`false`).	Small, 60.0	60.0
`isQuantityEditable`	Boolean	Indicates whether to allow changes to the quantity of the component in the bundle (`true`) or not (`false`).	Small, 60.0	60.0
`maxQuantity`	Double	Maximum quantity of the product in the opportunity, quote, or order line item.	Small, 60.0	60.0
`minQuantity`	Double	Minimum quantity of the product in the opportunity, quote, or order line item.	Small, 60.0	60.0
`parentProductId`	String	ID of the parent product.	Small, 60.0	60.0
`parentSellingModelId`	String	ID of the parent product selling model record.	Small, 60.0	60.0
`productClassificationId`	String	ID of the product classification record.	Small, 60.0	60.0
`productComponentGroupId`	String	ID of the product component group.	Small, 60.0	60.0
`productRelationshipTypeId`	String	ID of the product relationship type record.	Small, 60.0	60.0
`quantity`	Double	Quantity of the child products.	Small, 60.0	60.0
`quantityScaleMethod`	String	Method to scale the quantity of the child product in relation to the quantity of the parent. Valid values are: `Constant` `Proportional`	Small, 60.0	60.0
`quoteVisibility`	String	Specifies whether a quote line item must be shown on the transaction line editor or quote document. Valid values are: `Always` `Transaction Line Editor Only`—Specifies whether to show a quote line item on quote editor only. `Quote Document Only`—Specifies whether to show a quote line item on quote proposal only. `Never` The API returns this property only if the CoreCPQ permission set is available.	Small, 64.0	64.0
`sequence`	Integer	Order in which the child products are displayed.	Small, 60.0	60.0