---
sourceDocument: Brazil Sales Customer Relationship Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/order-management

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Sales Customer Relationship Management

ft:clusterId :

    - omgmt

bundleId :

    - omgmt

workflow :

    - Customer and Industry


---

# Runtime APIs

# Runtime APIs {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) 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 Runtime APIs

ServiceNow CPQ offers runtime APIs designed for customers and end users to create, update, and manage product configurations in real-time.
These APIs support standard CRUD (create, read, update, delete) operations on configurations and enable retrieval of bill of materials (BOM) data.
The APIs facilitate seamless interaction with ServiceNow CPQ configurations to support front-end application development and configuration management.
Show full answer Show less  
Developers can quickly start using these runtime APIs via open-source repositories that provide API collections for import and testing.

## Runtime API Setup

All runtime API calls use a base URL structured as `https://<tenant>.<sector>.<cpq>/api/`, where *tenant* identifies your environment and *sector* indicates the deployment stage (e.g., test or prod).

Authentication requires two mandatory HTTP headers:

* **Origin:** Matches the runtime client origin configured in ServiceNow CPQ Admin settings.
* **Authorization:** Bearer token with a valid runtime token.

## Key API Operations

### Create Configuration

Begin a new configuration by supplying the ID of a ServiceNow CPQ-enabled product with an active blueprint. The API responds with a unique configuration UUID used for subsequent operations. You can initialize configurations by optionally passing field values.

### Reconfigure Configuration

Use this to load and modify an existing configuration by providing the product ID and the current configuration UUID. The API returns a new configuration ID representing the updated session, which must be used for all further updates or saves.

### Update Configuration

Update field values within an existing configuration identified by its UUID. Supports optional query parameters:

* **delta (true/false):** Controls if only changed data (default) or the full configuration is returned.
* **save (true/false):** If true, the configuration is saved and can trigger webhooks or custom object updates in Salesforce; if false or omitted, only an update occurs without saving.

### Save Configuration

A specialized form of update that finalizes the configuration. Setting `save=true` triggers saving actions such as populating Salesforce custom objects and invoking webhooks if configured. This action ends the configuration session, requiring a new create or reconfigure call for further changes.

### BOM APIs

Retrieve final configuration outputs by requesting BOM data via the configuration UUID. Supports three built-in BOM types:

* **all:** Entire BOM (default if type not specified)
* **sales:** Sales BOM subset
* **manufacturing:** Manufacturing BOM subset

Additional BOM types can be dynamically defined on a product by setting the `bomType` field.

## Practical Benefits for ServiceNow Customers

* Efficiently automate configuration lifecycle management through API-driven processes.
* Integrate ServiceNow CPQ configurations into custom front-end applications using standard RESTful calls.
* Retrieve detailed BOM data for sales and manufacturing teams directly from configuration states.
* Leverage webhook integrations and Salesforce custom objects for automated data synchronization upon configuration save.
* Secure API access with token-based authentication and origin validation to protect configuration data.

## Next Steps

To implement these APIs, obtain your tenant URL and runtime tokens, configure runtime client origins in the ServiceNow CPQ Admin, and utilize the provided payload examples for create, reconfigure, update, save, and BOM retrieval operations. Refer to additional configuration API documentation and sample scenarios to extend functionality as needed.  
ServiceNow CPQ provides a set of APIs for building front-end applications and manipulating configurations. These are the buyside or runtime APIs that customers and end users can use to create, update, and save ServiceNow CPQ configurations.
Runtime APIs support the standard create, read, update, and delete functions for ServiceNow CPQ configurations, along with the ability to retrieve bill of materials (BOM) data from ServiceNow CPQ.

ServiceNow CPQ provides accessible runtime APIs and a quick start for developers through open source repositories containing API collections that can be imported and tested.

## Runtime API setup {#logik_io_runtime_apis__section_zsx_fvs_mhc}

The base URL format for all runtime API calls is https://\<tenant\>.\<sector\>.\<cpq\>/api/. The `<tenant>` is the listed tenant name and `<sector>`
is the appropriate sector where the environment is located (usually `test` or `prod`).

