Vendr Public API

Scopes API

Endpoint:https://api.vendr.com

Get a Scope

GET
https://api.vendr.com
/v1/scopes/{scopeId}

Get a Scope › path Parameters

  • scopeIdstring · uuid · required

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

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

Create a Scope

POST
https://api.vendr.com
/v1/scopes

Create a Scope › 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

Create a Scope › Request Body

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

Create a Scope › Responses

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

Create Scope via Document

POST
https://api.vendr.com
/v1/scopes/from-document

Create Scope via Document › 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

Create Scope via Document › Request Body

  • filestring · binary · required
  • purchaseTypestring · enum
    Enum values:
    new_purchase
    renewal

Create Scope via Document › Responses

  • scopeIdstring · uuid · required
Catalog APIPricing API