---
sourceDocument: Brazil Sales Customer Relationship Management
sourceDocumentLink: https://www.servicenow.com/docs/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

# ServiceNow Quote Experience runtime API calls {#ariaid-title1}

Release version: Brazil  
Updated May 7, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read  
Reference for the runtime APIs used in the ServiceNow Quote Experience, including their purposes, responses, and a OpenAPI Specification for testing in ServiceNow CPQ.

## API overview {#quote-tm-runtime-api-calls__api-overview}

ServiceNow CPQ APIs are divided into two categories: runtime APIs and admin APIs. Runtime APIs are the same APIs used in the runtime quote experience. The following table lists the runtime APIs for ServiceNow Quote Experience.
{#quote-tm-runtime-api-calls__api-overview__entry__3}

| API action | Purpose | Response |
|-|-|-|
| Initialize a session | Initializes a session to establish a context for executing transaction events, managing state, and processing subsequent API calls. Can initialize for an existing transaction. If no transaction is specified, a new transaction is created. | Returns a session ID, a transaction ID, and transaction information. |
| Delete a session | Deletes a session to securely end user activity, clear session-specific data, and free up system resources. | Session is deleted. No information is returned. |
| Create a transaction | Creates a transaction, providing the object to manage the transaction lifecycle, configure and add products, and determine pricing. | Returns a transaction ID and transaction information. |
| Run events on a transaction | Triggers a specified system or custom event on a transaction to execute predefined logic or workflows, such as editing field values, initiating approvals, versioning transactions, and validating configurations. | Varies by event. |
| Add products to a transaction (upsert) | Adds one or more products to a transaction, enabling dynamic configuration and pricing updates based on the product's attributes. | Returns updated transaction data with the additional products. |
| Get a list of transactions | Retrieves a list of transactions, enabling users to view, manage, or take action on existing transactions. | A list of transactions with transaction IDs and metadata. |
| Get details of a transaction | Retrieves the header information of a transaction, including stage, account, and summary-level data. | All header field data for the transaction. |
| Get a transaction's lines | Retrieves the line item details for a transaction, including product data, quantities, pricing, and custom attributes for each line. | All line-level field data for the transaction. |
[Table 1. ServiceNow Quote Experience runtime APIs]

Note:  
Event APIs are authorized via session cookie only. Avoid building a scenario in which the user initiates an event that also fires an event API on the same transaction --- such an implementation can result in unpredictable behavior.

## Additional APIs {#quote-tm-runtime-api-calls__additional-apis}

For details about the API that retrieves metrics for transactions, see [Quote Experience metrics API](https://www.servicenow.com/docs/IV22zWxa7QJh7JhMIMZkdg "Reference for the Quote Experience metrics API, including query parameters, default behavior, and metric definitions for views, session time, and stage time in ServiceNow CPQ.").

## OpenAPI Specification {#quote-tm-runtime-api-calls__postman-collection}

The following OpenAPI specification describes all available REST endpoints, request payloads, response formats, parameters, and data models for the ServiceNow Quote Experience runtime APIs. For more information, see [KB3229681](https://support.servicenow.com/kb?sys_kb_id=ac68a3a947901b582c31b98a436d435a&id=kb_article_view).