Vendor Profile

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

This object contains the following attributes:

Field	Type	Description
id	string, core	(Read-only) The identifier of the vendor profile.
externalId	string	The identifier within an external system.
name	string, core	A user-friendly name of the vendor profile.
icon	string	Icon to be shown on grids and info cards.
description	string	A description of the vendor.
featured	bool	Indicates if this product should be featured on the user interface.
website	string	A URL to the vendor’s website.
linkedin	string	A URL to the vendor’s LinkedIn page.
facebook	string	A URL to the vendor’s Facebook page.
youtube	string	A URL to the vendor’s YouTube page.
xProfile	string	A URL to the vendor’s X page.
owner	object	The vendor account that owns this vendor profile, if applicable. The value is null for unclaimed profiles.
products	object	Represents the productProfile object.
categories	object	Represents the category that owns this object
status	string, core	Indicates whether the item is draft, published, unpublished, or deleted.
audit	object	(Read-only) Represents the audit object.
revision	integer, core	The revision number of the entity.

Example

VENDOR PROFILE OBJECT

{
  "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"
      }
    }
  }
}