---
sourceDocument: Australia Sales Customer Relationship Management
sourceDocumentLink: https://www.servicenow.com/docs/r/australia/order-management

 Release :

    - australia

ft:locale :

    - en-US

ft:publication_title :

    - Australia 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: Australia  
Updated May 7, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 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 ServiceNow Quote Experience runtime API calls

ServiceNow Quote Experience runtime APIs enable interaction with the ServiceNow CPQ (Configure, Price, Quote) runtime environment.
These APIs facilitate managing quote transactions dynamically during the quote lifecycle, including session management, transaction creation, product configuration, pricing, and event execution.
They are distinct from admin APIs and are designed for operational, runtime use within the quote experience.
Show full answer Show less  

## Key Features

* **Session Management:** Initialize and delete sessions to establish and securely end user interactions, managing transaction context and system resources efficiently.
* **Transaction Handling:** Create new transactions or retrieve lists and details of existing ones, supporting lifecycle management and visibility into quotes.
* **Product Management:** Add or update products within transactions dynamically, allowing configuration and pricing adjustments based on product attributes.
* **Event Execution:** Trigger system or custom events on transactions to apply business logic such as approvals, validations, and versioning. These event APIs require authorization via session cookies and should be used carefully to avoid conflicting event triggers.
* **Data Retrieval:** Access detailed transaction headers and line items, including product data, quantities, pricing, and custom attributes, enabling comprehensive quote analysis and management.

## Practical Use and Additional Resources

These APIs support real-time quote management workflows within ServiceNow CPQ, empowering customers to automate and control complex quoting processes. The runtime APIs provide responses with session IDs, transaction metadata, and updated transaction data to ensure seamless integration and state management.

A Postman collection is available for ServiceNow customers to test and explore these runtime APIs efficiently, streamlining development and troubleshooting.  
Reference for the runtime APIs used in the ServiceNow Quote Experience, including their purposes, responses, and a Postman collection 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/I2NleWJSOSWDwByP5iZScA "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.").

## Postman collection {#quote-tm-runtime-api-calls__postman-collection}

The following Postman collection provides ready-to-use API requests 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).

