Supplier Matching & Comparison

Authenticate every request with Authorization: Bearer clr_live_YOUR_API_KEY.

Start supplier finding

POST /objects/{objectId}/supplier-finding Start supplier finding through the Claro Public API. Required scopes: objects, team

Parameters

Name	Location	Type	Required
`objectId`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "row_id": "00000000-0000-4000-8000-000000000003",
  "min_suppliers": 10,
  "search_tier": "focus"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/objects/$OBJECT_ID/supplier-finding" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "row_id": "00000000-0000-4000-8000-000000000003",
  "min_suppliers": 10,
  "search_tier": "focus"
}'

import json
import requests
object_id = "YOUR_OBJECT_ID"
url = f"https://platform.getclaro.ai/api/public/v1/objects/{object_id}/supplier-finding"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "row_id": "00000000-0000-4000-8000-000000000003",
  "min_suppliers": 10,
  "search_tier": "focus"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const objectId = "YOUR_OBJECT_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/objects/${objectId}/supplier-finding`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "row_id": "00000000-0000-4000-8000-000000000003",
    "min_suppliers": 10,
    "search_tier": "focus"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Generate catalogue comparison details

POST /objects/comparison/details/stream Generate catalogue comparison details through the Claro Public API. Required scopes: objects, team

Request body

Content type: application/json (required)

Request example

{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierId": "00000000-0000-4000-8000-000000000002"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/objects/comparison/details/stream" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierId": "00000000-0000-4000-8000-000000000002"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/objects/comparison/details/stream"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierId": "00000000-0000-4000-8000-000000000002"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/objects/comparison/details/stream`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "primaryId": "00000000-0000-4000-8000-000000000001",
    "supplierId": "00000000-0000-4000-8000-000000000002"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.text();

Responses

200 - Server-sent workflow events
Default - Error response. Rate-limited responses use HTTP 429.

Generate catalogue product matches

POST /objects/comparison/product-matches/stream Generate catalogue product matches through the Claro Public API. Required scopes: objects, team

Request body

Content type: application/json (required)

Request example

{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierId": "00000000-0000-4000-8000-000000000002"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/objects/comparison/product-matches/stream" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierId": "00000000-0000-4000-8000-000000000002"
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/objects/comparison/product-matches/stream"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierId": "00000000-0000-4000-8000-000000000002"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/objects/comparison/product-matches/stream`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "primaryId": "00000000-0000-4000-8000-000000000001",
    "supplierId": "00000000-0000-4000-8000-000000000002"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.text();

Responses

200 - Server-sent workflow events
Default - Error response. Rate-limited responses use HTTP 429.

Get saved comparison statuses

POST /objects/comparison/results/status Get saved comparison statuses through the Claro Public API. Required scopes: objects, team

Request body

Content type: application/json (required)

Request example

{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierIds": [
    "00000000-0000-4000-8000-000000000002"
  ]
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/objects/comparison/results/status" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierIds": [
    "00000000-0000-4000-8000-000000000002"
  ]
}'

import json
import requests
url = f"https://platform.getclaro.ai/api/public/v1/objects/comparison/results/status"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "primaryId": "00000000-0000-4000-8000-000000000001",
  "supplierIds": [
    "00000000-0000-4000-8000-000000000002"
  ]
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/objects/comparison/results/status`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "primaryId": "00000000-0000-4000-8000-000000000001",
    "supplierIds": [
      "00000000-0000-4000-8000-000000000002"
    ]
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get a saved catalogue comparison result

GET /objects/comparison/result Get a saved catalogue comparison result through the Claro Public API. Required scopes: objects, team

Parameters

Name	Location	Type	Required
`primaryId`	query	string	Yes
`supplierId`	query	string	Yes

Example request

curl -X GET "https://platform.getclaro.ai/api/public/v1/objects/comparison/result?primaryId=YOUR_PRIMARY_ID&supplierId=YOUR_SUPPLIER_ID" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY"

import requests
url = f"https://platform.getclaro.ai/api/public/v1/objects/comparison/result?primaryId=YOUR_PRIMARY_ID&supplierId=YOUR_SUPPLIER_ID"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
response = requests.get(url, headers=headers)
response.raise_for_status()
print(response.text)

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/objects/comparison/result?primaryId=YOUR_PRIMARY_ID&supplierId=YOUR_SUPPLIER_ID`, {
  method: "GET",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Review a catalogue product match

POST /objects/comparison/product-matches/{matchId}/review Review a catalogue product match through the Claro Public API. Required scopes: objects, team

Parameters

Name	Location	Type	Required
`matchId`	path	string	Yes

Request body

Content type: application/json (required)

Request example

{
  "reviewStatus": "APPROVED"
}

Example request

curl -X POST "https://platform.getclaro.ai/api/public/v1/objects/comparison/product-matches/$MATCH_ID/review" \
  -H "Authorization: Bearer clr_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "reviewStatus": "APPROVED"
}'

import json
import requests
match_id = "YOUR_MATCH_ID"
url = f"https://platform.getclaro.ai/api/public/v1/objects/comparison/product-matches/{match_id}/review"
headers = {"Authorization": "Bearer clr_live_YOUR_API_KEY"}
payload = json.loads(r'''{
  "reviewStatus": "APPROVED"
}''')
response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.text)

const matchId = "YOUR_MATCH_ID";

const response = await fetch(`https://platform.getclaro.ai/api/public/v1/objects/comparison/product-matches/${matchId}/review`, {
  method: "POST",
  headers: {
    Authorization: "Bearer clr_live_YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "reviewStatus": "APPROVED"
  }),
});

if (!response.ok) throw new Error(await response.text());
const data = await response.json();

Responses

200 - Successful response
Default - Error response. Rate-limited responses use HTTP 429.

Get Started

Core

Operations

Modules

Research Agents

Platform Reference

API Documentation

Supplier Matching & Comparison

Start supplier finding

Parameters

Request body

Example request

Responses

Generate catalogue comparison details

Request body

Example request

Responses

Generate catalogue product matches

Request body

Example request

Responses

Get saved comparison statuses

Request body

Example request

Responses

Get a saved catalogue comparison result

Parameters

Example request

Responses

Review a catalogue product match

Parameters

Request body

Example request

Responses

​Start supplier finding

​Parameters

​Request body

​Example request

​Responses

​Generate catalogue comparison details

​Request body

​Example request

​Responses

​Generate catalogue product matches

​Request body

​Example request

​Responses

​Get saved comparison statuses

​Request body

​Example request

​Responses

​Get a saved catalogue comparison result

​Parameters

​Example request

​Responses

​Review a catalogue product match

​Parameters

​Request body

​Example request

​Responses

Start supplier finding

Parameters

Request body

Example request

Responses

Generate catalogue comparison details

Request body

Example request

Responses

Generate catalogue product matches

Request body

Example request

Responses

Get saved comparison statuses

Request body

Example request

Responses

Get a saved catalogue comparison result

Parameters

Example request

Responses

Review a catalogue product match

Parameters

Request body

Example request

Responses