• 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

Schemas

CategoryListResponse

  • dataobject[] · required
  • paginationobject · required

CompanySearchResponse

  • dataobject[] · required
  • paginationobject · required

CompanyProductsListResponse

  • dataobject[] · required
  • paginationobject · required

CompanyProductFamiliesListResponse

  • dataobject[] · required
  • paginationobject · required

IntentSearchResponse

  • dataobject[] · required
  • paginationobject · required

CompanyProductFamilyDetail

  • idstring · uuid · required
  • namestring · required
  • lastUpdatedAtstring · date-time · required
  • defaultPriceRangeobject
  • productsobject[]

CategorySummary

  • idstring · uuid · required
  • namestring · required
  • descriptionstring · required
  • lastUpdatedAtstring · date-time · required
  • childCategoriesobject[]
    Default: []

CompanySummary

  • idstring · uuid · required
  • namestring · required
  • legalNamestring · required
  • domainstring · required
  • descriptionstring · required
  • discontinuedboolean · required
  • lastUpdatedAtstring · date-time · required
  • urlstring
  • iconstring
  • fiscalYearEndstring
  • stockSymbolsobject[]
  • categoryobject
  • realPurchaseCountinteger
  • competitorsobject[]

CompanyDetail

  • idstring · uuid · required
  • namestring · required
  • legalNamestring · required
  • domainstring · required
  • descriptionstring · required
  • discontinuedboolean · required
  • productFamiliesobject[] · required
  • productsobject[] · required
  • learningDataSamplesobject[] · required
  • lastUpdatedAtstring · date-time · required
  • competitorsobject[] · required
  • urlstring
  • iconstring
  • fiscalYearEndstring
  • stockSymbolsobject[]
  • categoryobject
  • defaultPriceRangeobject
  • realPurchaseCountinteger

ProductSummary

  • idstring · uuid · required
  • namestring · required
  • isCustomEstimateAvailableboolean · required
  • lastUpdatedAtstring · date-time · required
  • productFamilyIdstring · uuid
  • descriptionstring
  • iconstring
  • urlstring
  • defaultPricenumber
  • currencystring

ProductDetail

  • idstring · uuid · required
  • namestring · required
  • descriptionstring · required
  • pricingDimensionsobject[] · required
  • includedFeaturesobject[] · required
  • isCustomEstimateAvailableboolean · required
  • lastUpdatedAtstring · date-time · required
  • competitorsobject[] · required
  • companyobject · required
  • productFamilyIdstring · uuid
  • iconstring
  • urlstring
  • currencystring
  • defaultPricenumber

ProductDimension

  • idstring · uuid · required
  • namestring · required
  • descriptionstring · required
  • priceImpactKnownboolean · required
  • formFieldobject · required
  • dependsOnobject · required

BasicPriceResponse

  • estimateobject · required
  • currencystring · required
  • timestampstring · date-time · required

AdvancedPriceResponse

  • estimateobject · required
  • productEstimatesobject[] · required
  • currencystring · required
  • timestampstring · date-time · required
  • realPurchaseCountobject[] · required
  • realSimilarPurchasesobject[] · required

ScopeCreate

  • scopeTermsobject[] · minItems: 1 · required
  • productTermsobject[] · minItems: 1 · required
  • previousScopeIdstring · uuid

ScopeDetail

  • idstring · uuid · required
  • sourcestring · enum · required
    Enum values:
    manual
    document
  • createdOnstring · date-time · required
  • scopeTermsobject[] · required
  • productTermsobject[] · required
  • previousScopeIdstring · uuid
  • nextScopeIdstring · uuid
  • documentProcessingobject

WebhookCreateResponse

  • idstring · required
  • urlstring · uri · required
  • eventsstring[] · required
    Enum values:
    scope.extracted
    negotiation.summary.updated
  • secretstring

