Product Profile

The Product Profile object represents a product in the public catalog.

This object contains the following attributes:

Field Name	Data Type	Description
id	string	The identifier of the product profile. Example: PRP-1671-3887
externalId	string	The identifier within an external system. Example: arK9uX45
name	string	A user-friendly name of the product profile. Example: Microsoft
icon	string	The icon to be shown in grids and information cards. Example: /v1/public-catalog/product-profiles/PRP-1671-3887/icon
shortDescription	string	A short description of the product. Example: Enterprise productivity suite
longDescription	string	A long description of the product. Example: Enterprise productivity suites are cloud-based software packages designed to streamline communication.
featured	bool	Indicates whether this product should be featured on the UI. 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-office
facebook	string	A URL to the vendor’s Facebook page. Example: www.facebook.com/microsoft-office
youtube	string	A URL to the vendor’s Facebook page. Example: www.youtube.com/micromicrosoft-officesoft
xProfile	string	A URL to the vendor’s X page. Example: www.x/microsoft-office
categories	object	A reference to the category that owns this object. Example: "categories": [ { "id": "CAT-1671-3887", "name": "Development", "revision": 1, "status": "Published" } ]
industries	object	A reference to the industry that owns this object. Example: "industries": [ { "id": "IND-8249-7679", "name": "Development", "revision": 1, "status": "Published" }
segments	object	A reference to the segment that owns this object. Example: "segments": [ { "id": "SEG-1671-3887", "name": "Development", "revision": 1, "status": "Published" }
vendorProfiles	object	Reference to the vendorProfile that owns this object. Example: "vendorProfiles": [{ "id": "VNP-1671-3887", "icon": "/v1/public-catalog/vendor-profiles/VNP-1671-3887/icon" "name": "Microsoft", "status": "Draft" }]
platformProducts	object	Indicates products that have been linked to this profile. Example: [ { "id": "PRD-0049-1332", "name": "Microsoft Office", "icon": "/v1/catalog/products/PRD-0049-1332/icon", "revision": 2, "externalIds": { "operations": "123" }, "status": "Published" } ]
status	string	Indicates whether the product is draft, published, unpublished , or deleted.
audit	object	A reference to the audit object.
revision	integer	The entity's revision number. Example: 3

Example response

{
  "id": "PRP-1671-3887",
  "externalId": "arK9uX45",
  "name": "Office",
  "vendorProfile": {
    "id": "VNP-1671-3887",
    "icon": "/v1/public-catalog/vendor-profiles/VNP-1671-3887/icon"
    "name": "Microsoft"
  }
  "shortDescription": "Enterprise productivity suite",
  "longDescription": "Enterprise productivity suites are cloud-based software packages designed to streamline communication.",
  "website": "www.microsoft.com/office",
  "linkedin": "www.linkedin.com/microsoft-office",
  "facebook": "www.facebook.com/microsoft-office",
  "xProfile": "www.x.com/microsoft-office",
  "youtube": "www.youtube.com/microsoft-office",
  "termsLink": "https://info.here",
  "featured": false,
  "categories": [],
  "industries": [],
  "segments": [],
  "vendorProfiles": [],
  "platformProducts": [
    {
      "id": "PRD-0049-1332",
      "name": "Microsoft Office",
      "icon": "/v1/catalog/products/PRD-0049-1332/icon",
      "revision": 2,
      "externalIds": {
        "operations": "123"
      },
      "status": "Published"
    }
  ],
  "status": "Published",
  "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": 2,
        "name": "My token"
      },
    "deleted": {
      "at": "2024-05-17T09:17:36.406Z",
      "by": {
        "id": "TKN-3836-7769",
        "revision": 3,
        "name": "My token"
      }
    }
  }
}