Revenue Cloud Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Configuration Details
Output representation of the product configuration details.
- JSON example
-
{ "catalogProducts": { "additionalFields": [], "attributeCategories": [ { "attributes": [ { "attributeCategoryId": "0v3xx0000000001AAA", "attributeNameOverride": "Load Capacity", "code": "CAP", "dataType": "NUMBER", "defaultValue": "1500", "description": "Server racks are designed to support a specific load capacity, commonly measured in kilograms (kg) or pounds (lbs). Typical load capacities range from 500 kg (1102 lbs) to 1500 kg (3307 lbs) depending on the model.", "id": "0tjxx00000001DpAAI", "isCloneable": false, "isConfigurable": true, "isHidden": false, "isPriceImpacting": false, "isReadOnly": false, "isRequired": false, "label": "Load Capacity", "name": "Load Capacity" }, { "attributeCategoryId": "0v3xx0000000001AAA", "attributeNameOverride": "Expansion Slots", "code": "SLOTCAP", "dataType": "NUMBER", "defaultValue": "12", "id": "0tjxx00000001H3AAI", "isCloneable": false, "isConfigurable": true, "isHidden": false, "isPriceImpacting": false, "isReadOnly": false, "isRequired": true, "label": "Expansion Slots", "name": "Expansion Slots" }, { "attributeCategoryId": "0v3xx0000000001AAA", "attributeNameOverride": "Memory", "attributePicklist": { "id": "0v5xx0000000001AAA", "values": [ { "code": "MEM", "displayValue": "25", "id": "0v6xx0000000001AAA", "isBooleanValue": false, "name": "25Mem", "sequence": 0, "textValue": "25" }, { "code": "50MEM", "displayValue": "50", "id": "0v6xx000000001eAAA", "isBooleanValue": false, "name": "50Mem", "sequence": 1, "textValue": "50" }, { "code": "100MEM", "displayValue": "100", "id": "0v6xx000000003FAAQ", "isBooleanValue": false, "name": "100Mem", "sequence": 2, "textValue": "100" } ] }, "dataType": "MULTIPICKLIST", "defaultValue": "25", "id": "0tjxx00000001IfAAI", "isCloneable": false, "isConfigurable": true, "isHidden": false, "isPriceImpacting": false, "isReadOnly": false, "isRequired": true, "label": "Memory", "name": "Memory" } ], "code": "SPEC", "name": "Server Rack Specifications" } ], "description": "Introducing the Cisco Server Rack, a sleek and robust solution designed to streamline your data center infrastructure. With its scalable design and advanced cable management features, it ensures optimal performance, efficiency, and easy maintenance for your critical network equipment.", "displayUrl": "https://www.cisco.com/content/dam/en/us/products/servers-unified-computing/ucs-c240-m4-rack-server/product-large.jpg", "id": "01txx0000006jkuAAA", "isActive": true, "isAssetizable": true, "isConfigurable": true, "isSoldOnlyWithOtherProds": false, "name": "Cisco Server Rack NX44", "nodeType": "bundleProduct", "prices": [], "productClassification": { "id": "11Bxx000002CC02EAG" }, "productCode": "RACK", "productComponentGroups": [ { "classifications": [], "code": "SERVICE", "components": [ { "additionalFields": [], "attributeCategories": [], "description": "Introducing the Cisco Rack Server NX44 Service, a comprehensive protection plan designed to safeguard your valuable data infrastructure. With extended coverage and rapid response times, this warranty ensures peace of mind and uninterrupted performance for your critical business operations.", "id": "01txx0000006jmWAAQ", "isActive": true, "isAssetizable": true, "isComponentRequired": false, "isConfigurable": false, "isDefaultComponent": false, "isQuantityEditable": false, "isSoldOnlyWithOtherProds": false, "name": "Cisco Rack Server Service - 1 Year", "nodeType": "simpleProduct", "prices": [], "productClassification": {}, "productCode": "SERVICE", "productComponentGroups": [], "productRelatedComponent": { "childProductId": "01txx0000006jmWAAQ", "childSellingModelId": "0jPxx000000004rEAA", "doesBundlePriceIncludeChild": true, "id": "0dSxx000000001dEAA", "isComponentRequired": false, "isDefaultComponent": false, "isQuantityEditable": false, "parentProductId": "01txx0000006jkuAAA", "parentSellingModelId": "0jPxx000000004rEAA", "productComponentGroupId": "0y7xx000000001dAAA", "productRelationshipTypeId": "0yoxx00000001IfAAI", "quantity": 1, "quantityScaleMethod": "Proportional" }, "productSellingModelOptions": [ { "id": "0iOxx000000009hEAA", "productId": "01txx0000006jmWAAQ", "productSellingModel": { "id": "0jPxx000000004rEAA", "name": "Termed Annually", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "TermDefined", "status": "Active" }, "productSellingModelId": "0jPxx000000004rEAA" }, { "id": "0iOxx00000000PpEAI", "productId": "01txx0000006jmWAAQ", "productSellingModel": { "id": "0jPxx0000000085EAA", "name": "Evergreen Annually", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "Evergreen", "status": "Active" }, "productSellingModelId": "0jPxx0000000085EAA" } ] } ], "description": "The services available for the Cisco Server Rack NX44 product provide comprehensive coverage and support for optimal performance and reliability, ensuring peace of mind for your data center infrastructure.", "id": "0y7xx000000001dAAA", "maxBundleComponents": 1, "minBundleComponents": 0, "name": "Services", "parentProductId": "01txx0000006jkuAAA", "sequence": 1 }, { "classifications": [], "code": "WARRANTY", "components": [ { "additionalFields": [], "attributeCategories": [], "description": "Introducing the Cisco Rack Server NX44 Warranty, a comprehensive protection plan designed to safeguard your valuable data infrastructure. With extended coverage and rapid response times, this warranty ensures peace of mind and uninterrupted performance for your critical business operations.", "id": "01txx0000006jjIAAQ", "isActive": true, "isAssetizable": true, "isComponentRequired": false, "isConfigurable": false, "isDefaultComponent": true, "isQuantityEditable": true, "isSoldOnlyWithOtherProds": false, "name": "Cisco Rack Server Warranty - 1 Year", "nodeType": "simpleProduct", "prices": [], "productClassification": {}, "productCode": "WARRANTY", "productComponentGroups": [], "productRelatedComponent": { "childProductId": "01txx0000006jjIAAQ", "childSellingModelId": "0jPxx000000001dEAA", "doesBundlePriceIncludeChild": false, "id": "0dSxx0000000001EAA", "isComponentRequired": false, "isDefaultComponent": true, "isQuantityEditable": true, "maxQuantity": 1, "parentProductId": "01txx0000006jkuAAA", "parentSellingModelId": "0jPxx000000001dEAA", "productComponentGroupId": "0y7xx0000000001AAA", "productRelationshipTypeId": "0yoxx00000001IfAAI", "quantity": 1, "quantityScaleMethod": "Proportional", "sequence": 0 }, "productSellingModelOptions": [ { "id": "0iOxx000000001dEAA", "productId": "01txx0000006jjIAAQ", "productSellingModel": { "id": "0jPxx000000001dEAA", "name": "One Time", "sellingModelType": "OneTime", "status": "Active" }, "productSellingModelId": "0jPxx000000001dEAA" }, { "id": "0iOxx00000000HlEAI", "productId": "01txx0000006jjIAAQ", "productSellingModel": { "id": "0jPxx000000003FEAQ", "name": "Termed Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined", "status": "Active" }, "productSellingModelId": "0jPxx000000003FEAQ" }, { "id": "0iOxx00000000JNEAY", "productId": "01txx0000006jjIAAQ", "productSellingModel": { "id": "0jPxx000000004rEAA", "name": "Termed Annually", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "TermDefined", "status": "Active" }, "productSellingModelId": "0jPxx000000004rEAA" }, { "id": "0iOxx00000000KzEAI", "productId": "01txx0000006jjIAAQ", "productSellingModel": { "id": "0jPxx0000000085EAA", "name": "Evergreen Annually", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "Evergreen", "status": "Active" }, "productSellingModelId": "0jPxx0000000085EAA" }, { "id": "0iOxx00000000MbEAI", "productId": "01txx0000006jjIAAQ", "productSellingModel": { "id": "0jPxx000000006TEAQ", "name": "Evergreen Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "Evergreen", "status": "Active" }, "productSellingModelId": "0jPxx000000006TEAQ" } ] } ], "description": "The warranties available for the Cisco Server Rack NX44 product provide comprehensive coverage and support for optimal performance and reliability, ensuring peace of mind for your data center infrastructure.", "id": "0y7xx0000000001AAA", "maxBundleComponents": 1, "minBundleComponents": 0, "name": "Warranties", "parentProductId": "01txx0000006jkuAAA", "sequence": 0 } ], "productSellingModelOptions": [ { "id": "0iOxx000000003FEAQ", "productId": "01txx0000006jkuAAA", "productSellingModel": { "id": "0jPxx000000001dEAA", "name": "One Time", "sellingModelType": "OneTime", "status": "Active" }, "productSellingModelId": "0jPxx000000001dEAA" }, { "id": "0iOxx000000004rEAA", "productId": "01txx0000006jkuAAA", "productSellingModel": { "id": "0jPxx000000003FEAQ", "name": "Termed Monthly", "pricingTerm": 1, "pricingTermUnit": "Months", "sellingModelType": "TermDefined", "status": "Active" }, "productSellingModelId": "0jPxx000000003FEAQ" }, { "id": "0iOxx000000006TEAQ", "productId": "01txx0000006jkuAAA", "productSellingModel": { "id": "0jPxx000000004rEAA", "name": "Termed Annually", "pricingTerm": 1, "pricingTermUnit": "Annual", "sellingModelType": "TermDefined", "status": "Active" }, "productSellingModelId": "0jPxx000000004rEAA" } ], "productType": "Bundle" }, "uiTreatments": [ { "details": { "attributeId": "0tjxx0000000007AAA", "prcId": "0dSxx0000000007EAA", "stiId": "0QLxx0000004CU0GAM", "attributePicklistValueId": "0v6xx0000000005AAA" }, "uiTreatmentScope": "Bundle", "uiTreatmentTarget": "Attribute_Picklist_Value", "uiTreatmentType": "Hide" }, { "details": { "stiId": "ref_f0f2da7b_c431_482d_bf4b_599052f3a2e1" }, "uiTreatmentScope": "Product", "uiTreatmentTarget": "Component", "uiTreatmentType": "Disable" } ], "errors": [], "success": true, "transactionContext": { "SalesTransaction": [ { "Status": "Draft", "Account": "001xx000003GeIxAAK", "BillingCity": "San Francisco", "Subtotal": 152500, "LastPricedDate": "2023-08-22T05:55:39Z", "businessObjectType": "Quote", "TotalAmount": 152500, "ShippingStreet": "415 Mission St", "SalesTransactionItem": [ { "ProrationPolicy": null, "Discount": null, "ProductSellingModel": "0jPxx000000001dEAA", "Product": "01txx0000006jkuAAA", "businessObjectType": "QuoteLineItem", "BasisTransactionItem": null, "PartnerUnitPrice": null, "StartingUnitPriceSource": "System", "ListPrice": 150000, "ItemTotalAdjustmentAmount": 0, "SalesTransactionItemSource": "0QLxx0000004CQmGAM", "SubscriptionTerm": null, "StartDate": null, "NetTotalPrice": 150000, "TotalLineAmount": 150000, "PeriodBoundaryStartMonth": null, "ListPriceTotal": 150000, "PartnerDiscountPercent": null, "id": "0QLxx0000004CQmGAM", "PriceWaterFall": { "currencyCode": "USD", "executionEndTimestamp": "2023-09-18T20:11:15.016Z", "executionId": "ruepwmHn2ZFvnQo5bjot", "executionStartTimestamp": "2023-09-18T20:11:14.906Z", "lineItemId": "0QLxx0000004CQmGAM", "output": { "NetUnitPrice": 150000, "Subtotal": 0 }, "success": true, "waterfall": [ { "fieldToTagNameMapping": { "NetUnitPrice": "ItemUnitPrice", "AdjustmentValue": "ItemAdjustmentValue", "Subtotal": "ItemTotalAdjustmentAmount", "Quantity": "ItemQuantity", "LineItemId": "SalesTransactionItemSource", "InputUnitPrice": "ItemUnitPrice" }, "inputParameters": { "Quantity": 1, "LineItemId": "0QLxx0000004CQmGAM", "InputUnitPrice": 150000, "AdjustmentType": "Amount" }, "outputParameters": { "NetUnitPrice": 150000, "Subtotal": 0 }, "pricingElement": { "adjustments": [ { "AdjustmentType": "Amount" } ], "elementType": "MANUALDISCOUNT", "name": "ManualDiscount" }, "sequence": 1 } ] }, "BillingFrequency": null, "SalesTransactionItemParent": "0Q0xx0000004CAeCAM", "StartingPriceTotal": 150000, "Quantity": 1, "PeriodBoundary": null, "SalesTransactionItemAttribute": [ { "AttributeKey": "0tjxx00000001H3AAI", "AttributeValue": "30.0", "AttributePicklistValue": null, "IsPriceImpacting": true, "businessObjectType": "QuoteLineItemAttribute", "AttributeName": "Expansion Slots", "AttributeDefinitionCode": "SLOTCAP", "id": "0zuxx0000000001AAA", "SalesTransactionItemAttrParent": "0QLxx0000004CQmGAM" } ], "EndDate": null, "DiscountAmount": null, "PricebookEntry": "01uxx0000009154AAA", "PricingTermCount": 1, "NetUnitPrice": 150000, "UnitPrice": 150000, "StartingUnitPrice": 150000, "SalesTrxnItemRelationship": [ { "ProductRelationshipType": "0yoxx00000001IfAAI", "MainItemRole": "Bundle", "AssociatedItem": "0QLxx0000004CQnGAM", "ProductRelatedComponent": "0dSxx0000000001EAA", "MainItem": "0QLxx0000004CQmGAM", "AssociatedQuantScaleMethod": "Proportional", "businessObjectType": "QuoteLineRelationship", "AssociatedItemRole": "BundleComponent", "SalesTrnItemRelationshipParent": "0Q0xx0000004CAeCAM", "id": "0yQxx000000001dEAA", "AssociatedItemPricing": "NotIncludedInBundlePrice" } ], "TotalPrice": 150000, "PeriodBoundaryDay": null }, { "ProrationPolicy": null, "Discount": null, "ProductSellingModel": "0jPxx000000001dEAA", "Product": "01txx0000006jjIAAQ", "businessObjectType": "QuoteLineItem", "BasisTransactionItem": null, "PartnerUnitPrice": null, "StartingUnitPriceSource": "System", "ListPrice": 2000, "ItemTotalAdjustmentAmount": 0, "SalesTransactionItemSource": "0QLxx0000004CQnGAM", "SubscriptionTerm": null, "StartDate": null, "NetTotalPrice": 2000, "TotalLineAmount": 2000, "PeriodBoundaryStartMonth": null, "ListPriceTotal": 2000, "PartnerDiscountPercent": null, "id": "0QLxx0000004CQnGAM", "PriceWaterFall": { "currencyCode": "USD", "executionEndTimestamp": "023-09-18T20:11:15.016Z", "executionId": "ruepwmHn2ZFvnQo5bjot", "executionStartTimestamp": "2023-09-18T20:11:14.906Z", "lineItemId": "0QLxx0000004CQnGAM", "output": { "NetUnitPrice": 2000, "Subtotal": 0 }, "success": true, "waterfall": [ { "fieldToTagNameMapping": { "NetUnitPrice": "ItemUnitPrice", "AdjustmentValue": "ItemAdjustmentValue", "Subtotal": "ItemTotalAdjustmentAmount", "Quantity": "ItemQuantity", "LineItemId": "SalesTransactionItemSource", "InputUnitPrice": "ItemUnitPrice" }, "inputParameters": { "Quantity": 1, "LineItemId": "0QLxx0000004CQnGAM", "InputUnitPrice": 2000, "AdjustmentType": "Amount" }, "outputParameters": { "NetUnitPrice": 2000, "Subtotal": 0 }, "pricingElement": { "adjustments": [ {} ], "elementType": "MANUALDISCOUNT", "name": "ManualDiscount" }, "sequence": 1 } ] }, "BillingFrequency": null, "SalesTransactionItemParent": "0Q0xx0000004CAeCAM", "StartingPriceTotal": 2000, "Quantity": 1, "PeriodBoundary": null, "EndDate": null, "DiscountAmount": null, "PricebookEntry": "01uxx000000913SAAQ", "PricingTermCount": 1, "NetUnitPrice": 2000, "UnitPrice": 2000, "StartingUnitPrice": 2000, "TotalPrice": 2000, "PeriodBoundaryDay": null } ], "BillingCountry": "US", "BillingStreet": "415 Mission St", "Pricebook": "01sxx0000005uDZAAY", "ShippingPostalCode": "94105", "SalesTransactionSource": "0Q0xx0000004CAeCAM", "ShippingCountry": "US", "ShippingCity": "San Francisco", "ShippingState": "CA", "BillingPostalCode": "94105", "id": "0Q0xx0000004CAeCAM", "BillToContact": null, "Contract": null, "BillingState": "CA" } ] }, "transactionContextId": "cda87acd-45ed-4913-903e-9dd33cec85a6", "transactionContextMappingId": "11jxx0000004LwOAAU" }
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| catalogProducts | Configurator Product Catalog[] | Structure that contains the product catalog data. | Small, 61.0 | 61.0 |
| errors | ConnectApi.ErrorResponse | List of errors that contains a message and an error code. | Small, 60.0 | 60.0 |
| messages | Map<String, Configurator Message>> | Messages from the validation, Business Rules Engine (BRE), or Salesforce Pricing calls. | Small, 60.0 | 60.0 |
| success | Boolean | Indicates whether the request is successful (true) or not (false). | Small, 60.0 | 60.0 |
| transactionContext | Map<String, Object> | Serialized JSON representation of the transaction context. | Small, 60.0 | 60.0 |
| transactionContextId | String | ID of the transaction context. | Small, 60.0 | 60.0 |
| transactionContextMappingId | String | ID of the context mapping. | Small, 60.0 | 60.0 |
| transactionQualification | Map<String, Configurator Qualification Context> | Map of the product IDs to the qualification context. | Small, 60.0 | 60.0 |
| uiTreatments | Configurator UI Treatment[] | Details of the UI treatments that specify the product configuration rule actions to override the disable or hide behavior in the UI for product options, product attributes, and attribute picklist values. | Small, 62.0 | 62.0 |