How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

DealHub Version API

Manage DealHub configuration Versions and their product catalog — retrieve, duplicate and activate versions, export playbook data, read and upload the product catalog, patch catalog items, manage the product hierarchy, and poll asynchronous request status.

This API exposes 20 operations across 16 paths, organized into 5 resource areas, and defines 44 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.dealhub.io.

20 operations 16 paths 44 schemas 3 DELETE11 GET1 PATCH5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.dealhub.io
Authentication
HTTP Bearer
Resource Areas
5

Authentication & Security 1

DealHub Version API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — A secret token generated by a CPQ administrator.

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 3 DELETE, 11 GET, 1 PATCH, 5 POST. They span 5 resource areas: Version Management, Playbook, Product Catalog, Product Hierarchy (Beta), Asynchronous Operations. Each is listed below with its method, path, parameters, and response codes.

Version Management 5

Endpoints for retrieving, creating, and managing versions.

GET
/api/v1/version/id/{version_id}
Get Version by ID
getVersionById 1 param → 200
GET
/api/v1/version/name/{version_name}
Get Version by Name
getVersionByName 1 param → 200
GET
/api/v1/versions
Get a List of Versions
getVersions 1 param → 200
POST
/api/v1/version/duplicate
Duplicate a Version
duplicateVersion body → 200
POST
/api/v1/version/activate
Activate a Version
activateVersion body → 200
Playbook 2

Endpoints for exporting Playbook configuration and data in JSON format, and for generating a Generate Quote API request template based on the Playbook structure.

GET
/api/version/{versionName}/playbook/{playbookId}/export
Get Playbook Data
exportPlaybookData 2 params → 200
GET
/api/version/{versionId}/playbook/{playbookId}/generate-quote-template
Get Generate Quote Template
getGenerateQuoteTemplate 2 params → 200400404500
Product Catalog 8

Endpoints for managing the product catalog within a specific version.

GET
/api/v1/version/{version_id}/products
Get Products of a Version
getVersionProducts 5 params → 200
POST
/api/v1/version/product_by_sku
Get Products by SKU
getProductsBySku body → 200
GET
/api/v1/version/products_excel/{version_id}
Extract Products to Excel
extractProductsExcel 1 param → 200
GET
/api/v1/version/{version_id}/products_catalog
Get Product Catalog
getProductCatalog 4 params → 200
PATCH
/api/v1/version/{version_id}/products_catalog
Update Product Catalog Items
updateProductCatalogItems 2 params body → 200400403
POST
/api/v1/version/{version_id}/products_catalog
Create or Update Product Catalog
uploadProductCatalog 1 param body → 200
DELETE
/api/v1/version/{version_id}/products_catalog/all
Delete All Products from Catalog
deleteAllProducts 1 param → 200400
DELETE
/api/v1/version/{version_id}/products_catalog/by_sku
Delete Specific Products by SKU
deleteProductsBySku 1 param body → 200400
Product Hierarchy (Beta) 3
GET
/api/beta/version/{version_id}/product-hierarchy
Get Product Hierarchy
getProductHierarchy 1 param → 200
POST
/api/beta/version/{version_id}/product-hierarchy
Create or Update Product Hierarchy
updateProductHierarchy 1 param body → 200
DELETE
/api/beta/version/{version_id}/product-hierarchy
Delete from Product Hierarchy
deleteFromProductHierarchy 1 param body → 200
Asynchronous Operations 2

Endpoints for tracking the status of asynchronous requests.

GET
/api/v1/request/{request_id}/status
Get Asynchronous Request Status
getAsyncRequestStatus 1 param → 200
GET
/api/v1/request/{request_id}/summary
Get Asynchronous Request Execution Summary
getAsyncRequestSummary 1 param → 200

Schemas 44

The contract defines 44 schemas that model the data the API accepts and returns. The most detailed are PricingRuleProduct (24 properties), BundleCatalogItem (14 properties), GenerateQuoteTemplateResponse (14 properties), QuoteTemplateLineItem (14 properties). Each schema is shown below with its type and property counts.

Version
object
4 properties
DuplicateVersionRequest
object
4 properties 2 required
ActivateVersionRequest
object
1 property 1 required
AsyncResponse
object
1 property
Info
object
7 properties
ProductBasic
object
7 properties
VersionProductsResponse
object
2 properties
ProductsBySkuRequest
object
3 properties 1 required
ProductAttribute
object
2 properties
ProductFactor
object
3 properties 1 required
ProposalAttribute
object
3 properties 2 required
VolumeDiscount
object
Defines the volume discount tables associated with the pricing rule. The value must be a key-value map where each entry represents a pair in the format
PricingRuleProduct
object
List of the product pricing rules. The order of the elements in this list determines the sequence in which the pricing rules are evaluated by the CPQ system. I…
24 properties 5 required
ProductPricingProduct
object
2 properties 1 required
ProductPricing
object
2 properties 1 required
AssignmentRuleProduct
object
6 properties 3 required
AssignmentRule
object
6 properties 3 required
ProductAssignment
object
4 properties 1 required
BundleAssignment
object
4 properties 1 required
ConditionalName
object
5 properties 1 required
InheritedAttribute
object
2 properties
BundleItem
object
6 properties 1 required
ProductCatalogItem
object
10 properties 3 required
BundleCatalogItem
object
14 properties 4 required
ProductHierarchyNode
object
5 properties
ProductCatalogGetResponse
object
3 properties
ProductCatalogPostRequest
object
2 properties
ProductCatalogPatchProduct
object
Represents an existing product whose data elements should be updated. Only sku is required. Include only the data categories (productattributes, productassignm…
4 properties 1 required
ProductCatalogPatchBundle
object
Represents an existing bundle whose data elements should be updated. Only sku is required. Include only the data categories (productattributes, productassignme…
5 properties 1 required
ProductCatalogPatchRequest
object
Request body for the PATCH product catalog endpoint. Include only the products and/or bundles whose data elements should be updated.
2 properties
RequestStatus
object
4 properties
RequestSummary
object
4 properties
RequestSummaryResponse
object
2 properties
PlaybookSyncSettings
object
2 properties
PlaybookMetadata
object
8 properties
PlaybookQuestion
object
5 properties
PlaybookGroup
object
5 properties
PlaybookExportResponse
object
2 properties
QuoteTemplatePartnerProgram
object
2 properties
QuoteTemplateQuoteData
object
2 properties
QuoteTemplatePartnerProgramData
object
Partner program-specific discounts.
3 properties
QuoteTemplateLineItem
object
14 properties
GenerateQuoteTemplateResponse
object
Preformatted JSON template for the Generate Quote API, based on the Playbook structure.
14 properties
PlaybookErrorResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

dealhub-version-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of DealHub Version API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.