Additional configuration APIs

  • Release version: Australia
  • Updated March 12, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Additional configuration APIs

    These Additional Configuration APIs for ServiceNow CPQ enable you to retrieve or delete existing product configurations, complementing the runtime APIs. They are designed to help you view full configuration details and remove configurations that are no longer needed. These APIs work alongside the standard create, update, reconfigure, and BOM APIs to support comprehensive configuration workflows.

    Show full answer Show less

    Key Features

    • Get Configuration API: Retrieve the entire CPQ configuration by sending a GET request with the configuration UUID. This returns detailed configuration data including fields, products, layouts, and related changes. Note that this API does not load configurations into the CPQ rules engine for modification; use the Reconfigure API for updates.
    • Delete Configuration API: Delete a configuration from the CPQ servers using the configuration UUID via a DELETE request. This permanently removes the configuration from CPQ but does not affect any persisted data in external systems like Salesforce or Ecommerce platforms.

    Practical Use Cases

    • Creating a new configuration for a customer browsing a website, updating it during the session, and saving the final version back to CPQ.
    • Reconfiguring an existing product configuration for returning customers who want to place similar orders, using the Reconfigure API followed by saving the updated configuration.
    • Retrieving the manufacturing bill of materials (BOM) for complex products to assist engineering teams in planning parts and sub-assemblies.

    What ServiceNow Customers Can Expect

    By using these Additional Configuration APIs, you gain greater flexibility in managing CPQ configurations throughout their lifecycle. You can efficiently retrieve full configuration details for review or integration purposes and delete obsolete configurations from CPQ servers to maintain system hygiene. These APIs are essential for supporting end-to-end configuration workflows, improving operational efficiency, and ensuring accurate configuration management within your ServiceNow environment.

    These CPQ configuration APIs let you retrieve or delete an existing configuration. They complement the runtime APIs and are useful for viewing full configuration details and for removing configurations no longer needed. Use them alongside the standard create, update, reconfigure, and BOM APIs to support end-to-end configuration workflows.

    This article is a followup to Runtime APIs. For more information on authentication and setup,see that article.

    These API endpoints to get a configuration and delete a configuration from CPQ are included for completeness.

    Get configuration

    CPQ configurations can be retrieved from the CPQ servers by sending a GET request, which will return the entire configuration in the response. If you only need the product data of the outputs, consider using one of the GET BOM API calls.

    Note:
    This does not load a configuration into the CPQ rules engine for updates to fields and re-running of rules. If you need to make updates to an existing configuration, use the Reconfigure API call.
    Table 1. The GET request
    HTTP method GET
    URL https://<tenant>.<sector>.cpq/api/<uuid>
    Path parameters <uuid> 32 character CPQ configuration UUID required
    Query parameters N/A

    Sample URL:

    https://dev1.test.cpq/api/71e62fe7-e59b-4a91-94af-64718e0d4eae

    Sample response:

    {
"fields": [<ARRAY OF FIELD OBJECTS>],
"uuid": "08176434-9b1e-4fc8-b2c4-8aba2c35fda3", "revision": 0,
"relatedChanges": [
{
"key": "products",
"type": "PRODUCT"
}
],
"valid": true, "messages": [], "productChange": true,
"products": [<ARRAY OF PRODUCTS IN CONFIGURATION>],
"total": 30,
"layouts": [<ARRAY OF LAYOUTS>]
}

    Delete configuration

    CPQ configurations can be deleted, but it is not typically necessary. This API deletes the configuration from CPQ and will not be available for future retrieval of the configuration, BOM, or updates to the configuration.

    Note:
    This API will only delete the configuration from the CPQ servers. If the configuration has been persisted in another application (i.e. Quotelines have been created in Salesforce, Orders have been placed in Ecommerce), no changes will be made to that data.
    Table 2. The DELETE request
    HTTP method DELETE
    URL https://<tenant>.<sector>.cpq/api/<uuid>
    Path parameters <uuid> 32 character CPQ configuration UUID required
    Query parameters N/A

    Sample URL:

    https://dev1.test.cpq/api/71e62fe7-e59b-4a91-94af-64718e0d4eae

    Sample response:

    {}

    Sample use cases

    A new customer comes to a website, configures a product, and checks out.

    1. Start a new configuration → Create New Configuration API call
    2. Make updates to the configuration → Update Configuration API call
    3. Save the final configuration back to CPQ → Save Configuration API call

    A customer returns and wants to place an order for a product similar to one that they have purchased before.

    1. Perform a reconfiguration, using an existing CPQ Configuration Id → Reconfigure API Call
    2. Save back to CPQ → Save Configuration API call

    An order for a complex manufactured product is placed, and the engineering team needs to know what parts they need and which sub-assemblies to build.

    Retrieve the “Manufacturing” bill of materials for an existing configuration → Get BOM API call.