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-identifierstring

Get a Company › Responses

  • idstring · uuid · required
  • namestring · required
  • legalNamestring · required
  • domainstring · required
  • descriptionstring · required
  • discontinuedboolean · required
  • productFamiliesobject[] · required
  • productsobject[] · required
  • urlstring
  • iconstring
  • fiscalYearEndstring
  • stockSymbolsobject[]
  • categoryobject
  • defaultPriceRangeobject

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-identifierstring

Get a Product Family › Responses

  • idstring · uuid · required
  • namestring · required
  • defaultPriceRangeobject
  • productsobject[]

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-identifierstring

Get a Product › Responses

  • idstring · uuid · required
  • namestring · required
  • descriptionstring · required
  • pricingDimensionsobject[] · required
  • includedFeaturesobject[] · required
  • companyobject · required
  • productFamilyIdstring · uuid
  • iconstring
  • urlstring
  • currencystring

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-identifierstring

List Categories › Responses

  • dataobject[] · required
  • paginationobject · required

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

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-identifierstring

List Companies › Responses

  • dataobject[] · required
  • paginationobject · required

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

  • limitinteger · min: 1 · max: 100
    Default: 10
  • offsetinteger
  • sortBystring · enum
    Enum values:
    name
    Default: name
  • 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-identifierstring

List Product Families › Responses

  • dataobject[] · required
  • paginationobject · required

List Products

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

List Products › path Parameters

  • companyIdstring · uuid · required

List Products › query Parameters

  • productFamilyIdstring · uuid
  • limitinteger · min: 1 · max: 100
    Default: 10
  • offsetinteger
  • sortBystring · enum
    Enum values:
    name
    Default: name
  • 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-identifierstring

List Products › Responses

  • dataobject[] · required
  • paginationobject · required
Scopes API