Documentation

GET /api/suppliers

Sourcing options for a named product.

RequestGET /api/suppliers
AuthenticationSession cookie required
Handlerbackend/server.py

What it does

Suppliers for a query. With no question it refuses by name and says what to do instead — name a product to source, or claim one first — rather than returning an empty list that reads as 'none exist'.

Authentication

Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.

Parameters

ParameterInTypeRequiredDescription
ff_sessioncookiestringOptionalThe session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims.
qquerystringOptionalThe product to source. Absent produces `refused` / `no_question`.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

curl -s -b cookies.txt -c cookies.txt \
  "https://flowfinds.ai/api/suppliers"
const res = await fetch("https://flowfinds.ai/api/suppliers", {
  method: "GET",
  credentials: "include",
});
const data = await res.json();
import requests

s = requests.Session()
r = s.get("https://flowfinds.ai/api/suppliers")
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  "$FLOWFINDS_ORIGIN/api/suppliers?q=…"

Responses

200Suppliers were found.

200No question was asked.

FieldTypeDescription
statusstring`refused`.
reasonstring`no_question`.
explanationstring'Name a product to source, or claim one first.'
suppliersarrayEmpty.

Errors

This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.

Related

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.