---
sourceDocument: Australia Sales and Order Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/order-management

 Release :

    - australia

ft:locale :

    - de-DE

ft:publication_title :

    - Australia Sales and Order Management

ft:clusterId :

    - omgmt

bundleId :

    - omgmt

workflow :

    - Customer and Industry


---

# Runtime APIs

# Runtime APIs {#ariaid-title1}

* Freigeben Version: Australia
* 
* Aktualisiert 12. März 2026
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 8 Minuten Lesedauer

Runtime APIs
CPQ provides a set of APIs for building front-end applications and manipulating configurations. These are commonly referred to as buyside or runtime APIs and are used by customers or end users to create, update
and save CPQ configurations.

Runtime APIs support the standard create, read, update, and delete functions for CPQ configurations, along with the ability to retrieve bill of materials (BOM) data from CPQ.  
Hinweis:  
These APIs are legacy APIs. For the most updated information, see the complete CPQ API reference:

[Logik.io API Reference](https://api-docs.logik.io/#introduction)

To make CPQ runtime APIs accessible and provide a quick start to end developers, see our open source repositories for API collections that can easily be imported and used to start testing:

[API-Documentation/runtime/Logik Configurator Runtime APIs.postman_collection.json](https://github.com/logikioopensource/API-Documentation/blob/main/runtime/Logik%20Configurator%20Runtime%20APIs.postman_collection.json)

## Runtime API setup {#logik_io_runtime_apis__section_zsx_fvs_mhc}

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

In Salesforce, you can find the CPQ tenant URL by going into Setup, searching for Custom Settings in the Quick Find box, and then clicking Manage next to 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 specified when a runtime client is created in the CPQ Admin settings.

To authorize these API calls, you must add two headers to the each runtime API request:
{#logik_io_runtime_apis__table_jtd_mls_mhc__entry__3}

| Header | Key | Value |
|-|-|-|
| Origin Header | origin | \<runtimeClientOrigin\> |
| Authorization Header | authorization | Bearer \<runtimeToken\> |
[Tabelle : 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}

To start a new configuration via the APIs, the create configuration call passes the ID of the configurable product. In response, it receives a 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 |
[Tabelle : 2. POST]

{#logik_io_runtime_apis__table_mtd_mls_mhc}

The two key pieces of the payload are:

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

{#logik_io_runtime_apis__ul_zzd_dxs_mhc}

Sample URL:

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

Sample payload:

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

Hinweis:  
The configuration can also be initialized 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 CPQ configuration ID, and in return receives a new Configuration ID with the same field data as the prior configuration but allowing for changes to be made.  
Hinweis:  
The UUID field in the response payload contains the new CPQ configuration ID. The new configuration ID should be used 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 |
[Tabelle : 3. POST]

{#logik_io_runtime_apis__table_vtd_mls_mhc}

The two key pieces of the payload are:

* The ID of a CPQ enabled product, with a blueprint that is deployed
* The 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 CPQ Configuration ID and any desired field values, and in response receives the updated configuration from CPQ.

|-|-|-|-|-|
| HTTP method | PATCH ||||
| URL | https://\<tenant\>.\<sector\>.logik.io/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 |
[Tabelle : 4. PATCH]

{#logik_io_runtime_apis__table_pwh_rts_mhc}

Query parameters:

delta

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

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

save

If save=true, 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. This is the behavior of the
save configuration call.

If save=false, 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.

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 CPQ configuration ID and any desired field values, and in response receives the updated configuration from CPQ.  
Hinweis:  
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 you are using Salesforce as a backend, when the save API is called, CPQ asynchronously creates and populates the CPQ custom objects Configuration Field Data Sets and Configuration Line Items with the appropriate data.

If your 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/aFnl8FBAIiAQs_q9zl_YIw "Webhooks are endpoints that can receive a POST request whenever a configuration is saved.").  
Hinweis:  
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\>.logik.io/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 |
[Tabelle : 5. PATCH]

{#logik_io_runtime_apis__table_mrm_2ss_mhc}

Query parameters:

delta

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

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

save

If save=true, 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, 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. The BOM APIs can be used to retrieve the entire BOM, or specific subsets, such as sales or manufacturing BOMs.

The Get BOM call passes a 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". Additional BOM types can be
dynamically added by setting the bomType field on the product.  
Hinweis:  
If the BOM type is not included, the API returns the entire BOM.

|-|-|-|-|
| HTTP method | GET |||
| URL | https://\<tenant\>.\<sector\>.logik.io/api/\<uuid\>/bom/\<bomType\> |||
| Path Parameters | Name | Allowed Value | Required? |
| Path Parameters | \<uuid\> | 32 character CPQ configuration UUID | required |
| Path Parameters | \<bomType\> | name of the BOM to retrieve | optional |
| Query parameters | N/A |||
[Tabelle : 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/BFoCVncZF3iNymUQr65ZWg "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.").