• Documentation
  • API Reference
Catalog API
    Get a CompanygetGet a Product FamilygetGet a ProductgetList CategoriesgetList CompaniesgetList Product FamiliesgetList Productsget
Scope API
    Get a ScopegetCreate a ScopepostCreate Scope via Documentpost
Pricing API
    Basic Price EstimategetAdvanced Price Estimateget
Webhooks API
    List webhooksgetCreate a webhookpostList webhook eventsgetGet webhook eventgetDelete webhookdelete
Negotiation API
    Start negotiationpostNegotiation summarygetAttach file to negotiationpostPost external updatepostGet FAQsget
Files API
    Upload filepost
Other endpoints
    OpenAPI SpecificationgetHealth checkget
Schemas
Vendr Public API

Negotiation API

Endpoint:https://api.vendr.com

Start negotiation

POST
https://api.vendr.com
/v1/negotiation/start

Start negotiation › Headers

  • Authorizationstring · required

Start negotiation › Request Body

  • supplierobject · minProps: 1 · required
  • contactEmailstring · email · required
  • contactNamestring · required
  • engagementTypestring · enum · required
    Enum values:
    vendr_led
    strategy_only
  • metadataobject
  • participantsobject[]
  • scopeobject
  • fileobject

Start negotiation › Responses

  • negotiationIdstring · uuid · required
POST /v1/negotiation/start

Negotiation summary

GET
https://api.vendr.com
/v1/negotiation/{negotiationId}/summary

Negotiation summary › path Parameters

  • negotiationIdstring · uuid · required

Negotiation summary › Headers

  • Authorizationstring · required
  • x-vendr-end-user-identifierstring
  • x-vendr-end-user-ipstring · ipv4
  • x-vendr-end-user-emailstring · email
  • x-vendr-end-user-organization-namestring

Negotiation summary › Responses

  • executiveSummariesobject[] · required
GET /v1/negotiation/{negotiationId}/summary

Attach file to negotiation

POST
https://api.vendr.com
/v1/negotiation/{negotiationId}/attach

Attach file to negotiation › path Parameters

  • negotiationIdstring · uuid · required

Attach file to negotiation › Headers

  • Authorizationstring · required
  • x-vendr-end-user-identifierstring
  • x-vendr-end-user-ipstring · ipv4
  • x-vendr-end-user-emailstring · email
  • x-vendr-end-user-organization-namestring

Attach file to negotiation › Request Body

  • filestring · binary · required
  • notestring

Attach file to negotiation › Responses

  • messagestring · required
  • fileIdstring · uuid · required
POST /v1/negotiation/{negotiationId}/attach

Post external update

POST
https://api.vendr.com
/v1/negotiation/{negotiationId}/external-update

Post external update › path Parameters

  • negotiationIdstring · uuid · required

Post external update › Headers

  • Authorizationstring · required
  • x-vendr-end-user-identifierstring
  • x-vendr-end-user-ipstring · ipv4
  • x-vendr-end-user-emailstring · email
  • x-vendr-end-user-organization-namestring

Post external update › Request Body

  • timestampstring · date-time · required
  • externalIdstring · required
  • sourcestring · required
  • schemaobject · required
  • payloadobject · required

Post external update › Responses

No data returned
POST /v1/negotiation/{negotiationId}/external-update

Get FAQs

GET
https://api.vendr.com
/v1/negotiation/faqs/{companyId}

Get FAQs › path Parameters

  • companyIdstring · uuid · required

Get FAQs › Headers

  • Authorizationstring · required
  • x-vendr-end-user-identifierstring
  • x-vendr-end-user-ipstring · ipv4
  • x-vendr-end-user-emailstring · email
  • x-vendr-end-user-organization-namestring

Get FAQs › Responses

  • faqsobject[] · required
  • lastUpdatedAtstring · date-time · required
GET /v1/negotiation/faqs/{companyId}
Webhooks APIFiles API