Vendor Profile

The Vendor Profile object represents a vendor in the public catalog.

This object contains the following attributes:

Field Name	Data Type	Description
id	string	The identifier of the vendor profile. Example: VNP-1671-3887
externalId	string	The identifier within an external system. Example: arK9uX45
name	string	A user-friendly name of the vendor profile. Example: Microsoft
icon	string	Icon to be shown on grids and info cards. Example: /v1/public-catalog/vendor-profiles/VNP-1671-3887/icon
description	string	A description of the vendor. Example: Sells Enterprise
featured	bool	Indicates if this product should be featured on the user interface. Example: False
website	string	A URL to the vendor’s website. Example: www.microsoft.com
linkedin	string	A URL to the vendor’s LinkedIn page. Example: www.linkedin.com/microsoft
facebook	string	A URL to the vendor’s Facebook page. Example: www.facebook.com/microsoft
youtube	string	A URL to the vendor’s YouTube page. Example: www.youtube.com/microsoft
xProfile	string	A URL to the vendor’s X page. Example: www.x.com/microsoft
owner	object	The vendor account that owns this vendor profile, if applicable. The value is null for unclaimed profiles. Example: { "id": "ACC-6881-3912", "name": "Microsoft", "icon": "/v1/accounts/accounts/ACC-6881-3912/icon", "revision": 1, "type": "Vendor", "status": "Enabled" }
products	object (productProfile)	Example: [ { "id": "PRP-1671-3887", "name": "Office", "icon": "/v1/public-catalog/product-profiles/PRP-1671-3887/icon", "revision": 2 } ]
categories	object	Reference to the category that owns this object Example: "categories": [ { "id": "CAT-1671-3887", "name": "Development", "revision": 1, "status": "Published" } ]
status	string	Indicates whether the item is draft, published, unpublished, or deleted.
audit	object	A reference to the audit object. Example: { "created": { "at": "2024-04-08T06:30:05.807Z", "by": { "id": "USR-2172-2499", "revision": 1, "name": "John User" } }, "updated": { "at": "2024-05-16T09:17:36.406Z", "by": { "id": "TKN-3836-7769", "revision": 1, "name": "My token" }, "deleted": { "at": "2024-05-17T09:17:36.406Z", "by": { "id": "TKN-3836-7769", "revision": 1, "name": "My token" } } }
revision	integer	The revision number of the entity. Example: 3

Example response

{
  "id": "VNP-1671-3887",
  "externalId": "arK9uX45", --??
  "name": "Microsoft",
  "icon": "/v1/public-catalog/vendor-profiles/VNP-1671-3887/icon",
  "description": "Provides enterprise software",
  "website": "www.microsoft.com",
  "linkedin": "www.linkedin.com/microsoft",
  "facebook": "www.facebook.com/microsoft",
  "xProfile": "www.x.com/microsoft",
  "youtube": "www.youtube.com/microsoft",
  "featured": false,
  "categories": [],
  "status": "Published",
  "revision": 2,
  "owner": {
    "id": "ACC-6881-3912",
    "name": "Microsoft",
    "icon": "/v1/accounts/accounts/ACC-6881-3912/icon",
    "revision": 1,
    "type": "Vendor",
    "status": "Enabled"
  },
  "products": [
    {
      "id": "PRP-1671-3887",
      "name": "Office",
      "icon": "/v1/public-catalog/product-profiles/PRP-1671-3887/icon",
      "revision": 2
    }
  ],
  "audit": {
    "created": {
      "at": "2024-04-08T06:30:05.807Z",
      "by": {
        "id": "USR-2172-2499",
        "revision": 1,
        "name": "John User"
      }
    },
    "updated": {
      "at": "2024-05-16T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 1,
        "name": "My token"
      },
    "deleted": {
      "at": "2024-05-17T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 1,
        "name": "My token"
      }
    }
  }
}