• 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

Catalog API

Endpoint:https://api.vendr.com

Get a Company

GET
https://api.vendr.com
/v1/catalog/companies/{companyId}

Get a Company › path Parameters

  • companyIdstring · uuid · required

Get a Company › 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 a Company › Responses

  • 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
GET /v1/catalog/companies/{companyId}

Get a Product Family

GET
https://api.vendr.com
/v1/catalog/product-families/{productFamilyId}

Get a Product Family › path Parameters

  • productFamilyIdstring · uuid · required

Get a Product Family › 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 a Product Family › Responses

  • idstring · uuid · required
  • namestring · required
  • lastUpdatedAtstring · date-time · required
  • defaultPriceRangeobject
  • productsobject[]
GET /v1/catalog/product-families/{productFamilyId}

Get a Product

GET
https://api.vendr.com
/v1/catalog/products/{productId}

Get a Product › path Parameters

  • productIdstring · uuid · required

Get a Product › 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 a Product › Responses

  • 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
GET /v1/catalog/products/{productId}

List Categories

GET
https://api.vendr.com
/v1/catalog/categories

List Categories › query Parameters

  • limitinteger · min: 1 · max: 100
    Default: 10
  • offsetinteger
  • parentCategoryIdstring · uuid
  • sortBystring · enum
    Enum values:
    name
    Default: name
  • sortOrderstring · enum
    Enum values:
    asc
    desc
    Default: asc

List Categories › 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

List Categories › Responses

  • dataobject[] · required
  • paginationobject · required
GET /v1/catalog/categories

List Companies

GET
https://api.vendr.com
/v1/catalog/companies

List Companies › query Parameters

  • namestring
  • domainstring
  • categoryIdstring · uuid
  • limitinteger · min: 1 · max: 100
    Default: 10
  • offsetinteger
  • sortBystring · enum
    Enum values:
    name
    Default: name
  • sortOrderstring · enum
    Enum values:
    asc
    desc
    Default: asc
  • idsstring[] · maxItems: 30 · style: form

List Companies › 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

List Companies › Responses

  • dataobject[] · required
  • paginationobject · required
GET /v1/catalog/companies

List Product Families

GET
https://api.vendr.com
/v1/catalog/companies/{companyId}/product-families

List Product Families › path Parameters

  • companyIdstring · uuid · required

List Product Families › query Parameters

  • idsstring[] · maxItems: 30 · style: form
  • limitinteger · min: 1 · max: 100
    Default: 10
  • offsetinteger
  • sortBystring · enum
    Enum values:
    name
    sortOrder
    Default: sortOrder
  • sortOrderstring · enum
    Enum values:
    asc
    desc
    Default: asc

List Product Families › 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

List Product Families › Responses

  • dataobject[] · required
  • paginationobject · required
GET /v1/catalog/companies/{companyId}/product-families

List Products

GET
https://api.vendr.com
/v1/catalog/companies/{companyId}/products

List Products › path Parameters

  • companyIdstring · uuid · required

List Products › query Parameters

  • idsstring[] · maxItems: 30 · style: form
  • productFamilyIdstring · uuid
  • limitinteger · min: 1 · max: 100
    Default: 10
  • offsetinteger
  • sortBystring · enum
    Enum values:
    name
    sortOrder
    Default: sortOrder
  • sortOrderstring · enum
    Enum values:
    asc
    desc
    Default: asc

List Products › 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

List Products › Responses

  • dataobject[] · required
  • paginationobject · required
GET /v1/catalog/companies/{companyId}/products
Scope API