Documentation
GET /api/supplier-connection
Which supplier this account is connected to.
| Request | GET /api/supplier-connection |
|---|---|
| Authentication | Session cookie required |
| Handler | backend/server.py |
What it does
Reports the connection and nothing more. A selected supplier is not a verified quote, reserved stock, a completed sourcing action or a delivery guarantee, and the commerce assistant restates that limitation whenever it reads this endpoint. When no supplier has been chosen, the built-in FlowFinds supplier is reported as the default.
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
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ff_session | cookie | string | Optional | The 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. |
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/supplier-connection"const res = await fetch("https://flowfinds.ai/api/supplier-connection", {
method: "GET",
credentials: "include",
});
const data = await res.json();import requests
s = requests.Session()
r = s.get("https://flowfinds.ai/api/supplier-connection")
data = r.json()Recorded example
curl -s -b cookies.txt -c cookies.txt \
"$FLOWFINDS_ORIGIN/api/supplier-connection"Responses
200 — The default supplier applies.
| Field | Type | Description |
|---|---|---|
status | string | `connected`. |
kind | string | `flowfinds`. |
name | string | `FlowFinds Supplier`. |
default | boolean | True. |
200 — A supplier was connected.
| Field | Type | Description |
|---|---|---|
status | string | `connected`. |
kind | string | The supplier kind. |
name | string | As stored. |
connected_at | string | When it was connected. |
default | boolean | False. |
200 — The connection was removed.
| Field | Type | Description |
|---|---|---|
status | string | `not_connected`. |
disconnected_at | string | When it was removed. |
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
GET /api/suppliers— Sourcing options for a named product.POST /api/supplier-connection— Connect or disconnect a supplier.POST /api/samples/checkout— Order a physical sample of a product.
Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.