Find the ServiceNow CPQ tenant URL in Salesforce by navigating to Setup, searching for Custom Settings in the Quick Find box, and then selecting Manage next to ServiceNow CPQ Tenant.

Runtime API calls are authenticated through a combination of a bearer token and the defined origin in the runtime client. The origins of the runtime application are set when a runtime client is created in the ServiceNow CPQ
Admin settings.  
Add two headers to each request to authorize these API calls as mentioned in the following table:{#logik_io_runtime_apis__table_jtd_mls_mhc__entry__3}

| Header | Key | Value |
|-|-|-|
| Origin Header | origin | \<runtimeClientOrigin\> |
| Authorization Header | authorization | Bearer \<runtimeToken\> |
[Table 1. Mandatory headers for runtime API requests]

{#logik_io_runtime_apis__table_jtd_mls_mhc}

Sample headers:

* origin: localhost
* authorization: Bearer vEqzz4BVkb15Le11En8axEuN71FA6Vt_cw
{#logik_io_runtime_apis__ul_gl3_rws_mhc}

## Create a configuration {#logik_io_runtime_apis__section_sdh_zls_mhc}

The create configuration call passes the ID of the configurable product and receives in response a ServiceNow CPQ configuration ID that can be used to specify this configuration in later calls.

|-|-|
| HTTP method | POST |
| URL | https://\<tenant\>.\<sector\>.logik.io/api/ |
| Path parameters | N/A |
| Query parameters | N/A |
[Table 2. POST]

{#logik_io_runtime_apis__table_mtd_mls_mhc}

The two key pieces of the payload are:

* The ID of a ServiceNow CPQ enabled product, with a blueprint that is deployed
* The ServiceNow CPQ configuration UUID that is being reconfigured

{#logik_io_runtime_apis__ul_zzd_dxs_mhc}

Sample URL:

`https://dev1.test.cpq/api/`

Sample payload:

    {
      "sessionContext": 
      { 
        "stateful": true
      },
      "partnerData": 
      { 
        "product":
        {
          "configuredProductId": "<Id of a Logik.io Enabled Product>", 
        }
      },
      "fields": []
    }

Note:  
You can also initialize the configuration by passing field values to the fields array in the following format:

    {
      "variableName": "<Field Name>", "value": "<Field Value>"
    }

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>]
    }

## Reconfigure a configuration {#logik_io_runtime_apis__section_zmk_sps_mhc}

The reconfigure API call is similar to the create configuration call. The reconfigure call passes the ID of the configurable product and an existing ServiceNow CPQ configuration ID. In return, it receives a new Configuration ID with the same field data as the prior configuration but allows changes to be made.  
Note:  
The UUID field in the response payload contains the new ServiceNow CPQ configuration ID. Use the new configuration ID for all operations going forward in the reconfiguration process, including update, save, and retrieve BOM.

|-|-|
| HTTP method | POST |
| URL | https://\<tenant\>.\<sector\>.logik.io/api/ |
| Path parameters | N/A |
| Query parameters | N/A |
[Table 3. POST]

{#logik_io_runtime_apis__table_vtd_mls_mhc}

The two key pieces of the payload are:

* The ID of a ServiceNow CPQ enabled product, with a blueprint that is deployed
* The ServiceNow CPQ configuration UUID that is being reconfigured

{#logik_io_runtime_apis__ul_esm_h5s_mhc}

Sample URL:

`https://dev1.test.Logik/api/`

Sample payload:

    {
      "sessionContext": 
      { 
        "stateful": true
      },
      "partnerData": 
      { 
        "product": 
        {
          "configuredProductId": "<Id of a Logik.io Enabled Product>", 
          "configurationAttributes": 
          {
            "LGK__ConfigurationId__c": "<uuid>"
          }
        }
      },
      "fields": []
    }

Sample response:

    {
      "fields": [<ARRAY OF FIELD OBJECTS>],
      "uuid": "d98d60cd-9379-4b7b-86fd-de828c340f80", 
      "revision": 0,
      "relatedChanges": 
      [
        {
          "key": "products",
          "type": "PRODUCT"
        }
      ],
      "valid": true, 
      "messages": [], 
      "productChange": true,
      "products": [<ARRAY OF PRODUCTS IN CONFIGURATION>],
      "total": 30,
      "layouts": [<ARRAY OF LAYOUTS>]
    }

## Update a configuration {#logik_io_runtime_apis__section_q3w_tps_mhc}

Updating a configuration requires a configuration to be loaded using either the create configuration or reconfigure API calls. The update configuration call passes a ServiceNow CPQ Configuration ID and any desired field values, and in response, receives the updated configuration from ServiceNow CPQ.

|-|-|-|-|-|
| HTTP method | PATCH ||||
| URL | https://\<tenant\>.\<sector\>.cpq/api/ ||||
| Path parameters | N/A ||||
| Query Parameters | Name | Allowed Value | Required? | Default if not specified |
| Query Parameters | delta | true \| false | optional | true |
| Query Parameters | save | true \| false | optional | false |
[Table 4. PATCH]

{#logik_io_runtime_apis__table_pwh_rts_mhc}

Query parameters:

delta

If delta=true, ServiceNow CPQ sends back only data that has changed based on the update that was sent. This is the default behavior.

If delta=false, ServiceNow CPQ sends back the entire configuration and BOM data in response.  
SAVE

* If save=true, ServiceNow CPQ saves the configuration and sends the data to a webhook or writing the data into custom objects in Salesforce. This is the behavior of the save configuration call.
* If save=false, ServiceNow CPQ updates this configuration and sends the updated data back in the response. This is the default behavior, and this is the behavior of the update call.
{#logik_io_runtime_apis__ul_cdx_fkq_qkc}

Sample URL:

`https://dev1.test.logik.io/api/fbc3d32c-7f86-4461-b144-986a0e8a5768`

Sample payload:

    {
      "fields": 
      [
        {
          "variableName": "orderQty", 
          "value": 3
        }
      ]
    }

Sample response:

    {
      "fields": [],
      "uuid": "fbc3d32c-7f86-4461-b144-986a0e8a5768", 
      "revision": 0,
      "relatedChanges": 
      [
        {
          "key": "products",
          "type": "PRODUCT"
        }
      ],
      "valid": true, 
      "messages": [], 
      "productChange": true, 
      "products": null
    }

## Save a configuration {#logik_io_runtime_apis__section_od1_vps_mhc}

Saving a configuration is a subset of the update configuration. It requires a configuration to be loaded using either the create configuration or reconfigure API calls. The save configuration call passes a ServiceNow CPQ configuration ID and any desired field values, and in response, receives the updated configuration from ServiceNow CPQ.  
Note:  
The only difference between a normal update call and a save call is the addition of the query parameter save=true in the URL. If set to false or excluded, this is a normal update call.

If the save API is called in the Salesforce backend then ServiceNow CPQ asynchronously creates and populates the custom objects 'Configuration Field Data Sets' and 'Configuration Line Items' with the appropriate data.

If your ServiceNow CPQ instance has a webhook configured, when the save API is called, the data is sent to the endpoint specified in the webhook setting. See [Webhooks](https://servicenow-prod.fluidtopics.net/YTNk5Ft3qMZ81qdr7RgFMQ "Webhooks are endpoints that can receive a POST request whenever a configuration is saved.").  
Note:  
This ends the configuration session. Further edits or updates to the configuration must be started from the create configuration or reconfigure API calls.

|-|-|-|-|-|
| HTTP method | PATCH ||||
| URL | https://\<tenant\>.\<sector\>.cpq/api/ ||||
| Path parameters | N/A ||||
| Query Parameters | Name | Allowed Value | Required? | Default if not specified |
| Query Parameters | delta | true \| false | optional | true |
| Query Parameters | save | true \| false | optional | false |
[Table 5. PATCH]

{#logik_io_runtime_apis__table_mrm_2ss_mhc}

Query parameters:

delta

If delta=true, ServiceNow CPQ sends back only data that has changed based on the update that was sent. This is the default behavior.

If delta=false, ServiceNow CPQ sends back the entire configuration and BOM data in response.

save

If save=true, ServiceNow CPQ saves this configuration and (depending on the settings) performs additional actions such as sending the data to a webhook or writing the data into custom objects in Salesforce.

If save=false, ServiceNow CPQ updates this configuration and sends the updated data back in the response. This is the behavior of the update call.

Sample cURL request:

    curl --location --request PATCH 'https://mpanigrahi-demo.demo01.logik.io/api/6d0ef6fd-4c88-44f3-a296-b03421c369c6' \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json' \
    --header 'Origin: https://mpanigrahi-demo.demo01.logik.io' \
    --header 'Authorization: <<RUNTIME TOKEN>>' \
    --header 'Cookie: LGKSESSION=NDA5OWJmNmEtNDhhOS00YTc4LTk3ODktZTg0OGYyOGIwMjZk' \
    --data '{"fields":[{"variableName":"name_d1","value":"megha","dataType":"text"}],"responseState":{"setPagination":{"collections":{"pageSize":10,"pageNumber":0},"fields":{"pageSize":10,"pageNumber":0},"componentTypes":{"pageSize":10,"pageNumber":0}},"defaultPagination":{"pageSize":10,"pageNumber":0},"searchValues":{}}}'

Sample response:

    {
    "fields": [<ARRAY OF FIELD OBJECTS>],
    "uuid": "8817655d-7a11-41ef-a9fd-59c2855a3e4b", 
    "revision": 1,
    "valid": true, 
    "messages": [], 
    "productChange": false,
    "products": [<ARRAY OF PRODUCTS IN CONFIGURATION>],
    "total": 0
    }

## BOM APIs {#logik_io_runtime_apis__section_cvd_mls_mhc}

The BOM APIs are useful for retrieving the final output of configuration. You can use the BOM APIs to retrieve the entire BOM, or specific subsets, such as sales or manufacturing BOMs.

The Get BOM call passes a ServiceNow CPQ Configuration ID and in return receives the current BOM generated by the current state of the configuration. There are 3 built in BOM types: "all", "sales" and "manufacturing". You can dynamically
add additional BOM types by setting the bomType field on the product.  
Note:  
If the BOM type is not included, the API returns the entire BOM.

|-|-|-|-|
| HTTP method | GET |||
| URL | https://\<tenant\>.\<sector\>.cpq/api/\<uuid\>/bom/\<bomType\> |||
| Path Parameters | Name | Allowed Value | Required? |
| Path Parameters | \<uuid\> | 32 character ServiceNow CPQ configuration UUID | required |
| Path Parameters | \<bomType\> | name of the BOM to retrieve | optional |
| Query parameters | N/A |||
[Table 6. GET]

{#logik_io_runtime_apis__table_dvd_mls_mhc}

Sample response:

    {"products": [
            {
                "id": "01t5f000006QKysAAG",
                "quantity": 1,
                "bomType": "Sales",
                "orderNumber": 10,
                "type": "accessory",
                "name": "Amend Flow Bundle Sub",
                "partnerId": "01t5f000006QKysAAG",
                "productCode": "AFBC-SC",
                "externalId": "",
                "productFamily": "Miscellaneous",
                "description": "",
                "uom": "",
                "price": 5,
                "extPrice": 5,
                "level": 0,
                "rollUpPrice": 5
            },
            {
                "id": "01t5f000006QKz2AAG",
                "quantity": 1,
                "bomType": "Sales",
                "orderNumber": 20,
                "type": "accessory",
                "name": "Amend Flow Bundle Asset",
                "partnerId": "01t5f000006QKz2AAG",
                "productCode": "AFBC2-SC",
                "externalId": "",
                "productFamily": "Miscellaneous",
                "description": "",
                "uom": "",
                "price": 25,
                "extPrice": 25,
                "level": 0,
                "rollUpPrice": 25
            }
        ]}

For information about additional configuration APIs and sample scenarios, see [Additional configuration APIs](https://servicenow-prod.fluidtopics.net/6WwLn8SW5rG_h5Ebuso6UQ "These ServiceNow 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.").

