Product Configurator Business APIs

Use the Product Configurator Business APIs to customize a product or a service according to your business-specific requirements.

Perform product configuration-related operations by using the Product Configurator Business APIs. Integrate these APIs with any front-end application to access the configurator capabilities.

These APIs are stateless and don’t recall prior user actions between calls unless state is explicitly persisted and reloaded.

For example, if a user deselects a child product and later reselects it, the engine treats the request as adding a new item that doesn’t currently exist in the model. It can’t infer that this request is a re-selection of a previously removed item. As a result, the original line item isn’t restored and a new line item is created.

This table lists the available Product Configurator resources.

Resource	Description
`/connect/cpq/configurator/actions/configure` (POST)	Retrieve and update a product’s configuration from a configurator. Execute configuration rules and notify users of any violations for changes to product bundle, attributes, or product quantity within a bundle. Additionally, get pricing details for the configured bundle.
`/connect/cpq/configurator/actions/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.
`/connect/cpq/configurator/actions/set-instance` (POST)	Set a product configuration instance. This API is used in scenarios where the configuration instance is available in a different database than Salesforce and the product catalog management data is in Salesforce.
`/connect/cpq/configurator/actions/get-instance` (POST)	Fetch the JSON representation of a product configuration. Use the response to display the details of the product configuration instance on the Salesforce user interface, or save the product configuration instance to an external system.
`/connect/cpq/configurator/actions/save-instance` (POST)	Save a configuration instance after a successful product configuration.
`/connect/cpq/configurator/actions/set-product-quantity` (POST)	Set the quantity of a product through the runtime system.
`/connect/cpq/configurator/actions/add-nodes` (POST)	Add a node to the context through the runtime system without using the Salesforce user interface.
`/connect/cpq/configurator/actions/update-nodes` (POST)	Update nodes in a product configuration.
`/connect/cpq/configurator/actions/delete-nodes` (POST)	Delete nodes from a product configuration.
`/revenue/product-configurator/rules/actions/execute` (POST)	Run rules for a specific quote or order based on a context ID or transaction ID.

Resources

Learn more about the available Product Configurator API resources.
Request Bodies

Learn more about the available Product Configurator API request bodies.
Response Bodies

Learn more about the available Product Configurator API response bodies.

See Also