Vendr

App · 25 actions

Look up software products and pricing, manage purchase scopes and webhooks, and work with negotiations and contract analyses.

Actions

ActionWhat it does
Advanced Price EstimateAdvanced Price Estimate.
Basic Price EstimateBasic Price Estimate.
Chat with an agentChat with an agent.
Create a ScopeCreate a Scope.
Create a webhookCreate a webhook.
Create contract analysisCreate contract analysis.
Delete webhookDelete webhook.
Get a CompanyGet a Company.
Get a contract analysisGet a contract analysis.
Get a ProductGet a Product.
Get a Product FamilyGet a Product Family.
Get a ScopeGet a Scope.
Get escalationGet escalation.
Get FAQsGet FAQs.
Get webhook eventGet webhook event.
List CategoriesList Categories.
List CompaniesList Companies.
List escalationsList escalations.
List Product FamiliesList Product Families.
List ProductsList Products.
List webhook eventsList webhook events.
List webhooksList webhooks.
Negotiation summaryNegotiation summary.
Post external updatePost external update.
Start negotiationStart negotiation.

Advanced Price Estimate

Advanced Price Estimate. Returns the full service response for the connected account.

Inputs

Scope IDscope_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 IDscope_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 IDprevious_scope_idtext
Id of the previous scope this replaced
Scope termsscope_termslistRequired
Terms of purchase that apply to the whole scope
Product termsproduct_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

UrlurltextRequired
url.
EventseventslistRequired
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 urlsigned_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

Webhookwebhook_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 IDcompany_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 IDcontract_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 IDproduct_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 IDproduct_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 IDscope_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 IDnegotiation_idtextRequired
ID of the negotiation the escalation belongs to.
Escalation IDescalation_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 IDcompany_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

Webhookwebhook_idtextRequired
The ID of the webhook
Event IDevent_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

Limitlimitnumber
Maximum number of categories to returnFrom 1 to 100.
Offsetoffsetnumber
Number of categories to skipAt least 0.
Parent category IDparent_category_idtext
Filter by parent category ID
Sort bysort_bytext
Field to sort byOne of: name.
Sort ordersort_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

Namenametext
Filter by company name (partial match)
Domaindomaintext
Filter by company domain
Category IDcategory_idtext
Filter by category ID
Limitlimitnumber
Maximum number of companies to returnFrom 1 to 100.
Offsetoffsetnumber
Number of companies to skipAt least 0.
Sort bysort_bytext
Field to sort byOne of: name.
Sort ordersort_ordertext
Sort orderOne of: asc, desc.
Idsidslist
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 IDnegotiation_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 IDcompany_idtextRequired
ID of the company to retrieve
Idsidslist
A string of comma separated product family ids.
Limitlimitnumber
Maximum number of companies to returnFrom 1 to 100.
Offsetoffsetnumber
Number of companies to skipAt least 0.
Sort bysort_bytext
Field to sort byOne of: name, sortOrder.
Sort ordersort_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 IDcompany_idtextRequired
ID of the company to retrieve
Idsidslist
A string of comma separated product ids.
Product family IDproduct_family_idtext
ID of the product family to retrieve
Limitlimitnumber
Maximum number of companies to returnFrom 1 to 100.
Offsetoffsetnumber
Number of companies to skipAt least 0.
Sort bysort_bytext
Field to sort byOne of: name, sortOrder.
Sort ordersort_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

Webhookwebhook_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 IDnegotiation_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 IDnegotiation_idtextRequired
ID of the negotiation to post the external update to.
Timestamptimestampdate and timeRequired
When the external entity was last updated.
External IDexternal_idtextRequired
ID of the external entity.
SourcesourcetextRequired
Source of the external entity.
SchemaschemaobjectRequired
Additional structured schema. Use the documented fields.
PayloadpayloadobjectRequired
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

Metadatametadataobject
Additional structured metadata. Use the documented fields.
SuppliersupplierobjectRequired
Additional structured supplier. Use the documented fields.
Participantsparticipantslist
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 emailcontact_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 namecontact_nametextRequired
Full name of the primary buyer contact (paired with `contactEmail`).
Engagement typeengagement_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.
Scopescopeobject
Additional structured scope. Use the documented fields.
Filefileobject
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
}

On this page