WebhookCreateRequest

  • urlstring · uri · required
  • eventsstring[] · required
    Enum values:
    scope.extracted
    negotiation.summary.updated

WebhookListResponse

  • idstring · required
  • urlstring · uri · required
  • eventsstring[] · required

WebhookEventListResponse

  • idstring · required
  • attemptsnumber · required
  • responseStatusnumber · required
  • lastAttemptAtstring · required
  • nextAttemptAtstring · required
  • successfulAtstring · required
  • updatedAtstring · required
  • createdAtstring · required
  • statusstring · required

WebhookDeleteResponse

  • idstring · required

WebhookEventDetailResponse

  • idstring · required
  • attemptsnumber · required
  • responseStatusnumber · required
  • lastAttemptAtstring · required
  • nextAttemptAtstring · required
  • successfulAtstring · required
  • updatedAtstring · required
  • createdAtstring · required
  • statusstring · required
  • dataobject · required

HealthCheckResponse

  • statusstring · enum · required
    Enum values:
    ok
    degraded
    error
  • timestampstring · date-time · required
  • versionstring · required
  • servicesobject[] · required

Pagination

  • totalinteger · required
  • limitinteger · required
  • offsetinteger · required

Error

  • statusnumber · required
  • titlestring · required
  • detailstring · required
  • typestring
  • instancestring
  • traceobject

IntentSummary

  • idstring · uuid · required
  • timestampstring · date-time · required
  • userDetailsobject · required
  • eventrequired

TrackRequest

  • engagementTypestring · enum · required
    Enum values:
    price_estimate
    price_check
    catalog_view_verified
    catalog_view
  • companyIdstring
  • productIdstring
  • scopeIdstring
  • urlstring
  • endUserIdentifierstring
  • endUserIpstring
  • endUserEmailstring
  • endUserOrganizationIdentifierstring
  • sourcestring

LearningDataSample

  • idstring · uuid · required
  • startDatestring · date-time · required
  • termMonthsnumber · required
  • negotiatedPricenumber · required
  • productNamesstring[] · required
  • primaryDimensionNamestring · required
  • primaryDimensionValuenumber · required
  • numberOfOtherDimensionsnumber · required

FaqsResponse

  • faqsobject[] · required
  • lastUpdatedAtstring · date-time · required

StartNegotiationRequest

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

StartNegotiationResponse

  • negotiationIdstring · uuid · required

AttachNegotiationResponse

  • messagestring · required
  • fileIdstring · uuid · required

ExternalUpdateRequest

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

UploadFileRequest

  • filestring · binary · required

UploadFileResponse

  • Idstring · uuid · required

NegotiationSummaryResponse

  • executiveSummariesobject[] · required

ModelResponse

  • idstring · uuid · required

ModelResponseCreate

  • modelstring

FileFactsResponse

  • factsobject[]
On this page
  • CategoryListResponse
  • CompanySearchResponse
  • CompanyProductsListResponse
  • CompanyProductFamiliesListResponse
  • IntentSearchResponse
  • CompanyProductFamilyDetail
  • CategorySummary
  • CompanySummary
  • CompanyDetail
  • ProductSummary
  • ProductDetail
  • ProductDimension
  • BasicPriceResponse
  • AdvancedPriceResponse
  • ScopeCreate
  • ScopeDetail
  • WebhookCreateResponse
  • WebhookCreateRequest
  • WebhookListResponse
  • WebhookEventListResponse
  • WebhookDeleteResponse
  • WebhookEventDetailResponse
  • HealthCheckResponse
  • Pagination
  • Error
  • IntentSummary
  • TrackRequest
  • LearningDataSample
  • FaqsResponse
  • StartNegotiationRequest
  • StartNegotiationResponse
  • AttachNegotiationResponse
  • ExternalUpdateRequest
  • UploadFileRequest
  • UploadFileResponse
  • NegotiationSummaryResponse
  • ModelResponse
  • ModelResponseCreate
  • FileFactsResponse