Transaction Manager: Using Runtime API calls

  • Release version: Zurich
  • Updated November 14, 2025
  • 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 Transaction Manager: Using Runtime API calls

    This document details the Runtime APIs used in ServiceNow's Transaction Manager, which facilitate various actions within the runtime end-user experience. These APIs are essential for managing transactions, initializing sessions, and retrieving transaction data effectively.

    Show full answer Show less

    Key Features

    • Initialize a session: Establishes a context for executing transaction events and returns a Session ID and Transaction ID.
    • Delete a session: Ends user activity and frees up resources, confirming deletion without returning additional information.
    • Create a transaction: Initiates a transaction to manage its lifecycle, providing a Transaction ID upon creation.
    • Run events on a transaction: Triggers events to execute workflows related to the transaction, with responses varying based on the event.
    • Add products to transactions: Allows for dynamic updates to transactions by adding products, returning updated transaction data.
    • Get a list of transactions: Retrieves all transactions for management, returning Transaction IDs and metadata.
    • Get details of a transaction: Provides header information for a transaction, essential for display and processing.
    • Get a transaction's lines: Returns detailed product-level data for each item in a transaction.
    • Get statistics for transactions: Offers metrics on views and sessions by user over a specified date range.

    Key Outcomes

    By utilizing these Runtime APIs, ServiceNow customers can effectively manage and manipulate transaction data, streamline the transaction lifecycle, enhance user experiences, and gather valuable insights through statistics, leading to improved operational efficiency.

    See a list of the APIs that are used in the runtime end user experience, together with their purposes and responses.

    ServiceNow CPQ APIs are divided into two categories: Runtime APIs and admin APIs. This article lists the runtime APIs for Transaction Manager.

    The Runtime APIs are the same APIs that are used in the runtime end user experience and include the following key actions.

    • Initialize a session
      • Purpose: Initializes a session to establish a context for executing transaction events, managing state, and processing subsequent API calls. Can initialize for an existing transaction, or if not specified, a new transaction will be created.
      • Response: Returns a Session ID, Transaction ID, and transaction information.
    • Delete a session
      • Purpose: Deletes a session to securely end user activity, clear session-specific data, and free up system resources.
      • Response: Session is deleted. No information is returned.
    • Create a transaction
      • Purpose: Creates a transaction, providing the object to manage the transaction lifecycle, configure and add products, and determine pricing.
      • Response: Returns a Transaction ID and transaction information.
    • Run events on a transaction (system and custom)
      • Purpose: Triggers a specified event on a transaction to execute predefined logic or workflows, such as editing field values, initiating approvals, versioning transactions, or validating configurations.
      • Response: Varies by specified event.
    • Add products to a transactions (upsert)
      • Purpose: Adds a product or products to a transaction, allowing dynamic configuration and pricing updates based on the product’s attributes.
      • Response: Returns updated transaction data with additional product.
    • Get a list of transactions
      • Purpose: Retrieves the list of transactions, enabling users to view, manage, or take action on an existing transaction.
      • Response: List of transactions with Transaction ID and other metadata.
    • Get details of a transaction
      • Purpose: Retrieves the header information of a transaction, providing key details such as stage, account, and summary-level data needed for display or processing.
      • Response: All header field data for the transaction.
    • Get a transaction's lines
      • Purpose: Retrieves the line item details for a transaction, returning product-level data such as quantities, pricing, and custom attributes for each item in the quote.
      • Response: All line-level field data for the transaction.
    • Get statistics for transactions
      • Purpose: Retrieves views and sessions by user as well as average time spent per stage for a given date range. Date range specifies a toDate and days which gets statistics from (toDate - days) -> toDate.
      • Response: Summary metrics for date range.

    Postman Collection