Saved Configuration (GET, POST)

Save and reuse a record’s configurations, and get a list of the saved configurations for a record.

Resource 

1/connect/cpq/configurator/saved-configuration

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/cpq/configurator/saved-configuration

Available Version 

63.0

HTTP Methods 

GET, POST

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
referenceRecordIdStringID of the record whose saved configurations must be retrieved.Required63.0

Response Body for GET 

Configuration List

Request Body for POST 

JSON Example

1{
2  "data": "{\"LegalEntity\":null,\"ProductName\":\"Monitor\",\"businessObjectType\":\"QuoteLineItem\",\"Product\":\"01txx0000006i2aAAA\",\"ItemIsPrimarySegment\":false,\"ListPrice\":144.99,\"ValidationResult\":null,\"StartDate\":null,\"ContractVolumePasId\":null,\"BillingTreatment\":null,\"PeriodBoundaryStartMonth\":null,\"SalesTransactionSourceAsset\":null,\"id\":\"0QLxx0000004C9VGAU\",\"PartnerDiscountPercent\":10,\"PriceWaterFall\":null,\"BillingFrequency\":null,\"ProductCode\":\"MO001\",\"DerivedPricingAttribute\":false,\"TaxTreatment\":null,\"Subtotal\":1739.88,\"ItemRampIdentifier\":null,\"ItemSegmentName\":null,\"SalesTransactionItemAttribute\":[{\"AttributeKey\":\"0tjxx0000000001AAA\",\"AttributeValue\":\"1080p Built-in Display\",\"ParentReference\":\"0QLxx0000004C9VGAU\",\"AttributePicklistValue\":\"0v6xx0000000001AAA\",\"IsPriceImpacting\":false,\"businessObjectType\":\"QuoteLineItemAttribute\",\"AttributeName\":\"Display\",\"id\":\"0zuxx000000000FAAQ\",\"AttributeDefinitionCode\":null,\"SalesTransactionItemAttrParent\":\"0QLxx0000004C9VGAU\"},{\"AttributeKey\":\"0tjxx0000000009AAA\",\"AttributeValue\":\"24 Inch\",\"ParentReference\":\"0QLxx0000004C9VGAU\",\"AttributePicklistValue\":\"0v6xx000000000GAAQ\",\"IsPriceImpacting\":false,\"businessObjectType\":\"QuoteLineItemAttribute\",\"AttributeName\":\"Display_Size\",\"id\":\"0zuxx000000000GAAQ\",\"AttributeDefinitionCode\":null,\"SalesTransactionItemAttrParent\":\"0QLxx0000004C9VGAU\"}],\"PricebookEntry\":\"01uxx0000008yX0AAI\",\"DiscountAmount\":null,\"PricingTermCount\":0,\"SubscriptionTermUnit\":null,\"NetUnitPrice\":144.99,\"ItemEffectiveGrantDate\":null,\"ProductCategory\":null,\"SalesTransactionAction\":null,\"SalesTransactionActionType\":null,\"SalesTransactionItemGroup\":null,\"PeriodBoundaryDay\":null,\"SalesTrxnItemDescription\":null,\"LineItemDistributionType\":null,\"ProrationPolicy\":null,\"ContractDiscountType\":null,\"TransactionType\":null,\"ParentReference\":\"0Q0xx0000004C92CAE\",\"Discount\":null,\"PricingTermUnit\":null,\"ProductSellingModel\":\"0jPxx0000000001EAA\",\"PricingSource\":null,\"StockKeepingUnit\":null,\"PartnerUnitPrice\":130.491,\"ItemTotalAdjustmentAmount\":0,\"SalesTransactionItemSource\":\"0QLxx0000004C9VGAU\",\"ContractAttributePasId\":null,\"SubscriptionTerm\":null,\"SellingModelType\":\"OneTime\",\"EndQuantity\":12,\"NetTotalPrice\":1739.88,\"TotalLineAmount\":1739.88,\"ItemSegmentType\":null,\"ProductBasedOn\":\"11Bxx000002C1nqEAC\",\"Deleted\":false,\"BillingReference\":null,\"ArePartialPeriodsAllowed\":false,\"ItemRecordedPrice\":null,\"CustomProductName\":null,\"ItemSegmentIdentifier\":null,\"SalesTransactionItemParent\":\"0Q0xx0000004C92CAE\",\"Quantity\":12,\"PeriodBoundary\":null,\"ContractDiscountValue\":null,\"LineItemDiscountValue\":null,\"ContractId\":null,\"EndDate\":null,\"ItemGroupSummarySubtotal\":null,\"IsContracted\":false,\"UnitPrice\":144.99,\"StartQuantity\":null,\"ContractPrice\":null,\"TotalPrice\":1739.88,\"LineItemDiscountType\":null,\"ItemPath\":\"01txx0000006i2aAAA\",\"productKey\":[\"0QLxx0000004C9VGAU\"]}\",
3  \"description\": \"This configuration is saved for reuse.\",
4  \"name\": \"Favorite Configuration\",
5  \"referenceRecordId\": \"01txx0000006iCFAAY\"
6}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
dataStringJSON object that contains the details of the sales transaction, formatted as a string.Optional63.0
descriptionStringDescription of the saved configuration.Optional63.0
nameStringName of the saved configuration.Optional63.0
referenceRecord​IdStringID of the record for which the configuration must be saved.Required63.0

Response Body for POST 

Configuration Record Save

See Also