Configuration Load Instance (POST)

Create a session for the product configuration instance using the transaction ID. Get the session ID that includes the results of actions, such as configuration rules, qualification rules, and pricing management.

Resource 

1/connect/cpq/configurator/actions/load-instance

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/cpq/configurator/actions/load-instance

Available Version 

60.0

HTTP Methods 

POST

Request Body for POST 

JSON Example

1{
2    "configuratorOptions": 
3      {
4        "addDefaultConfiguration": true,
5        "executeConfigurationRules": true,
6        "executePricing": true,
7        "qualifyAllProductsInTransaction": true,
8        "validateAmendRenewCancel": true,
9        "validateProductCatalog": true
10    },
11    "qualificationContext": {
12        "accountId": "001DU000001nHUGYA2"
13    },
14    "transactionId": "0Q0DU0000000XoN0AU"
15}

Properties

NameTypeDescriptionRequired or OptionalAvailable Version
configurator​OptionsConfigurator Options InputList of the configurator options to execute.Optional60.0
context​Mapping​IdStringID of the context mapping record.Optional60.0
qualification​ContextUser Context InputContext details that are used for the qualification rules.Optional60.0
transaction​IdStringTransaction ID of the header entity that’s used to create a session. For example, a Quote or an Order.Required60.0

Response Body for POST 

Configuration Load Instance