Vendr
App · 25 actions
Look up software products and pricing, manage purchase scopes and webhooks, and work with negotiations and contract analyses.
Actions
| Action | What it does |
|---|---|
| Advanced Price Estimate | Advanced Price Estimate. |
| Basic Price Estimate | Basic Price Estimate. |
| Chat with an agent | Chat with an agent. |
| Create a Scope | Create a Scope. |
| Create a webhook | Create a webhook. |
| Create contract analysis | Create contract analysis. |
| Delete webhook | Delete webhook. |
| Get a Company | Get a Company. |
| Get a contract analysis | Get a contract analysis. |
| Get a Product | Get a Product. |
| Get a Product Family | Get a Product Family. |
| Get a Scope | Get a Scope. |
| Get escalation | Get escalation. |
| Get FAQs | Get FAQs. |
| Get webhook event | Get webhook event. |
| List Categories | List Categories. |
| List Companies | List Companies. |
| List escalations | List escalations. |
| List Product Families | List Product Families. |
| List Products | List Products. |
| List webhook events | List webhook events. |
| List webhooks | List webhooks. |
| Negotiation summary | Negotiation summary. |
| Post external update | Post external update. |
| Start negotiation | Start negotiation. |
Advanced Price Estimate
Advanced Price Estimate. Returns the full service response for the connected account.
Inputs
- Scope ID
scope_idtextRequired - ID of the scope to retrieve pricing for
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"currency": "example",
"estimate": {
"percentile10": 1,
"percentile15": 1,
"percentile20": 1,
"percentile25": 1,
"percentile30": 1,
"percentile35": 1,
"percentile40": 1,
"percentile45": 1,
"percentile50": 1,
"percentile55": 1,
"percentile60": 1,
"percentile65": 1,
"percentile70": 1,
"percentile75": 1,
"percentile80": 1,
"percentile85": 1,
"percentile90": 1
},
"productEstimates": [],
"realPurchaseCount": [],
"realSimilarPurchases": [],
"timestamp": "example"
},
"has_more": false,
"next_cursor": null
}Basic Price Estimate
Basic Price Estimate. Returns the full service response for the connected account.
Inputs
- Scope ID
scope_idtextRequired - ID of the scope to retrieve pricing for
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"currency": "example",
"estimate": {
"percentile25": 1,
"percentile50": 1,
"percentile75": 1
},
"timestamp": "example"
},
"has_more": false,
"next_cursor": null
}Chat with an agent
Chat with an agent.
Inputs
None.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"id": "example"
},
"has_more": false,
"next_cursor": null
}Create a Scope
Create a Scope.
Inputs
- Previous scope ID
previous_scope_idtext - Id of the previous scope this replaced
- Scope terms
scope_termslistRequired - Terms of purchase that apply to the whole scope
- Product terms
product_termslistRequired - Terms of purchase that apply to specific products, including the dimension values for each product
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"createdOn": "example",
"documentProcessing": {
"documentType": "order_form",
"error": "example",
"filename": "example",
"mimeType": "example",
"status": "pending",
"updatedAt": "example"
},
"id": "example",
"nextScopeId": "example",
"previousScopeId": "example",
"productTerms": [],
"scopeTerms": [],
"source": "manual"
},
"has_more": false,
"next_cursor": null
}Create a webhook
Create a webhook.
Inputs
- Url
urltextRequired - url.
- Events
eventslistRequired - events.One or more of:
scope.extracted,negotiation.summary.updated,negotiation.escalation.created,negotiation.escalation.updated.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"events": [],
"id": "example",
"secret": "example",
"url": "example"
},
"has_more": false,
"next_cursor": null
}Create contract analysis
Create contract analysis.
Inputs
- Signed url
signed_urltextRequired - signedUrl.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Delete webhook
Delete webhook.
Inputs
- Webhook
webhook_idtextRequired - The ID of the webhook
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"id": "example"
},
"has_more": false,
"next_cursor": null
}Get a Company
Get a Company. Returns the full service response for the connected account.
Inputs
- Company ID
company_idtextRequired - ID of the company to retrieve
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"category": {
"description": "example",
"id": "example",
"lastUpdatedAt": "example",
"name": "example",
"parentCategoryId": "example"
},
"competitors": [],
"defaultPriceRange": {
"currency": "example",
"max": 1,
"min": 1
},
"description": "example",
"discontinued": true,
"domain": "example",
"fiscalYearEnd": "example",
"icon": "example",
"id": "example",
"lastUpdatedAt": "example",
"learningDataSamples": [],
"legalName": "example",
"name": "example",
"productFamilies": [],
"products": [],
"realPurchaseCount": 1,
"stockSymbols": [],
"url": "example"
},
"has_more": false,
"next_cursor": null
}Get a contract analysis
Get a contract analysis. Returns the full service response for the connected account.
Inputs
- Contract analysis ID
contract_analysis_idtextRequired - The ID of the contract analysis
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Get a Product
Get a Product. Returns the full service response for the connected account.
Inputs
- Product ID
product_idtextRequired - ID of the product to retrieve
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"company": {
"domain": "example",
"id": "example",
"legalName": "example",
"name": "example"
},
"competitors": [],
"currency": "example",
"defaultPrice": 1,
"description": "example",
"icon": "example",
"id": "example",
"includedFeatures": [],
"isCustomEstimateAvailable": true,
"lastUpdatedAt": "example",
"name": "example",
"pricingDimensions": [],
"productFamilyId": "example",
"url": "example"
},
"has_more": false,
"next_cursor": null
}Get a Product Family
Get a Product Family. Returns the full service response for the connected account.
Inputs
- Product family ID
product_family_idtextRequired - ID of the product family to retrieve
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"defaultPriceRange": {
"currency": "example",
"max": 1,
"min": 1
},
"id": "example",
"lastUpdatedAt": "example",
"name": "example",
"products": []
},
"has_more": false,
"next_cursor": null
}Get a Scope
Get a Scope. Returns the full service response for the connected account.
Inputs
- Scope ID
scope_idtextRequired - ID of the scope to retrieve
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"createdOn": "example",
"documentProcessing": {
"documentType": "order_form",
"error": "example",
"filename": "example",
"mimeType": "example",
"status": "pending",
"updatedAt": "example"
},
"id": "example",
"nextScopeId": "example",
"previousScopeId": "example",
"productTerms": [],
"scopeTerms": [],
"source": "manual"
},
"has_more": false,
"next_cursor": null
}Get escalation
Get escalation. Returns the full service response for the connected account.
Inputs
- Negotiation ID
negotiation_idtextRequired - ID of the negotiation the escalation belongs to.
- Escalation ID
escalation_idtextRequired - ID of the escalation to retrieve.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"escalation": {
"clarifications": [],
"createdAt": "example",
"escalationType": "clarification",
"id": "example",
"resolvedAt": "example",
"status": "open"
}
},
"has_more": false,
"next_cursor": null
}Get FAQs
Get FAQs. Returns the full service response for the connected account.
Inputs
- Company ID
company_idtextRequired - Id of the company to retrieve negotiation insights for
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"faqs": [],
"lastUpdatedAt": "example"
},
"has_more": false,
"next_cursor": null
}Get webhook event
Get webhook event. Returns the full service response for the connected account.
Inputs
- Webhook
webhook_idtextRequired - The ID of the webhook
- Event ID
event_idtextRequired - The ID of the webhook event
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"attempts": 1,
"createdAt": "example",
"data": {
"body": {
"data": {
"errorMessage": "example",
"scopeId": "example",
"status": "completed"
},
"eventType": "scope.extracted"
},
"headers": {},
"parsedQuery": {},
"path": "example",
"query": "example"
},
"id": "example",
"lastAttemptAt": "example",
"nextAttemptAt": "example",
"responseStatus": 1,
"status": "example",
"successfulAt": "example",
"updatedAt": "example"
},
"has_more": false,
"next_cursor": null
}List Categories
List Categories. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Limit
limitnumber - Maximum number of categories to returnFrom 1 to 100.
- Offset
offsetnumber - Number of categories to skipAt least 0.
- Parent category ID
parent_category_idtext - Filter by parent category ID
- Sort by
sort_bytext - Field to sort byOne of:
name. - Sort order
sort_ordertext - Sort orderOne of:
asc,desc.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": [],
"pagination": {
"limit": 1,
"offset": 1,
"total": 1
}
},
"has_more": false,
"next_cursor": null
}List Companies
List Companies. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Name
nametext - Filter by company name (partial match)
- Domain
domaintext - Filter by company domain
- Category ID
category_idtext - Filter by category ID
- Limit
limitnumber - Maximum number of companies to returnFrom 1 to 100.
- Offset
offsetnumber - Number of companies to skipAt least 0.
- Sort by
sort_bytext - Field to sort byOne of:
name. - Sort order
sort_ordertext - Sort orderOne of:
asc,desc. - Ids
idslist - A string of comma separated company ids.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": [],
"pagination": {
"limit": 1,
"offset": 1,
"total": 1
}
},
"has_more": false,
"next_cursor": null
}List escalations
List escalations. Returns the full service response for the connected account.
Inputs
- Negotiation ID
negotiation_idtextRequired - ID of the negotiation to list escalations for.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"escalations": []
},
"has_more": false,
"next_cursor": null
}List Product Families
List Product Families. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Company ID
company_idtextRequired - ID of the company to retrieve
- Ids
idslist - A string of comma separated product family ids.
- Limit
limitnumber - Maximum number of companies to returnFrom 1 to 100.
- Offset
offsetnumber - Number of companies to skipAt least 0.
- Sort by
sort_bytext - Field to sort byOne of:
name,sortOrder. - Sort order
sort_ordertext - Sort orderOne of:
asc,desc.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": [],
"pagination": {
"limit": 1,
"offset": 1,
"total": 1
}
},
"has_more": false,
"next_cursor": null
}List Products
List Products. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Company ID
company_idtextRequired - ID of the company to retrieve
- Ids
idslist - A string of comma separated product ids.
- Product family ID
product_family_idtext - ID of the product family to retrieve
- Limit
limitnumber - Maximum number of companies to returnFrom 1 to 100.
- Offset
offsetnumber - Number of companies to skipAt least 0.
- Sort by
sort_bytext - Field to sort byOne of:
name,sortOrder. - Sort order
sort_ordertext - Sort orderOne of:
asc,desc.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"data": [],
"pagination": {
"limit": 1,
"offset": 1,
"total": 1
}
},
"has_more": false,
"next_cursor": null
}List webhook events
List webhook events. Returns the full service response for the connected account.
Inputs
- Webhook
webhook_idtextRequired - The ID of the webhook
Outputs
datalist- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}List webhooks
List webhooks. Returns the full service response for the connected account.
Inputs
None.
Outputs
datalist- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": [],
"has_more": false,
"next_cursor": null
}Negotiation summary
Negotiation summary. Returns the full service response for the connected account.
Inputs
- Negotiation ID
negotiation_idtextRequired - ID of the negotiation you want a summary for.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"createdAt": "example",
"escalations": [],
"executiveSummaries": [],
"id": "example",
"scope": {
"additionalNotes": "example",
"dealType": "new_purchase",
"evaluatingAlternatives": true,
"id": "example",
"leverage": "example",
"productIssues": "example",
"renewalDate": "example",
"requirements": "example",
"targetPrice": 1,
"targetSignDate": "example",
"termInMonths": 1,
"updatedAt": "example"
},
"status": "planning",
"supplier": {
"name": "example"
},
"updatedAt": "example",
"url": "example"
},
"has_more": false,
"next_cursor": null
}Post external update
Post external update.
Inputs
- Negotiation ID
negotiation_idtextRequired - ID of the negotiation to post the external update to.
- Timestamp
timestampdate and timeRequired - When the external entity was last updated.
- External ID
external_idtextRequired - ID of the external entity.
- Source
sourcetextRequired - Source of the external entity.
- Schema
schemaobjectRequired - Additional structured schema. Use the documented fields.
- Payload
payloadobjectRequired - Additional structured payload. Use the documented fields.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {},
"has_more": false,
"next_cursor": null
}Start negotiation
Start negotiation.
Inputs
- Metadata
metadataobject - Additional structured metadata. Use the documented fields.
- Supplier
supplierobjectRequired - Additional structured supplier. Use the documented fields.
- Participants
participantslist - Optional list of additional people involved in the deal beyond the primary contact, such as legal, security, or procurement, so they can be included on communications or internal routing.
- Contact email
contact_emailtextRequired - Email of the primary stakeholder on the buyer side, the main person Vendr should treat as owner of this negotiation for questions and updates.
- Contact name
contact_nametextRequired - Full name of the primary buyer contact (paired with `contactEmail`).
- Engagement type
engagement_typetextRequired - How your organization wants Vendr engaged on this opportunity. `vendr_led` means Vendr drives the negotiation workflow end to end. `strategy_only` means advisory or strategic support without Vendr acting as the full execution owner of the negotiation.One of:
vendr_led,strategy_only. - Scope
scopeobject - Additional structured scope. Use the documented fields.
- File
fileobject - Additional structured file. Use the documented fields.
Outputs
dataobject- Data.
has_moretrue/false- Has more.
next_cursortext- Next cursor.
Example output
{
"data": {
"negotiationId": "example"
},
"has_more": false,
"next_cursor": null
}