POST/v3/live/vendorgraphics/product-catalog/products/find

Find products

Returns products matching a name search query

Version: v3
Rate limit: Tier 3 · 10–200 rps by plan
Billing: Company Vendorgraphics or Person Vendorgraphics · Find products

Request body

productNamestringRequired
Product name to search for

Headers: x-api-key Required · API key for authentication

Response

productsobject[]
Products matching the search query
- categoryIdsstring[]
  IDs of categories this product belongs to
- descriptionstring
  Product description
- idstring
  AggKnowledge product ID
- namestring
  Product name
- vendorAggkCompanyIdstring
  AggKnowledge company ID of the vendor offering this product

Status codes

Response

Example

{
  "products": [
    {
      "categoryIds": [
        "1785"
      ],
      "description": "Cloud data platform for warehousing, analytics, and secure data sharing.",
      "id": "60436221725246778",
      "name": "Snowflake Data Cloud",
      "vendorAggkCompanyId": "61230"
    }
  ]
}