AggKnowledge API

Product Catalog

Endpointhttps://api.aggknowledgeai.com

Fetch product categories

GET

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/categories

Returns product categories with cursor-based pagination, sorted deterministically by category ID. Maximum of 250 categories per page. (Tier 3)

Fetch product categories › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Fetch product categories › query Parameters

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

limit

integer · int32

Maximum number of results to return (default: 100, max: 250)

Default: 100

Fetch product categories › Headers

x-api-key

string · required

API key for authentication

Fetch product categories › Responses

List of product categories with pagination

Response containing product categories with cursor-based pagination

object[]

List of product categories

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

Fetch products

GET

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/products

Returns products with cursor-based pagination, sorted deterministically by product ID. Maximum of 250 products per page. (Tier 3)

Fetch products › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Fetch products › query Parameters

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

limit

integer · int32

Maximum number of results to return (default: 100, max: 250)

Default: 100

Fetch products › Headers

x-api-key

string · required

API key for authentication

Fetch products › Responses

List of products with pagination

Response containing products with cursor-based pagination

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

object[]

List of products

GET/v2/{environment}/vendorgraphics/products

curl --request GET \
  --url https://api.aggknowledgeai.com/v2/:environment/vendorgraphics/products \
  --header 'x-api-key: <string>'

shell

Example Responses

{
  "cursor": "cursor",
  "products": [
    {
      "categories": [
        {
          "categoryHierarchy": [
            {
              "categoryId": 137,
              "level": 4,
              "name": "Procurement"
            }
          ],
          "id": 1785,
          "name": "Accounts Payable (AP) and Spend Analysis"
        }
      ],
      "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
      "id": 60436221725246776,
      "name": "Coupa",
      "vendorAggkCompanyId": 42971468
    }
  ]
}

json

application/json

Vendorgraphic products

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/search/products

Returns vendorgraphic products (Tier 3)

Vendorgraphic products › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Vendorgraphic products › Headers

x-api-key

string · required

API key for authentication

Vendorgraphic products › Request Body

Product search request

productName

string

Vendorgraphic products › Responses

Product search results

object[]

POST/v2/{environment}/vendorgraphics/search/products

curl --request POST \
  --url https://api.aggknowledgeai.com/v2/:environment/vendorgraphics/search/products \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <string>' \
  --data '
{
  "productName": "productName"
}
'

shell

Example Request Body

{
  "productName": "productName"
}

json

Example Responses

{
  "data": [
    {
      "categories": [
        {
          "categoryHierarchy": [
            {
              "categoryId": 137,
              "level": 4,
              "name": "Procurement"
            }
          ],
          "id": 1785,
          "name": "Accounts Payable (AP) and Spend Analysis"
        }
      ],
      "description": "Spend smarter with the leading spend management platform built for companies like you. Get the financial agility you need by transforming how your business spends.",
      "id": 60436221725246776,
      "name": "Coupa",
      "vendorAggkCompanyId": 42971468,
      "vendorName": "vendorName"
    }
  ]
}

json

application/json

Company Vendorgraphics Company

Fetch product categories

GET

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/categories

Returns product categories with cursor-based pagination, sorted deterministically by category ID. Maximum of 250 categories per page. (Tier 3)

Fetch product categories › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Fetch product categories › query Parameters

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

limit

integer · int32

Maximum number of results to return (default: 100, max: 250)

Default: 100

Fetch product categories › Headers

x-api-key

string · required

API key for authentication

Fetch product categories › Responses

List of product categories with pagination

Response containing product categories with cursor-based pagination

object[]

List of product categories

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

Fetch products

GET

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/products

Returns products with cursor-based pagination, sorted deterministically by product ID. Maximum of 250 products per page. (Tier 3)

Fetch products › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Fetch products › query Parameters

cursor

string

Cursor for pagination. Use the cursor value from the previous response to get more results.

limit

integer · int32

Maximum number of results to return (default: 100, max: 250)

Default: 100

Fetch products › Headers

x-api-key

string · required

API key for authentication

Fetch products › Responses

List of products with pagination

Response containing products with cursor-based pagination

cursor

string

Cursor for pagination. Use this value as the cursor parameter in the next request to get more results.

object[]

List of products

Vendorgraphic products

POST

https://api.aggknowledgeai.com

/v2/{environment}/vendorgraphics/search/products

Returns vendorgraphic products (Tier 3)

Vendorgraphic products › path Parameters

environment

string · enum · required

Environment (live or test)

Enum values:

live

test

Vendorgraphic products › Headers

x-api-key

string · required

API key for authentication

Vendorgraphic products › Request Body

Product search request

productName

string

Vendorgraphic products › Responses

Product search results

object[]