Sign in

v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB
Headless Quoting

Simulate a Quote

Synchronously calculates quote pricing and details based on the provided configuration without creating a persistent quote object in DealHub. Ideal for real-time price calculations.

Use this endpoint to calculate real-time pricing and quote details without creating a permanent record in DealHub. You have to inform the product and configuration data to receive the calculated line items and a financial summary.

To run a simulation, your request must include a version_id to specify which pricing and product rules to use. You also need to provide one of the following options:

  • external_opportunity_id: Use this to base the simulation on an existing opportunity in your CRM.
  • geo_code and currency: Use this combination for simulations that do not depend on specific CRM data.

📘 Required data

You must provide either the external_opportunity_id or both the geo_code and currency parameters. Providing both in the same request will result in an error.

post/api/v1/quote/simulate

Request body

version_idstring

DealHub version ID. If not provided, the system will use the active version.

external_opportunity_idstring

CRM opportunity ID.

geo_codestring

Geographic code.

currencystring

Currency ISO code to evaluate rules. Immutable once created.

line_item_details'basic' | 'all'

Determines the level of detail included in the response for line items.

playbookstring

The unique name of the playbook (not the display name). If not provided, the system uses the first API-type playbook.

total_sales_discountnumber

Total discount for all line items. Overrides default line-item discounts if provided.

Example request

{
  "quote_data": []
}

Response

Simulation successful.

statusstring
dealhub_proposal_idstring
dealhub_quote_idstring
dealroom_urlstring uri
approval_flowsboolean