Choicera

Referenz: Choicera-MCP für Firmen

Hier steht alles zum Nachschlagen: Verbinden im Einzelnen, alle Werkzeuge mit ihren Feldern, der Ablauf einer Beratung, Fehler, Grenzen, Daten und Beispiele. Zum Einbinden reicht die Anleitung für Firmen; dein Agent bekommt Werkzeuge und Felder außerdem über tools/list selbst. Was neu ist, steht im Änderungsprotokoll.

Werte in den Beispielen (Kennungen, Preise, Texte) sind Beispiele, wo nicht „Antwort des Servers“ dabeisteht. Feldnamen und Aufbau entsprechen den Schemas des Servers.

Verbinden

Adresse und Transport

PunktWert
MCP-Endpunkthttps://choicera.com/agent/mcp
TransportMCP Streamable HTTP, zustandslos, Antworten immer als application/json
Methodenur POST; GET liefert 405 (kein Ereignisstrom, keine Benachrichtigungen)
Sitzungkeine; es gibt keine Mcp-Session-Id, jede Anfrage steht für sich
Pflicht-KopfzeilenContent-Type: application/json und Accept: application/json, text/event-stream (beide Typen; nur application/json ergibt 406)
Protokollversionen2025-11-25, 2025-06-18, 2025-03-26, 2024-11-05, 2024-10-07; Mcp-Protocol-Version ist optional, ein nicht unterstützter Wert ergibt 400 (außer bei initialize)
Anmeldungkeine für die Katalogwerkzeuge; OAuth 2.1 je Mitglied für alles Persönliche
Größe einer Anfragehöchstens 256 KB, sonst 413
Stapelanfragennicht erlaubt; ein JSON-Array ergibt 400
Benachrichtigungen des Clientsetwa notifications/initialized: Antwort 202 ohne Inhalt
GesundheitsprüfungGET https://choicera.com/agent/mcp/health, Antwort {"ok":true}
Server-KarteGET https://choicera.com/agent/mcp/server-card
ThemenlisteGET https://choicera.com/agent/mcp/topics
Partner-Kennung?partner=<Kennung> an der Adresse oder Kopfzeile X-Choicera-Partner, siehe Zuordnung zum Partner

Rufe den Endpunkt von deinem Server aus auf. Anfragen mit einer fremden Origin-Kopfzeile, etwa aus einem Browser, beantwortet der Server mit 403 forbidden_origin.

Ein vorheriges initialize ist wegen der Zustandslosigkeit nicht nötig. MCP-Clients senden es trotzdem, das schadet nicht.

initialize

Antwort des Servers (Auszug aus result):

{
  "protocolVersion": "2025-11-25",
  "capabilities": { "tools": { "listChanged": false } },
  "serverInfo": { "name": "choicera", "title": "Choicera", "version": "6b603ce", "websiteUrl": "https://choicera.com" },
  "instructions": "Choicera is a supplement consultation. ..."
}

Anmeldung: OAuth 2.1 mit dynamischer Client-Registrierung und PKCE

Alles Persönliche läuft über ein Zugriffstoken, das ein Mitglied für dein Produkt freigibt. Choicera ist dabei der Autorisierungsserver.

Discovery

AdresseInhalt
https://choicera.com/.well-known/oauth-protected-resource/agent/mcpMetadaten der geschützten Ressource: resource, authorization_servers, bearer_methods_supported, scopes_supported mit den fünf Choicera-Berechtigungen
https://choicera.com/.well-known/oauth-authorization-server (gleich: /.well-known/openid-configuration)Metadaten des Autorisierungsservers
https://choicera.com/api/auth/oauth2/registerdynamische Client-Registrierung (RFC 7591)
https://choicera.com/api/auth/oauth2/authorizeAutorisierung
https://choicera.com/api/auth/oauth2/tokenToken-Tausch und Erneuerung

Die Metadaten des Autorisierungsservers nennen unter scopes_supported nur openid, profile, email und offline_access. Die Choicera-Berechtigungen stehen in den Metadaten der Ressource; gib sie bei der Autorisierung ausdrücklich an. Ein Aufruf ohne Authorization-Kopfzeile bekommt keine 401-Aufforderung, sondern die Katalogwerkzeuge; dein Client startet die Anmeldung also selbst.

Ablauf

1. Client registrieren. redirect_uris müssen absolute https-Adressen sein, ohne Platzhalter * und ohne #-Teil. http://localhost und eigene App-Schemata werden abgewiesen; auch eine App leitet also auf eine https-Adresse deines Servers zurück. Mit token_endpoint_auth_method: "none" entsteht ein öffentlicher Client ohne Geheimnis; vertrauliche Clients (client_secret_basic, client_secret_post) sind ebenfalls möglich.

POST https://choicera.com/api/auth/oauth2/register
{
  "client_name": "Studio Coach",
  "redirect_uris": ["https://coach.example.com/oauth/choicera/callback"],
  "token_endpoint_auth_method": "none",
  "grant_types": ["authorization_code", "refresh_token"],
  "response_types": ["code"]
}

2. Mitglied zur Autorisierung schicken, mit PKCE S256 (Pflicht; plain wird abgewiesen) und state:

https://choicera.com/api/auth/oauth2/authorize?response_type=code&client_id=<client_id>&redirect_uri=https%3A%2F%2Fcoach.example.com%2Foauth%2Fchoicera%2Fcallback&scope=advisor%20checkout%3Apersonalized%20offline_access&state=<state>&code_challenge=<challenge>&code_challenge_method=S256

3. Das Mitglied meldet sich in einem Browserfenster von Choicera an (E-Mail-Code, Passkey oder Google; ohne Konto wird eines angelegt) und sieht danach den Einwilligungsbildschirm. Kommt das Mitglied über einen Messenger oder per E-Mail zu dir, schickst du ihm diesen Link.

4. Choicera leitet zurück an redirect_uri mit code, state und iss (https://choicera.com). Prüfe state und iss. Der Code gilt zehn Minuten.

5. Code tauschen:

POST https://choicera.com/api/auth/oauth2/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code&code=<code>&redirect_uri=<redirect_uri>&client_id=<client_id>&code_verifier=<verifier>
{
  "access_token": "<zufällige Zeichenfolge>",
  "token_type": "Bearer",
  "expires_in": 3600,
  "refresh_token": "<zufällige Zeichenfolge>",
  "scope": "advisor checkout:personalized offline_access"
}

6. Lies scope in der Token-Antwort. Das Mitglied kann einzelne Berechtigungen abwählen; das Token trägt nur, was es erteilt hat.

7. Jede MCP-Anfrage für dieses Mitglied trägt Authorization: Bearer <access_token>. Das Zugriffstoken ist eine undurchsichtige Zeichenfolge, kein JWT; prüfe es nicht selbst.

Berechtigungen (scopes)

BerechtigungSchaltet freiAuf dem Einwilligungsbildschirm
advisorBeratung und Plan, siehe WerkzeugeHäkchen „Beratung“
advisor:medicationkeine eigenen Werkzeuge; die Beratung darf nach Medikamenten fragen, answer_intake nimmt das Medikamenten-Formular an, Produkte tragen Hinweise zu MedikamentenHäkchen „Medikamente“, setzt „Beratung“ voraus
advisor:maternalkeine eigenen Werkzeuge; die Beratung darf nach Schwangerschaft und Stillzeit fragen, Produkte tragen passende HinweiseHäkchen „Schwangerschaft / Stillzeit“, setzt „Beratung“ voraus
checkout:personalizedProdukte und Warenkorb des Plans, Link zur PlanseiteTeil von „Beratung“, dazu Hinweis zu Kauflinks
checkout:catalogLink zu einem einzelnen Katalogprodukt (get_checkout_link mit productId)Hinweis zu Kauflinks, nur Nutzungsbedingungen nötig
offline_accessErneuerungstokenkein eigenes Häkchen
openid, profile, emailStandard-Berechtigungen des Autorisierungsservers; für die Beratung nicht nötig, frag sie nicht ankein eigenes Häkchen

Für einen Agenten mit Beratung, Plan und Kauf fragst du advisor checkout:personalized offline_access an. Als Partner fragst du advisor:medication und advisor:maternal nicht an. Was ohne diese beiden Freigaben gilt, steht unter Gesundheitsdaten.

Was das Mitglied auf dem Einwilligungsbildschirm sieht

Laufzeiten und erneutes Verbinden

WasLaufzeit
Autorisierungscode10 Minuten
Zugriffstoken1 Stunde (expires_in: 3600)
Erneuerungstoken7 Tage ab Ausgabe; nur mit offline_access

Werkzeuge

tools/list zeigt je nach Token verschiedene Werkzeuge: ohne Token nur die Katalogwerkzeuge, mit Token zusätzlich die Werkzeuge der erteilten Berechtigungen. Ein Werkzeug ohne passende Berechtigung fehlt in der Liste. Rufst du es trotzdem auf, kommt derselbe Fehler wie für ein Werkzeug, das es nicht gibt: MCP error -32602: Tool start_consultation not found (siehe Fehler). Prüfe deshalb vor einem Aufruf, ob das Werkzeug in der Liste für genau dieses Token steht.

Jedes Werkzeug bringt inputSchema, outputSchema und die Hinweise readOnlyHint, destructiveHint und openWorldHint mit. tools/list ist die maßgebliche Liste; lies die Schemas zur Laufzeit.

Werkzeuge heute

Erzeugt aus tools/list des Servers. Mit allen Berechtigungen zeigt tools/list heute 28 Werkzeuge, davon 5 ohne Konto. Die Felder jedes Werkzeugs stehen in der Feldreferenz.

WerkzeugBerechtigungArtZweck
list_brandskeineliestdie aktiven Marken
list_topicskeineliestdie laufenden Themen
search_productskeineliestKatalog nach Suchwort, Ziel, Thema oder Marke
get_productkeineliestein Produkt mit Varianten
get_goalskeineliestdie festen Ziel-Kennungen
start_consultationadvisorschreibtBeratung beginnen
send_messageadvisorschreibtAntwort des Mitglieds senden
answer_intakeadvisorersetztFormular der Beratung beantworten
undo_last_answeradvisorersetztletzte Antwort zurücknehmen
get_planadvisorersetztPlan erzeugen, abfragen, Entwurf beantworten
search_substancesadvisor oder checkout:personalizedliestWirkstoffe zum Hinzufügen finden, für den Entwurf oder den fertigen Plan
get_plan_productscheckout:personalizedliestProdukte zum fertigen Plan
add_to_cartcheckout:personalizedschreibtgewählte Produkte in den Warenkorb des Plans
get_checkout_linkcheckout:catalog oder checkout:personalizedschreibtLink zum Bestellen: mit planId der Warenkorb mit Verkäufern, Versand und Gesamtpreis und der Link in die Kasse oder zur Planseite (braucht checkout:personalized), mit productId in den Shop der Marke (braucht checkout:catalog)
fill_cart_with_setcheckout:personalizedersetztein Set der Planseite in den Warenkorb; ersetzt, was darin lag
update_cart_linecheckout:personalizedersetztMenge einer Zeile im Warenkorb ändern oder die Zeile entfernen
add_substancecheckout:personalizedschreibtWirkstoff zum fertigen Plan hinzufügen
set_brand_scopecheckout:personalizedersetztMarken des Plans abwählen oder wieder wählen
remove_substancecheckout:personalizedersetztselbst hinzugefügten Wirkstoff wieder aus dem Plan nehmen
set_shipping_countrycheckout:personalizedersetztVersandland des Plans setzen, DE oder AT
get_position_productscheckout:personalizedliestalle Produkte eines Planpunkts, sortiert und gefiltert wie auf der Planseite
rate_planadvisor oder checkout:personalizedersetztBewertung des fertigen Plans durch das Mitglied übermitteln, wie die Sterne unter dem Plan in der App
rate_messageadvisorersetztDaumen des Mitglieds zu einer Antwort der Beratung übermitteln, wie in der App
list_consultationsadvisorliesteigene Beratungen finden, neueste zuerst, mit dem Hinweis, ob sie hier weitergehen
get_consultationadvisorliesteine Beratung mit ihrer offenen Frage öffnen, um sie fortzusetzen
get_profileadvisorliestgespeicherte Angaben lesen, mit dem Stand der letzten Bestätigung
confirm_profileadvisorschreibtgespeicherte Angaben als bestätigt markieren, wie „Ja, stimmt“ in der App
get_orderscheckout:personalizedliesteigene Bestellungen an der Kasse mit Zahlstand und Versandstand, neueste zuerst, oder eine per Bestellnummer

„liest“ heißt readOnlyHint: true; „schreibt“ heißt readOnlyHint: false und destructiveHint: false; „ersetzt“ heißt destructiveHint: true. Alle Werkzeuge tragen openWorldHint: true.

Katalogsuche heute

So sucht search_products heute:

Ablauf einer Beratung

Der Grundsatz: Choicera führt die Beratung, dein Agent ist der Bote. Reiche jede Frage der Beratung an das Mitglied weiter und frage nicht selbst, was die Beratung gleich fragen wird. Wähle nie für das Mitglied.

Die Beratung antwortet in der Sprache des Choicera-Kontos (Deutsch oder Englisch), ihre Pflichttexte ebenso. Die Katalogwerkzeuge nehmen dafür language.

1. Beratung beginnen

start_consultation beginnt mit goalSlugs (Kennungen aus get_goals), mit topic (eine Kennung aus list_topics, optional mit eventDate) oder nur mit message, nie mit goalSlugs und topic zugleich. Angaben, die das Mitglied schon gemacht hat, gehen in statedProfile mit (siehe Angaben beim Start). message ist das Anliegen in den Worten des Mitglieds, ohne Medikamente, Diagnosen oder andere Gesundheitsdaten. Ohne Ziel und Thema reicht message allein: Die Beratung fragt dann selbst nach, so wie in der App. list_topics kann leer sein; dann geht der Start über goalSlugs oder message.

Starte keine zweite Beratung, solange eine offen ist; finde sie mit list_consultations und setze sie fort (siehe Beratung fortsetzen). Gibt es zu einem topic schon eine Beratung, beginnt start_consultation keine neue: Geht sie hier weiter, kommt ihre offene Frage als Antwort zurück, sonst der Fehler consultation_open_in_app.

2. Angaben beim Start

Hat das Mitglied deinem Agenten schon Angaben gemacht, etwa Körperwerte oder wie es schläft, gibt start_consultation sie in statedProfile mit. Das sind feste Werte, kein Freitext außer Namen; Medikamente gehören nie dazu. Choicera übernimmt sie erst, wenn das Mitglied sie bestätigt hat, und die Beratung fragt danach nur, was noch fehlt.

3. Antworttypen

Jeder Beratungszug liefert reply. reply.type sagt, was offen ist:

reply.typeBedeutungWas dein Agent tut
questionDie Beratung fragt etwasreply.text als Frage zeigen, options als Auswahl anbieten, Antwort mit send_message senden
messageText mit einer Frage, die das Mitglied frei beantwortetzeigen, freie Antwort mit send_message senden
statementnichts offen (Abschied, Information, Bestätigung); auch ein Thema, zu dem die Beratung nichts empfiehlt, dann mit den nächsten Schritten der App als Liste im Textzeigen, nicht im Namen der Beratung nachfragen
demographic_intake, medication_intake, sport_preferencesFormular, die Antwort trägt reply.formFelder einzeln abfragen, dann answer_intake
handover_confirmKarte mit den Angaben aus statedProfile, vor der Beratung; trägt reply.form der Art handover und optionszeigen, bestätigen oder korrigieren lassen, dann answer_intake (siehe Angaben beim Start)
ready_to_generatedie Beratung hat alles; identifiedGoals nennt die Ziele des Plansget_plan aufrufen

Behandle einen unbekannten Typ wie message.

Optionen: options sind ein Angebot, keine Grenze. Zeige sie als Auswahl, wo dein Kanal das kann. Bei freeText: true darf das Mitglied frei antworten. Sende den value der gewählten Option; bei multiSelect: true mehrere Werte, durch Kommas getrennt, in einer Nachricht. Sende die Antwort sofort, damit das Mitglied sie nicht noch einmal eingeben muss.

4. Formulare und answer_intake

kindAntwortblock und WerteHinweis
demographicsdemographics: gender (female, male, diverse, prefer_not_to_say), ageBracket (under_18, 18_29, 30_44, 45_59, 60_plus), weightBracket (under_60, 60_75, 75_90, 90_plus), heightBracket (under_160, 160_175, 175_190, 190_plus)alle Felder optional; die Beratung fragt Spannen, keine genauen Werte
sport_preferencessport_preferences: protein (any, lactose_free, plant_only), texture (any, creamy, clear), sweetness (any, no_artificial, unsweetened), form (powder_ok, capsule_tablet), caffeine (without, with)alle Felder optional
medicationmedication: choice (none oder meds), drugClasses (Liste aus pill_contraceptive, blood_thinner, thyroid_medication, antidepressant_ssri, antibiotic, other), freetext (bis 200 Zeichen)nur mit advisor:medication; bei meds mindestens eine Klasse oder ein Freitext; ersetzt die frühere Antwort ganz
handoverhandover: confirmed (true), changes (benannt wie statedProfile), rejectedFields (Feld-ids der Karte)nur auf der Karte handover_confirm, siehe Angaben beim Start

Die Medikamenten-Antwort lässt sich später ändern, auch nach dem Plan: answer_intake mit kind: "medication" und amend: true. Ohne Antwortblock kommt das Formular mit der bisherigen Antwort vorbelegt zurück. Nach dem Plan baut eine geänderte Antwort den Plan neu; rufe dann get_plan, bis der Stand completed ist.

5. Antwort zurücknehmen

undo_last_answer mit conversationId nimmt die letzte Antwort zurück, wie „Antwort ändern“ in der App, und liefert die Frage, zu der sie gehörte. Danach die neue Antwort mit send_message oder answer_intake senden.

6. Plan erzeugen mit get_plan

Bei ready_to_generate rufst du get_plan mit der conversationId. Der Server wartet einige Sekunden auf den Plan und antwortet sonst mit pending. status sagt, wie es weitergeht:

statusBedeutungWas dein Agent tut
pendingläuft noch; die Antwort trägt jobId, retryAfterSeconds (derzeit 5) und reason (still_pending oder upstream_unavailable)retryAfterSeconds warten, dann get_plan mit derselben conversationId und der jobId
intake_openein Formular ist noch offen; reply trägt eserst answer_intake
draft_reviewEntwurf liegt vor: plan und draftEntwurf zeigen und Zeile für Zeile beantworten lassen (unten)
refining_intakenach dem Entwurf hat die Beratung Rückfragen; plan und replyEntwurf zeigen, reply wie bei send_message behandeln, bis ready_to_generate, dann wieder get_plan
plan_generatednur der Entwurf liegt vorget_plan noch einmal aufrufen
regeneratingder Plan wird neu gebautkurz warten, get_plan noch einmal
completedfertiger Plan in plan, dazu disclosurePlan mit disclosure zeigen, Produkte anbieten
failedErzeugung gescheitert, Grund in reason (etwa plan_job_failed)dem Mitglied sagen, später erneut versuchen
no_plankein Plan vorhandenBeratung fortsetzen

Jeder Aufruf von get_plan zählt zum Kontingent der Beratungsaufrufe. Rufst du get_plan für eine fertige Beratung erneut auf, kommt der bestehende Plan zurück.

Entwurf beantworten: Frage je Zeile in draft.rows, ob das Mitglied den Wirkstoff schon nimmt (already_taking), eine Darreichungsform bevorzugt (preferred_form mit form aus draft.forms) oder ihn nicht nehmen will (do_not_want); not_taking hebt ein vorbelegtes already_taking auf. Frage nie nach dem Grund. Das Mitglied darf Wirkstoffe hinzufügen: finde sie mit search_substances (conversationId, query, leer für Vorschläge) und sende ihre keys als draftAdded, höchstens draft.addLimit. Wenn das Mitglied alle Zeilen durchgegangen ist, rufe get_plan einmal mit draftFeedback (leere Liste, wenn sich nichts ändert) und draftAdded. Das bestätigt den ganzen Entwurf. Bestätige den Entwurf nie für das Mitglied. Solange der Stand refining_intake ist, öffnet reopenDraft: true den Entwurf noch einmal mit den bisherigen Antworten.

priority: true an einer Entwurfszeile markiert die drei wichtigsten Wirkstoffe (der Stern in der App). Der fertige Plan trägt dieselben Angaben je Punkt, dazu die Rolle im Plan und in consultNotice den Pflichttext F11.

7. Produkte, Warenkorb, Kauflink

Namen im Katalog und im Plan

Katalog und Plan benennen dieselben Dinge verschieden:

WasKatalog (search_products, get_product)Plan (get_plan_products, add_to_cart)
Produkt-KennungidproductId
Varianten-Kennungvariants[].idvariants[].variantId
Markebrand: Objekt mit id, slug, name, color, logoUrlbrand: Text mit dem Namen der Marke; die Kennung steht in brands[].brandId
Währungcurrency am Produktcurrency an jeder Variante
Preisprice am Produkt (immer), variants[].price (auch null)variants[].price (auch null)
Verfügbarkeitvariants[].availablenur verfügbare Varianten stehen in der Liste
VorauswahlkeinedefaultVariantId
Packung und Geschmackvariants[].containerSize, containerUnit, flavordieselben Namen

Für den Warenkorb zählen nur die Kennungen aus get_plan_products.

Änderungen, die das Mitglied in deinem Kanal macht, laufen über die Werkzeuge von Choicera, nicht über einen Nachbau bei dir; so gelten dieselben Regeln wie auf der Planseite. get_plan_products liest bei jedem Aufruf den aktuellen Stand; ändert das Mitglied auf der Planseite etwas, siehst du es beim nächsten Aufruf. Eine Benachrichtigung darüber gibt es nicht.

Sets, Warenkorb und Marken:

8. Beratung fortsetzen und gespeicherte Angaben

Eine neue Unterhaltung in deinem Kanal muss nicht blind beginnen. Wann du die Werkzeuge rufst, entscheidet dein Agent; nach Verlauf oder Zusammenfassungen fragen sie nicht.

9. Bewerten

Das Mitglied kann seinen Plan und einzelne Antworten der Beratung bewerten wie in der App. Die Bewertungen landen dort, wo auch die aus der App landen, und tragen den Kanal agent, damit Choicera App und KI-Kanal getrennt auswerten kann. Die Werkzeuge übermitteln eine Bewertung, die das Mitglied selbst gibt; dein Agent fragt nicht von sich aus danach und bewertet nicht an Stelle des Mitglieds.

Fehler

Fehler kommen auf drei Ebenen. Prüfe sie in dieser Reihenfolge.

1. HTTP-Fehler am Endpunkt

Diese Antworten kommen vor jeder MCP-Verarbeitung. Der Inhalt ist JSON, aber nicht immer ein JSON-RPC-Objekt.

StatusInhaltWannHandlung
400{"error":"invalid_request"}leerer Inhalt, kein JSON, JSON-ArrayAnfrage korrigieren
400{"jsonrpc":"2.0","error":{"code":-32700,"message":"Parse error: Invalid JSON-RPC message"},"id":null}gültiges JSON, aber keine JSON-RPC-NachrichtAnfrage korrigieren
400JSON-RPC-Fehler -32000, Bad Request: Unsupported protocol version: ...Mcp-Protocol-Version mit einem nicht unterstützten WertKopfzeile weglassen oder unterstützten Wert senden
401{"error":"invalid_token"} mit WWW-Authenticate: Bearer error="invalid_token", resource_metadata="https://choicera.com/.well-known/oauth-protected-resource/agent/mcp"Authorization vorhanden, aber nicht Bearer <token>, oder Token unbekannt, abgelaufen oder widerrufenToken einmal erneuern, sonst neu verbinden lassen
403{"error":"forbidden_origin"}fremde Origin-Kopfzeilevom Server aus aufrufen, ohne Origin
404{"error":"not_found"}andere Pfade unter /agent/mcpAdresse prüfen
405{"error":"method_not_allowed"}nicht POST an /agent/mcpnur POST
406{"jsonrpc":"2.0","error":{"code":-32000,"message":"Not Acceptable: Client must accept both application/json and text/event-stream"},"id":null}Accept ohne einen der beiden Typenbeide Typen senden
413{"error":"payload_too_large"}Anfrage über 256 KBAnfrage verkleinern
415JSON-RPC-Fehler -32000, Unsupported Media Type: Content-Type must be application/jsonanderer Content-Typeapplication/json senden
429{"jsonrpc":"2.0","error":{"code":-32000,"message":"rate_limited"},"id":null} mit Retry-AfterGrenze je Mitglied oder je Absenderadresse, auch bei der Prüfung des Tokensso viele Sekunden warten
500{"error":"internal_error"}interner Fehlerspäter erneut versuchen
503{"jsonrpc":"2.0","error":{"code":-32000,"message":"server_busy"},"id":null} mit Retry-After: 1zu viele gleichzeitige Anfragenkurz warten, wiederholen
503{"jsonrpc":"2.0","error":{"code":-32000,"message":"upstream_unavailable"},"id":null} mit Retry-Afterdie Prüfung des Tokens ist gerade nicht erreichbarso viele Sekunden warten, wiederholen

Ohne Authorization-Kopfzeile gibt es kein 401: Die Anfrage läuft ohne Konto, und es gibt nur die Katalogwerkzeuge.

2. JSON-RPC-Fehler

HTTP 200, im Inhalt ein error-Objekt statt result. Das betrifft Methoden, die der Server nicht kennt, etwa resources/list oder prompts/list:

{"jsonrpc":"2.0","id":5,"error":{"code":-32601,"message":"Method not found"}}

Der Server bietet nur Werkzeuge an (tools/list, tools/call), keine Ressourcen und keine Prompts.

3. Fehler eines Werkzeugaufrufs

HTTP 200 und ein normales result mit isError: true, ohne structuredContent. Erfolgreiche Antworten haben kein Feld isError. Es gibt zwei Arten, die du am Text in content[0].text erkennst.

a) Protokollfehler des MCP-Servers. Der Text ist Klartext und beginnt mit MCP error und dem JSON-RPC-Code:

TextBedeutungHandlung
MCP error -32602: Tool <name> not foundDas Werkzeug gibt es nicht, oder es fehlt für dieses Token, weil das Token fehlt oder die Berechtigung nicht trägttools/list mit demselben Token prüfen; fehlt es dort, Mitglied mit der nötigen Berechtigung (neu) verbinden lassen
MCP error -32602: Input validation error: Invalid arguments for tool <name>: <Grund>Argumente passen nicht zum inputSchema, etwa limit 0Argumente nach dem inputSchema korrigieren
MCP error -32602: Output validation error: ...Antwort passte nicht zum eigenen outputSchema (Fehler bei Choicera)später erneut versuchen; bleibt er, melden

Antwort des Servers auf search_products mit limit 0:

{"result":{"content":[{"type":"text","text":"MCP error -32602: Input validation error: Invalid arguments for tool search_products: Number must be greater than or equal to 1 at limit"}],"isError":true},"jsonrpc":"2.0","id":2}

Werte nur Präfix und Code aus. Der Rest des Textes ist englisch, kommt aus der MCP-Bibliothek und kann sich mit deren Updates ändern.

b) Fehler von Choicera. Der Text ist JSON mit error und je nach Fall weiteren Feldern. Antwort des Servers auf search_products mit goal schlaf:

{"result":{"content":[{"type":"text","text":"{\"error\":\"invalid_request\",\"detail\":\"invalid_query\",\"hint\":\"goal must be a slug from get_goals; brand must be a slug from list_brands.\"}"}],"isError":true},"jsonrpc":"2.0","id":6}
errorZusatzfelderBedeutungHandlung
rate_limitedretryAfterSeconds (falls bekannt)Kontingent erreichtwarten, dann denselben Aufruf wiederholen
authorization_requiredreason: consent_required, consent_stale oder health_data_consent_required; ohne reason: Token ist zwischendurch ungültig gewordenEinwilligung fehlt oder ist veraltetMitglied neu verbinden lassen; es bestätigt auf choicera.com
insufficient_scopescopeDas Werkzeug ist sichtbar, aber dieser Aufruf braucht eine andere Berechtigung: get_checkout_link mit planId ohne checkout:personalized oder mit productId ohne checkout:catalog; search_substances mit planId ohne checkout:personalized; confirm_profile mit medication ohne advisor:medication oder mit maternal ohne advisor:maternalmit dieser Berechtigung neu verbinden oder den anderen Weg nehmen
invalid_requestdetail, manchmal hint oder retryAfterSecondsEingabe passt nicht oder der Stand erlaubt den Aufruf nichtdetail lesen, siehe unten
not_foundBeratung, Plan, Warenkorbzeile, Wirkstoff oder Bestellnummer gehört nicht diesem Mitglied, existiert nicht oder ist über diese Verbindung nicht erreichbar (siehe Beratung fortsetzen)Kennung prüfen, mit dem letzten Stand weitermachen
product_not_foundProdukt-Kennung unbekannt (get_product)Kennung aus search_products nehmen
upstream_errormanchmal detailFehler bei Choiceraspäter erneut versuchen; bleibt er, melden

Werte von detail bei invalid_request:

detailWerkzeugBedeutung
invalid_query (mit hint)search_productsgoal ist keine Kennung aus get_goals oder brand keine aus list_brands
unknown_topic (mit hint)search_productstopic steht nicht in list_topics
topic_and_goalsearch_productsgoal und topic zugleich
topic_and_goal_slugs, missing_topic_or_goal_slugsstart_consultationhöchstens eines von goalSlugs und topic angeben; ohne beide braucht der Start message
event_date_without_topicstart_consultationeventDate nur mit topic
trimester_without_pregnancystart_consultationstatedProfile.trimester nur mit lifeStage: pregnant
handover_field_not_on_cardanswer_intake mit kind: handoverchanges oder rejectedFields nennen ein Feld, das nicht auf der Karte steht
handover_in_progress (mit retryAfterSeconds)Aufrufe mit der Kennung einer Kartedie Bestätigung läuft noch: warten, dann denselben Aufruf wiederholen
handover_expiredAufrufe mit der Kennung einer Kartedie Karte ist älter als eine Stunde: Beratung neu beginnen
on_behalf_not_for_medicationsend_message, answer_intakeonBehalf gilt nicht für das Medikamenten-Formular; das Mitglied beantwortet es selbst
on_behalf_not_for_handoversend_message, answer_intakeonBehalf gilt nicht für die Karte handover_confirm; das Mitglied bestätigt sie selbst
message_in_flightBeratungswerkzeugedie Beratung arbeitet noch an der letzten Nachricht: kurz warten, denselben Aufruf wiederholen
conversation_closedsend_message, answer_intake, undo_last_answer, search_substances mit conversationIddie Beratung ist abgeschlossen und nimmt keine Antworten mehr; den Plan zeigt get_plan, eine neue Beratung beginnt start_consultation
plan_pending (mit retryAfterSeconds)wie conversation_closedder Plan der Beratung entsteht gerade: retryAfterSeconds warten, dann den Plan mit get_plan holen
consultation_open_in_appstart_consultation mit topiczu diesem Thema gibt es schon eine Beratung, die hier nicht weitergeht; das Mitglied setzt sie in der App fort
profile_changedconfirm_profiledie Angaben haben sich seit get_profile geändert oder es gibt keine: neu lesen und dem Mitglied zeigen
intake_not_openanswer_intakekein solches Formular mehr offen: mit der letzten Antwort weitermachen
answer_block_missing, answer_block_does_not_match_kind, declined_with_answer, amend_only_for_medication, medication_none_with_details, medication_details_requiredanswer_intakeAufbau der Formularantwort
answer_not_undoableundo_last_answerdie letzte Antwort lässt sich nicht zurücknehmen
draft_not_openget_plankein Entwurf zur Antwort offen
invalid_draft_feedbackget_planAntwort zum Entwurf passt nicht zu den Zeilen
provide exactly one of planId or productIdget_checkout_linkgenau eines angeben
provide exactly one of conversationId or planIdsearch_substancesgenau eines angeben
set_empty, substance_in_plan, substance_limit, substance_blocked, substance_no_products, scope_locked, brand_deselectedfill_cart_with_set, add_substance, set_brand_scope, update_cart_lineSet leer, Wirkstoff schon im Plan, Höchstzahl erreicht, Wirkstoff gesperrt oder ohne Produkte, Marken durch einen Link festgelegt, Marke abgewählt
plan_not_finalrate_plander Plan ist noch ein Entwurf; nichts gespeichert
invalid_reason_codesrate_planGründe gibt es nur bei 1 bis 3 Sternen
comment_withheldrate_plander Kommentar nennt Medikamente ohne advisor:medication oder Schwangerschaft oder Stillzeit ohne advisor:maternal; nichts gespeichert, die Bewertung geht ohne Kommentar
invalid_targetrate_messagedie Kennung gehört nicht zu einer Antwort der Beratung

Behandle unbekannte Werte von error, detail, reply.type und status so, dass dein Agent weiterläuft, etwa mit einem allgemeinen Hinweis an das Mitglied.

Grenzen

Anfragen je Minute

Die Grenzen zählen je Mitglied, je OAuth-Client oder je Absenderadresse deines Servers. Gemeinsam für alle verbundenen KI-Anwendungen (Assistenten wie Claude oder ChatGPT und Partner) gelten nur die Grenzen der Katalogwerkzeuge. Die Zahlen gelten derzeit; Choicera kann sie ändern.

GrenzeGilt fürDerzeitBei Überschreitung
Anfragen an /agent/mcp ohne Tokenje Absenderadresse deines Servers (IPv6 je /64)120 je MinuteHTTP 429 mit Retry-After
Anfragen an /agent/mcp mit Tokenje Mitglied120 je MinuteHTTP 429 mit Retry-After
Anfragen an /agent/mcp mit Tokenje Absenderadresse deines Servers; alle deine Mitglieder teilen sie1200 je MinuteHTTP 429 mit Retry-After
abgewiesene Tokensje Absenderadresse30 je Minute; danach kommt jede Anfrage mit Token von dieser Adresse als 429, bis die Minute um istHTTP 429 mit Retry-After
Anfragen ohne erkennbare Absenderadressealle gemeinsam20 je MinuteHTTP 429 mit Retry-After
gleichzeitig eingelesene Anfragenganzer Endpunkt32HTTP 503 mit Retry-After: 1
Katalogsuche (search_products)alle Anwendungen gemeinsam600 je MinuteWerkzeugfehler rate_limited mit retryAfterSeconds
Katalog lesen (get_product, list_brands, get_goals, list_topics; search_products mit topic zählt zusätzlich hier)alle Anwendungen gemeinsam600 je MinuteWerkzeugfehler rate_limited mit retryAfterSeconds
Beratungsaufrufe (start_consultation, send_message, answer_intake, undo_last_answer, get_plan, search_substances im Entwurf); jedes Abfragen von get_plan zählt mitje Mitglied30 je MinuteWerkzeugfehler rate_limited mit retryAfterSeconds
Beratungsaufrufe, wie obenje OAuth-Client, alle Mitglieder deines Clients zusammen300 je MinuteWerkzeugfehler rate_limited mit retryAfterSeconds
Bewertungen (rate_plan, rate_message), dieselbe Grenze wie für Bewertungen in der Appje Mitglied30 je MinuteWerkzeugfehler rate_limited
Beratungen finden und gespeicherte Angaben (list_consultations, get_consultation, get_profile, confirm_profile); zählen nicht zu den Beratungsaufrufenje Mitglied60 je MinuteWerkzeugfehler rate_limited mit retryAfterSeconds
Prüfung des Tokens (jede Anfrage mit Authorization, auch initialize und tools/list)je Mitglied240 je MinuteHTTP 429 mit Retry-After
Client-Registrierungje Adresse5 je MinuteFehler des Autorisierungsservers
Token-Endpunkt (Tausch und Erneuerung)je Adresse30 je MinuteFehler des Autorisierungsservers

Folgen für deine Integration:

Grenzen der Eingaben

EingabeErlaubtStandard
search_products.limit1 bis 5010
search_products.offset0 bis 10000
search_products.querybis 128 Zeichen
start_consultation.goalSlugs1 bis 10 Kennungen
start_consultation.messagebis 2000 Zeichen
send_message.message1 bis 5000 Zeichen
answer_intake.medication.freetextbis 200 Zeichen
get_plan.draftFeedbackbis 40 Einträge
get_plan.draftAddedbis 10 Kennungen (draft.addLimit)
search_substances.querybis 80 Zeichen, leer für Vorschläge
add_to_cart.items1 bis 20 Produkte je Aufruf
add_to_cart.items[].quantity1 bis 201
update_cart_line.quantity0 bis 20; 0 entfernt die Zeile
set_brand_scope.deselectedBrandIdsbis 100
rate_plan.stars1 bis 5
rate_plan.commentbis 500 Zeichen

Mit offset höchstens 1000 und limit höchstens 50 erreichst du höchstens die ersten 1050 Treffer einer Suche. total kann größer sein (ohne Suchwort derzeit über 1000); grenze die Suche dann ein. Blättere mit offset plus limit, nicht mit der Länge von products: Ein Produkt, das die Prüfung von Choicera nicht besteht, fällt aus der Seite, sodass products kürzer als limit sein kann, obwohl es weitere Treffer gibt.

Größe der Antworten

Jede erfolgreiche Antwort enthält dasselbe JSON zweimal, als Text in content[0].text und als structuredContent. Gemessen am 12. November 2026, ganze HTTP-Antwort:

AufrufGröße
search_products mit limit 1etwa 3 KB
search_products mit limit 10 (Standard)etwa 25 bis 27 KB, je nach Suche
search_products mit limit 20etwa 55 KB
search_products mit limit 50etwa 137 KB
get_product mit einer Varianteetwa 6 KB

Frage nur so viele Treffer ab, wie dein Agent zeigt, und gib deinem Modell möglichst nur eine der beiden Kopien. Die Trefferliste trägt nur die Felder zum Auswählen; die Einzelheiten stehen in get_product.

Welche Daten Choicera bekommt und zurückgibt

Daten an Choicera

WoherWasHinweis
KatalogwerkzeugeSuchwörter, Ziel-, Themen- und Marken-Kennungen, Produkt-Kennungenkeine personenbezogenen Daten übergeben; Suchwörter werden im Zugriffsprotokoll unkenntlich gemacht
jede AnfrageAdresse deines Servers (im Protokoll gekürzt), Client-Name und Version aus initialize, User-Agent
start_consultationgoalSlugs oder topic und eventDate, dazu oder allein message in den Worten des Mitglieds; dazu statedProfile mit Angaben, die das Mitglied schon gemacht hatkeine Medikamente, Diagnosen oder Gesundheitsdaten in message; statedProfile übernimmt Choicera erst nach der Bestätigung des Mitglieds
send_message, answer_intakeAntworten des Mitglieds auf die Fragen und Formulare der Beratungdie Antworten kommen vom Mitglied, direkt oder mit onBehalf aus dem, was es im Chat schon gesagt hat
get_planAntworten zum Entwurf, hinzugefügte Wirkstoffe
rate_plan, rate_messageSterne, Gründe und Kommentar zum Plan, Daumen zu einer Antwort der Beratungnur, was das Mitglied selbst bewertet; Medikamente, Schwangerschaft und Stillzeit im Kommentar nur mit der passenden Freigabe
Warenkorb-Werkzeugegewählte Produkte, Mengen, Sets, abgewählte Marken
Anmeldungdas Choicera-Konto meldet das Mitglied selbst im Fenster von Choicera andein Client übergibt keine Konto-Daten

Angaben, die das Mitglied deinem Agenten schon gesagt hat, gehen nur über statedProfile beim Start und erst nach der Bestätigung des Mitglieds auf der Karte ins Konto (siehe Angaben beim Start). Was Choicera aus früheren Beratungen desselben Kontos weiß, ist in Formularen vorbelegt (preset) oder wird nicht erneut gefragt.

Daten von Choicera

WerkzeugWas zurückkommt
KatalogwerkzeugeKatalogdaten: siehe Katalogprodukt
start_consultation, send_message, answer_intake, undo_last_answerconversationId, status, reply, compliance, an bewertbaren Antworten messageId; nach statedProfile dazu adopted und ignored
rate_plan, rate_messagedie gespeicherte Bewertung
get_planStand; Plan mit planId, Phasen, je Punkt Wirkstoff, Menge, Einnahmezeit, Basis oder Plus, Stern, Rolle, Beschreibung und Pflichttext F11; disclosure, compliance
get_plan_productsje Planpunkt Produkte mit Varianten, Preis, Grundpreis, Monatspreis, Passung, Warnhinweisen; Sets, Marken, Warenkorb mit Kosten je Shop
add_to_carthinzugefügte, zu bestätigende und abgelehnte Zeilen, Warenkorb-Summe
get_checkout_linkLink mit Pflichttexten; mit planId dazu Ziel des Links und Warenkorb mit Verkäufern, Zahlweg, Versand und Gesamtpreis
get_orderseigene Bestellungen an der Kasse: Bestellnummer, Zeitpunkt, Zahlstand, Betrag, je Verkäufer Versandstand, Lieferfenster und Sendungsverfolgung

Die MCP-Werkzeuge geben keine E-Mail-Adresse, keinen Namen und keine Konto-Kennung des Mitglieds heraus.

Choicera protokolliert jede Antwort an KI-Anwendungen samt Pflichttexten als Nachweis, pseudonymisiert und bis zu zehn Jahre. Einzelheiten stehen in der Datenschutzerklärung.

Gesundheitsdaten und Freigaben

Zuordnung zum Partner

Eine Anbindung mit deiner Partner-Kennung steht einem Aufruf über deinen Partner-Link gleich (§ 9 Abs. 8 der Partnerbedingungen).

Feldreferenz

Erzeugt aus inputSchema und outputSchema in tools/list des Servers, mit allen Berechtigungen. Heute kommen keine anderen Felder als die hier genannten. Lies die Schemas trotzdem zur Laufzeit und lass unbekannte Felder zu: Neue Felder können hinzukommen.

Spalte „Vorhanden“: immer heißt, das Feld steht in jeder Antwort; optional heißt, das Feld kann fehlen; auch `null` heißt, der Wert kann null sein. Bei Feldern in einem Objekt, etwa medication.choice, gelten „Pflicht“ und „Vorhanden“ innerhalb dieses Objekts. Zahlen hinter string nennen die Länge in Zeichen, hinter array die Zahl der Einträge, hinter integer und number den Wertebereich.

list_brands

Eingabe: keine.

Antwort

FeldTypVorhandenBedeutung
brandsarray ≤ 1000 von Markeimmerdie aktiven Marken

Marke

Alle Felder von Markenverweis, dazu:

FeldTypVorhandenBedeutung
taglinestring ≤ 1024immer, auch nullKurzbeschreibung
descriptionstring ≤ 8000immer, auch nullBeschreibung der Marke
traitsarray ≤ 128 von string ≤ 256immerMerkmale der Marke

Markenverweis

FeldTypVorhandenBedeutung
idstring ≤ 64immerKennung der Marke
slugstring ≤ 128immerKennung für search_products.brand
namestring ≤ 256immerName der Marke
colorstring ≤ 64immerFarbe der Marke, etwa #007ab3
logoUrlstring ≤ 4096immer, auch nullLogo der Marke

list_topics

Eingabe: keine.

Antwort

FeldTypVorhandenBedeutung
topicsarray ≤ 50 von Themaimmerdie laufenden Themen; die Liste kann leer sein

Thema

FeldTypVorhandenBedeutung
slugstring ≤ 128immerKennung für topic
labelDestring ≤ 256immerName deutsch
labelEnstring ≤ 256immerName englisch
activeFromstring ≤ 64immerBeginn des Zeitraums als ISO-Zeitpunkt
activeTostring ≤ 64immerEnde des Zeitraums als ISO-Zeitpunkt
eventDatestring ≤ 64immer, auch nullDatum des Ereignisses, etwa ein Wettkampf
goalSlugsarray 1 bis 20 von string ≤ 64immerZiele des Themas

search_products

Eingabe

FeldTypPflichtBedeutung
querystring ≤ 128neinSuchwort für Produkt, Inhaltsstoff oder Marke; keine Angaben über die Person; siehe Katalogsuche
goalstring ≤ 64neineine Kennung aus get_goals; nicht zusammen mit topic
topicstring 1 bis 128neineine Kennung aus list_topics; sucht wie die Ziele des Themas; nicht zusammen mit goal
brandstring ≤ 64neinslug einer Marke aus list_brands
limitinteger 1 bis 50neinTreffer je Seite, Standard 10
offsetinteger 0 bis 1000neinBeginn der Seite, Standard 0
languagede, enneinde oder en; ohne Angabe die Sprache des verknüpften Kontos, ohne Konto Deutsch

Antwort

FeldTypVorhandenBedeutung
productsarray ≤ 50 von Katalogproduktimmerdie Treffer dieser Seite
totalintegerimmerZahl aller Treffer
limitintegerimmerverwendetes limit
offsetintegerimmerverwendeter offset
matchModeall, anyimmerall, wenn jeder Treffer zu allen Suchwörtern passt; any, wenn es dafür keinen Treffer gab und die Suche auf einzelne Suchwörter ausweicht

Katalogprodukt

FeldTypVorhandenBedeutung
idstring ≤ 64immerProdukt-Kennung, Eingabe für get_product und get_checkout_link (productId)
titlestring ≤ 512immerProduktname der Marke
pricenumberimmerPreis in currency
currencystring ≤ 16immerWährung, etwa EUR
basePriceGrundpreisoptionalfehlt, wenn der Shop keine Füllmenge nennt; nie schätzen
productUrlstring ≤ 4096immer, auch nullProduktlink über https://choicera.com/go/... mit Kanal-Kennung c=agent; führt in den Shop der Marke; unverändert weitergeben
productUrlDisplaystring ≤ 8192immer, auch nullMarke, Link und Pflichttext F6, fertig zum Anzeigen; null, wenn productUrl null ist
compliancearray ≤ 4 von PflichttextoptionalPflichttexte einzeln: F6 zum Link, F8 zum Preis
formFactorstring ≤ 128immer, auch nullDarreichungsform, etwa capsule, tablet, powder
servingSizeDisplaystring ≤ 512immer, auch nullPortion als Text, etwa 2 Tabletten
strengthPerServingstring ≤ 512immer, auch nullWirkstoffmenge je Portion als Text
pricePerServingnumberimmer, auch nullPreis je Portion in currency
dietCompatibilityarray ≤ 128 von string ≤ 128immerErnährungsformen, etwa vegan, vegetarian
allergensarray ≤ 128 von string ≤ 128immerAllergene einschließlich Spuren, sortiert; eine leere Liste heißt „keine angegeben“, nicht „geprüft frei von Allergenen“
minAgeYearsintegerimmer, auch nullMindestalter laut Marke
maxAgeYearsintegerimmer, auch nullHöchstalter laut Marke
brandObjektimmerdie Marke
brand.slugstring ≤ 128immerKennung für search_products.brand
brand.namestring ≤ 256immerName der Marke
primaryIngredientsarray ≤ 5 von string ≤ 1024immerNamen der Hauptbestandteile laut Katalog; kann Hilfsstoffe enthalten
matchReasonsarray ≤ 2 von string ≤ 256immerbis zu zwei Gründe, warum das Produkt passt, etwa der gefundene Wirkstoff oder das Ziel

Grundpreis

FeldTypVorhandenBedeutung
amountnumberimmerPreis je 1 kg oder 1 l in der Währung des Preises
amountLabelstringimmerderselbe Betrag deutsch formatiert, etwa 173,33
unitstringimmerkg oder l

Pflichttext

FeldTypVorhandenBedeutung
idstring, nicht leerimmerKennung des Pflichttexts: F2, F4, F5, F6, F7, F8, F10 oder F11
textstring, nicht leerimmerder Text, wörtlich anzuzeigen
triggerstring, nicht leerimmerworauf er sich bezieht, etwa buy_link:<Kennung oder Adresse>, price:<...>, voucher:<...>, ai_recommendation, health_recommendation, authorized_claim, degraded_medication, degraded_maternal

get_product

Eingabe

FeldTypPflichtBedeutung
productIdstring ≤ 64jaeine id aus search_products; eine unbekannte oder falsch geformte Kennung ergibt product_not_found
languagede, enneinde oder en; ohne Angabe die Sprache des verknüpften Kontos, ohne Konto Deutsch

Antwort: Produktdetail

Produktdetail

FeldTypVorhandenBedeutung
idstring ≤ 64immerProdukt-Kennung, Eingabe für get_product und get_checkout_link (productId)
titlestring ≤ 512immerProduktname der Marke
sourceLanguagedeimmerSprache der Katalogtexte; heute immer Deutsch
brandMarkenverweisimmerdie Marke
pricenumberimmerPreis in currency
currencystring ≤ 16immerWährung, etwa EUR
basePriceGrundpreisoptionalfehlt, wenn der Shop keine Füllmenge nennt; nie schätzen
imageUrlstring ≤ 4096immer, auch nullProduktbild
productUrlstring ≤ 4096immer, auch nullProduktlink über https://choicera.com/go/... mit Kanal-Kennung c=agent; führt in den Shop der Marke; unverändert weitergeben
productUrlDisplaystring ≤ 8192immer, auch nullMarke, Link und Pflichttext F6, fertig zum Anzeigen; null, wenn productUrl null ist
compliancearray ≤ 4 von PflichttextoptionalPflichttexte einzeln: F6 zum Link, F8 zum Preis
couponGutscheinoptionalnur, wenn die Marke einen Gutschein mit nennbaren Bedingungen hat
formFactorstring ≤ 128immer, auch nullDarreichungsform, etwa capsule, tablet, powder
servingSizeDisplaystring ≤ 512immer, auch nullPortion als Text, etwa 2 Tabletten
servingsPerContainerintegerimmer, auch nullPortionen je Packung
dosageTextstring ≤ 8000immer, auch nullVerzehrempfehlung der Marke
strengthPerServingstring ≤ 512immer, auch nullWirkstoffmenge je Portion als Text
servingUnitstring ≤ 128immer, auch nullEinheit einer Portion, etwa Tabletten
pricePerServingnumberimmer, auch nullPreis je Portion in currency
primaryIngredientsarray ≤ 256 von string ≤ 1024immerNamen der Hauptbestandteile laut Katalog; kann Hilfsstoffe enthalten
dietCompatibilityarray ≤ 128 von string ≤ 128immerErnährungsformen, etwa vegan, vegetarian
allergensarray ≤ 128 von string ≤ 128immerAllergene einschließlich Spuren, sortiert; eine leere Liste heißt „keine angegeben“, nicht „geprüft frei von Allergenen“
minAgeYearsintegerimmer, auch nullMindestalter laut Marke
maxAgeYearsintegerimmer, auch nullHöchstalter laut Marke
intakeAdvicestring ≤ 2000immer, auch nullEinnahmehinweis der Marke
warningsstring ≤ 2000immer, auch nullWarnhinweise der Marke als Text
pznstring ≤ 32immer, auch nullPharmazentralnummer
servingIntervalDaysintegerimmerAbstand zwischen zwei Portionen in Tagen; 1 heißt täglich
ingredientsDeclarationarray ≤ 128 von string ≤ 4000immerZutatenliste laut Marke
variantsarray ≤ 512 von Katalogvarianteimmeralle Varianten, auch nicht verfügbare
substanceDescriptionstring ≤ 16000immer, auch nullallgemeine Beschreibung des Wirkstoffs, deutsch

Gutschein

FeldTypVorhandenBedeutung
codestring ≤ 64immerGutscheincode; Code und Bedingungen so zeigen, wie sie kommen, ohne eigenen Satz daraus
discountTypepercent, fixedimmer, auch nullArt des Nachlasses
discountValuenumberimmer, auch nullHöhe des Nachlasses
newCustomerDiscountValuenumberimmer, auch nullNachlass nur für Neukunden des Shops, gilt nicht für discountValue
minOrderValuenumberimmer, auch nullMindestbestellwert
conditionsNotestring ≤ 500immer, auch nullBedingungen als Text

Katalogvariante

FeldTypVorhandenBedeutung
idstring ≤ 64immerKennung der Variante
titlestring ≤ 512immerName der Variante
positionintegerimmerReihenfolge im Shop
containerSizenumberimmer, auch nullPackungsgröße in containerUnit
containerUnitstring ≤ 64immer, auch nullEinheit der Packungsgröße
pricenumberimmer, auch nullPreis der Variante in currency des Produkts
basePriceGrundpreisoptionalGrundpreis der Variante
availablebooleanimmerlieferbar
imageUrlstring ≤ 4096immer, auch nullBild der Variante
servingSizeMinnumberimmer, auch nullkleinste Portionsgröße
servingSizeMaxnumberimmer, auch nullgrößte Portionsgröße
servingSizeUnitstring ≤ 128immer, auch nullEinheit der Portionsgröße
servingsPerContainerMinintegerimmer, auch nullkleinste Zahl der Portionen je Packung
servingsPerContainerMaxintegerimmer, auch nullgrößte Zahl der Portionen je Packung
flavorstring ≤ 256immer, auch nullGeschmack

get_goals

Eingabe

FeldTypPflichtBedeutung
languagede, enneinde oder en; ohne Angabe die Sprache des verknüpften Kontos, ohne Konto Deutsch

Antwort

FeldTypVorhandenBedeutung
goalsarray ≤ 200 von Zielimmerdie festen Ziele

Ziel

FeldTypVorhandenBedeutung
slugstring ≤ 64immerKennung, etwa sleep-relaxation; nur diese Werte gelten
labelstring ≤ 256immerName des Ziels, heute nur deutsch

start_consultation

Eingabe

FeldTypPflichtBedeutung
goalSlugsarray 1 bis 14 von string 1 bis 64neinKennungen aus get_goals; höchstens eines von goalSlugs und topic, ohne beide reicht message
topicstring 1 bis 128neinKennung aus list_topics; höchstens eines von goalSlugs und topic, ohne beide reicht message
eventDatestring, Muster ^\d{4}-\d{2}-\d{2}$neinDatum des Ereignisses als JJJJ-MM-TT, nur mit topic
messagestring ≤ 2000neinAnliegen in den Worten des Mitglieds, ohne Medikamente, Diagnosen oder andere Gesundheitsdaten; reicht allein für den Start
statedProfileObjektneinfeste Angaben, die das Mitglied schon gemacht hat; das Mitglied bestätigt sie auf einer Karte, bevor die Beratung beginnt, siehe Angaben beim Start
statedProfile.genderfemale, male, diverse, prefer_not_to_sayneinGeschlecht, Options-id wie im Formular zu den Körperwerten
statedProfile.ageRangeunder_18, 18_29, 30_44, 45_59, 60_plusneinAltersspanne, Options-id wie im Formular zu den Körperwerten
statedProfile.weightKgnumber größer 0neinGewicht in kg
statedProfile.heightCmnumber größer 0neinGröße in cm
statedProfile.dietarray 1 bis 4 aus vegan, vegetarian, gluten-free, lactose-freeneinErnährungsformen
statedProfile.formPreferencecapsule, powder, liquid, chewableneinbevorzugte Darreichungsform
statedProfile.sportPreferencesObjektneinVorlieben bei Sportnahrung, Options-ids wie im Formular sport_preferences
statedProfile.sportPreferences.proteinany, lactose_free, plant_onlyneinEiweißquelle
statedProfile.sportPreferences.textureany, creamy, clearneinKonsistenz
statedProfile.sportPreferences.sweetnessany, no_artificial, unsweetenedneinSüße
statedProfile.sportPreferences.formpowder_ok, capsule_tabletneinDarreichungsform
statedProfile.sportPreferences.caffeinewithout, withneinKoffein
statedProfile.sleepQualitygood, medium, poorneinwie das Mitglied schläft
statedProfile.stressLevellow, medium, highneinStress; bei getrennten Werten für Arbeit und Freizeit der höhere
statedProfile.workShiftnone, rotating, nightneinSchichtarbeit
statedProfile.existingSupplementsarray 1 bis 15 von string 1 bis 64neinNamen der Präparate, die das Mitglied schon nimmt; kommen zu den gespeicherten dazu; ein Name, der nach einem Medikament klingt, bleibt draußen
statedProfile.allergiesarray 1 bis 10 von string 1 bis 64neinNamen der Allergien; kommen zu den gespeicherten dazu; nur mit der Einwilligung des Mitglieds für Allergien
statedProfile.lifeStagepregnant, lactatingneinnur mit advisor:maternal: pregnant oder lactating; nur mit der Einwilligung des Mitglieds dafür
statedProfile.trimesterinteger 1 bis 3neinnur mit advisor:maternal und lifeStage: pregnant: Schwangerschaftsdrittel 1 bis 3
statedProfile.observedAtObjektneinje Angabe das Datum als JJJJ-MM-TT, Schlüssel ist der Name der Angabe; älter als 300 Tage steht sie auf der Karte als „bitte prüfen“

Antwort: Beratungszug

Beratungszug

FeldTypVorhandenBedeutung
conversationIdstring, nicht leerimmerKennung der Beratung, für alle weiteren Aufrufe
statusstring, nicht leerimmerStand des Gesprächs nach diesem Zug, etwa gathering_info, analyzing, plan_generated, refining_intake, refining oder completed
replyAntwort der Beratungimmerwas die Beratung sagt oder fragt
messageIdstringoptionalKennung dieser Antwort für rate_message; nur an Antworten, unter denen die App Daumen zeigt: Text ohne Antwortmöglichkeiten und ohne Formular
compliancearray von Pflichttextoptionaldie Pflichttexte dieses Zugs einzeln; sie stehen auch am Ende von reply.text; leer bei einer reinen Frage
ignoredarray ≤ 40 von ObjektoptionalAngaben, die Choicera nicht übernommen hat, je mit Grund; nie der Wert selbst
ignored[].fieldstring 1 bis 64immerName der Angabe
ignored[].reasonsender_not_allowed, scope_missing, consent_missing, medication_mention, user_edit_keptimmerscope_missing: Berechtigung fehlt; consent_missing: Einwilligung des Mitglieds fehlt; medication_mention: ein Name klingt nach einem Medikament; user_edit_kept: das Mitglied hat den Wert selbst gesetzt, er bleibt; sender_not_allowed: dieser Absender darf die Angabe nicht übergeben
adoptedarray ≤ 40 von Objektoptionaldie bestätigten Angaben samt Korrekturen, nach der Karte
adopted[].fieldstring 1 bis 64immerFeld-id der Karte
adopted[].valuearray ≤ 20 von string ≤ 64immerder bestätigte Wert wie auf der Karte: Options-ids, eine Zahl als Text oder Namen

Antwort der Beratung

FeldTypVorhandenBedeutung
typestring, nicht leerimmersiehe Antworttypen
textstringimmerText der Beratung; gehören Pflichttexte dazu, stehen sie am Ende; vollständig zeigen
optionsarray (mindestens 1) von OptionoptionalAntwortmöglichkeiten wie die Knöpfe in der App
multiSelectbooleanoptionaltrue: mehrere Optionen wählbar
freeTextbooleanoptionaltrue: freie Antwort statt Option möglich
formFormularoptionalbei den Formular-Typen, siehe Formulare
identifiedGoalsarray ≤ 20 von string 1 bis 128optionalnur bei ready_to_generate: Namen der Ziele, für die der Plan entsteht, wie get_goals sie nennt

Option

FeldTypVorhandenBedeutung
labelstring, nicht leerimmerwas das Mitglied sieht
valuestring, nicht leerimmerwas du mit send_message sendest

Formular

FeldTypVorhandenBedeutung
kinddemographics, medication, sport_preferences, handoverimmerals kind an answer_intake senden
titlestring, nicht leerimmerÜberschrift wie in der App
skipObjektimmer, auch nullKnopf zum Überspringen des ganzen Formulars
skip.labelstring, nicht leerimmerText des Knopfs
fieldsarray (mindestens 1) von Formularfeldimmerdie Felder in ihrer Reihenfolge

Formularfeld

FeldTypVorhandenBedeutung
idstring, nicht leerimmerName des Felds im Antwortblock
labelstring, nicht leerimmerFrage des Felds wie in der App
optionsarray von ObjektimmerAuswahl; leer, wenn das Feld nur eigene Worte nimmt
options[].idstring, nicht leerimmerKennung, die du an answer_intake sendest
options[].labelstring, nicht leerimmerwas das Mitglied sieht
multiSelectbooleanimmermehrere Optionen wählbar
optionalbooleanimmerdarf fehlen; dann nicht senden
presetarray von stringimmerschon Bekanntes: Options-ids oder Text; vorausgewählt zeigen
freeTextObjektimmer, auch nullFeld nimmt eigene Worte; anders als reply.freeText ein Objekt, kein boolean
freeText.labelstring, nicht leerimmerBeschriftung des Eingabefelds
freeText.maxLengthinteger größer 0immerhöchstens so viele Zeichen
showIfObjektimmer, auch nullFeld nur fragen, wenn die Bedingung gilt
showIf.fieldstring, nicht leerimmerFeld, dessen Antwort zählt
showIf.optionIdstring, nicht leerimmerOption, die dort gewählt sein muss
storedarray von stringoptional, auch nullnur auf der Karte handover: der gespeicherte Wert; null ohne
needsReviewbooleanoptionalnur auf der Karte handover: true, wenn der Wert veraltet sein kann
differsbooleanoptionalnur auf der Karte handover: true, wenn der Wert vom gespeicherten abweicht und ihn ersetzt
notestringoptionalnur auf der Karte handover: Hinweis der Karte zum Feld, etwa „bisher 80 kg“

send_message

Eingabe

FeldTypPflichtBedeutung
conversationIdstring 1 bis 64jaaus start_consultation oder list_consultations
messagestring 1 bis 5000javalue der gewählten Option oder die Worte des Mitglieds
onBehalftrueneintrue: die eigene KI des Mitglieds gibt weiter, was das Mitglied im Chat schon gesagt hat; nicht für die Karte und nicht für das Medikamenten-Formular, nie von Partnern

Antwort: Beratungszug

answer_intake

Eingabe

FeldTypPflichtBedeutung
conversationIdstring 1 bis 64jaaus start_consultation
kinddemographics, medication, sport_preferences, handoverjaaus reply.form.kind; medication nur mit advisor:medication
declinedtrueneinnur nach Wahl des Knopfs aus reply.form.skip, dann ohne Antwortblock
amendtrueneinnur mit kind: medication: Medikamenten-Antwort später ändern, auch nach dem Plan
demographicsObjektneinAntwortblock zu demographics: nur die beantworteten Felder
demographics.genderfemale, male, diverse, prefer_not_to_sayneinGeschlecht
demographics.ageBracketunder_18, 18_29, 30_44, 45_59, 60_plusneinAltersspanne
demographics.weightBracketunder_60, 60_75, 75_90, 90_plusneinGewichtsspanne in kg
demographics.heightBracketunder_160, 160_175, 175_190, 190_plusneinGrößenspanne in cm
medicationObjektneinAntwortblock zu medication; ersetzt die frühere Antwort ganz
medication.choicenone, medsjanone: keine Medikamente, meds: Medikamente
medication.drugClassesarray ≤ 6 aus pill_contraceptive, blood_thinner, thyroid_medication, antidepressant_ssri, antibiotic, otherneinMedikamentenklassen; bei meds mindestens eine Klasse oder ein Freitext
medication.freetextstring ≤ 200neineigene Worte, nur mit meds
sport_preferencesObjektneinAntwortblock zu sport_preferences
sport_preferences.proteinany, lactose_free, plant_onlyneinEiweißquelle
sport_preferences.textureany, creamy, clearneinKonsistenz
sport_preferences.sweetnessany, no_artificial, unsweetenedneinSüße
sport_preferences.formpowder_ok, capsule_tabletneinDarreichungsform
sport_preferences.caffeinewithout, withneinKoffein
handoverObjektneinAntwortblock zu handover, der Karte mit den Angaben beim Start
handover.confirmedtruejaimmer true: das Mitglied hat die Karte bestätigt
handover.changesObjektneindie Werte, die das Mitglied auf der Karte korrigiert hat, benannt wie statedProfile
handover.changes.genderfemale, male, diverse, prefer_not_to_sayneinGeschlecht, Options-id wie im Formular zu den Körperwerten
handover.changes.ageRangeunder_18, 18_29, 30_44, 45_59, 60_plusneinAltersspanne, Options-id wie im Formular zu den Körperwerten
handover.changes.weightKgnumber größer 0neinGewicht in kg
handover.changes.heightCmnumber größer 0neinGröße in cm
handover.changes.dietarray 1 bis 4 aus vegan, vegetarian, gluten-free, lactose-freeneinErnährungsformen
handover.changes.formPreferencecapsule, powder, liquid, chewableneinbevorzugte Darreichungsform
handover.changes.sportPreferencesObjektneinVorlieben bei Sportnahrung, Options-ids wie im Formular sport_preferences
handover.changes.sportPreferences.proteinany, lactose_free, plant_onlyneinEiweißquelle
handover.changes.sportPreferences.textureany, creamy, clearneinKonsistenz
handover.changes.sportPreferences.sweetnessany, no_artificial, unsweetenedneinSüße
handover.changes.sportPreferences.formpowder_ok, capsule_tabletneinDarreichungsform
handover.changes.sportPreferences.caffeinewithout, withneinKoffein
handover.changes.sleepQualitygood, medium, poorneinwie das Mitglied schläft
handover.changes.stressLevellow, medium, highneinStress; bei getrennten Werten für Arbeit und Freizeit der höhere
handover.changes.workShiftnone, rotating, nightneinSchichtarbeit
handover.changes.existingSupplementsarray 1 bis 15 von string 1 bis 64neinNamen der Präparate, die das Mitglied schon nimmt; kommen zu den gespeicherten dazu; ein Name, der nach einem Medikament klingt, bleibt draußen
handover.changes.allergiesarray 1 bis 10 von string 1 bis 64neinNamen der Allergien; kommen zu den gespeicherten dazu; nur mit der Einwilligung des Mitglieds für Allergien
handover.changes.lifeStagepregnant, lactatingneinnur mit advisor:maternal: pregnant oder lactating; nur mit der Einwilligung des Mitglieds dafür
handover.changes.trimesterinteger 1 bis 3neinnur mit advisor:maternal und lifeStage: pregnant: Schwangerschaftsdrittel 1 bis 3
handover.rejectedFieldsarray ≤ 32 von string 1 bis 64neinFeld-ids der Karte, die das Mitglied nicht übernehmen will
onBehalftrueneintrue: die Antworten hat das Mitglied im Chat schon gegeben, seine eigene KI gibt sie weiter; nicht für handover und medication, nie von Partnern

Antwort: Beratungszug

undo_last_answer

Eingabe

FeldTypPflichtBedeutung
conversationIdstring 1 bis 64jaaus start_consultation

Antwort: Beratungszug

get_plan

Eingabe

FeldTypPflichtBedeutung
conversationIdstring 1 bis 64jadie Beratung
jobIdstring 1 bis 64neinaus einer pending-Antwort, zum erneuten Abfragen
draftFeedbackarray ≤ 40 von Objektneinnach draft_review: Antwort je Zeile; eine leere Liste bestätigt den Entwurf unverändert
draftFeedback[].keystring 1 bis 80jakey aus draft.rows
draftFeedback[].feedbackalready_taking, preferred_form, do_not_want, not_takingjaAntwort zur Zeile, siehe Plan erzeugen
draftFeedback[].formcapsule, powder, liquid, chewableneinnur mit preferred_form
draftAddedarray ≤ 10 von string 1 bis 80neinnach draft_review: keys aller hinzuzufügenden Wirkstoffe, auch der behaltenen aus draft.added; fehlt es, bleibt draft.added
reopenDrafttrueneinnur bei refining_intake: öffnet den Entwurf erneut

Antwort

FeldTypVorhandenBedeutung
conversationIdstring, nicht leerimmerKennung der Beratung
statuscompleted, pending, regenerating, no_plan, failed, draft_review, plan_generated, refining_intake, intake_openimmersiehe Plan erzeugen
planPlanoptionalbei draft_review, refining_intake, plan_generated, completed
draftEntwurfoptionalbei draft_review
replyAntwort der Beratungoptionalbei intake_open und refining_intake
jobIdstring, nicht leeroptionalbei pending, manchmal bei failed
reasonstring, nicht leeroptionalbei pending und failed
retryAfterSecondsinteger größer 0optionalbei pending: so lange warten
disclosurestringoptionalPflichttexte zum Plan als ein Text; vollständig mit dem Plan zeigen
compliancearray von Pflichttextoptionaldieselben Pflichttexte einzeln

Plan

FeldTypVorhandenBedeutung
planIdstring, nicht leerimmerKennung des Plans, für die Werkzeuge mit planId
degradedbooleanoptionaltrue: vorsichtige Grundempfehlung statt persönlichem Plan
phasesarray von Objektimmerdie Phasen in ihrer Reihenfolge
phases[].phaseNumberintegerimmerNummer der Phase
phases[].namestring ≤ 300optionalName der Phase wie in der App; fehlt, wenn der Text zurückgehalten wird
phases[].descriptionstring ≤ 2000optionalwofür die Phase steht, wie in der App; fehlt, wenn der Text zurückgehalten wird
phases[].itemsarray von ObjektimmerPlanpunkte der Phase
phases[].items[].supplementNamestring, nicht leerimmerWirkstoff
phases[].items[].dosagestringimmerMenge, etwa 300 mg
phases[].items[].tierbasic, plusoptionalbasic: Basis des Plans; plus: optionale Ergänzung
phases[].items[].frequencydaily, twice_dailyoptionalwie oft am Tag die Menge genommen wird: daily einmal, twice_daily zweimal
phases[].items[].prioritybooleanoptionaltrue: einer der drei wichtigsten Wirkstoffe (Stern)
phases[].items[].rolestring ≤ 300optionalSatz der App zur Rolle des Wirkstoffs im Plan
phases[].items[].timingstring ≤ 300optionalEinnahmezeit in den Worten der App
phases[].items[].descriptionstring ≤ 2000optionalwofür der Wirkstoff im Plan steht, geprüfter Text der App; fehlt, wenn der Text zurückgehalten wird
phases[].items[].traditionalbooleanoptionaltrue: für den Wirkstoff liegt keine zugelassene gesundheitsbezogene Angabe vor; dann traditionalNote mit zeigen
phases[].items[].traditionalNotestring ≤ 300optionalbei traditional: der Satz der App dazu
phases[].items[].consultNoticestring ≤ 300optionalPflichttext F11: vor der Einnahme mit Arzt oder Apotheke sprechen; mit dem Wirkstoff zeigen
footerDisclosurestring ≤ 2000optionalHinweis unter dem Plan, wenn ein Wirkstoff keine zugelassene gesundheitsbezogene Angabe hat, wie in der App
approximateDosingstring ≤ 2000optionalnur, wenn der Plan ohne Alter, Geschlecht, Gewicht oder Größe entstand: die Mengen sind allgemein
allergyNotCheckedstring ≤ 2000optionalnur, wenn das Mitglied eine Allergie genannt hat, die Choicera nicht kennt: sie ließ sich bei den Produkten nicht prüfen
legendstring ≤ 300optionalerklärt den Stern; die App zeigt den Text nach „★ “

Entwurf

FeldTypVorhandenBedeutung
rowsarray von Entwurfszeileimmerdie Wirkstoffe zum Beantworten
addedarray von Wirkstoff zum Hinzufügenimmerfrüher hinzugefügte Wirkstoffe
addLimitinteger ab 0immerwie viele Wirkstoffe insgesamt hinzugefügt werden dürfen
degradedbooleanimmertrue: vorsichtige Grundempfehlung; beantworten geht wie sonst
feedbackarray aus already_taking, preferred_form, do_not_want, not_takingimmererlaubte Antworten
formsarray aus capsule, powder, liquid, chewableimmerwählbare Darreichungsformen
labelsObjektimmerTexte der App für die Antworten zum Entwurf
labels.takingstring, nicht leerimmerText für already_taking
labels.omitstring, nicht leerimmerText für do_not_want
labels.preferredFormstring, nicht leerimmerText für preferred_form
labels.formsObjektimmerNamen der Darreichungsformen
labels.forms.capsulestring, nicht leerimmerName für capsule
labels.forms.powderstring, nicht leerimmerName für powder
labels.forms.liquidstring, nicht leerimmerName für liquid
labels.forms.chewablestring, nicht leerimmerName für chewable
labels.formHintstring, nicht leerimmerHinweis zur Wahl der Form
labels.addstring, nicht leerimmerText des Knopfs zum Hinzufügen
labels.confirmstring, nicht leerimmerText des Knopfs zum Bestätigen

Entwurfszeile

FeldTypVorhandenBedeutung
keystring, nicht leerimmerKennung für draftFeedback
namestring, nicht leerimmerName des Wirkstoffs
dosagestringimmerMenge
timingstringimmerEinnahmezeit als Schlüssel, etwa evening
tierstringimmerbasic (Basis) oder plus
prioritybooleanimmertrue: einer der drei wichtigsten Wirkstoffe (Stern)
descriptionstringimmerwofür der Wirkstoff im Plan steht, Text der App
alreadyTakingbooleanimmerals „nehme ich schon“ markiert
preferredFormcapsule, powder, liquid, chewableimmer, auch nullfrüher gewählte Form
doNotWantbooleanimmerdurch eine frühere Antwort aus dem Plan genommen

Wirkstoff zum Hinzufügen

FeldTypVorhandenBedeutung
keystring, nicht leerimmerKennung für draftAdded
namestring, nicht leerimmerName des Wirkstoffs
dosagestringimmerMenge
timingstringimmerEinnahmezeit als Schlüssel

search_substances

Eingabe

FeldTypPflichtBedeutung
conversationIdstring 1 bis 64neinim Entwurf: die Beratung mit dem Entwurf; genau eines von conversationId und planId
planIdstring 1 bis 64neinam fertigen Plan: planId aus get_plan, braucht checkout:personalized; genau eines von conversationId und planId
querystring ≤ 80jaName oder Teil des Namens; leer für Vorschläge

Antwort

FeldTypVorhandenBedeutung
conversationIdstring, nicht leeroptionalbei der Suche zum Entwurf: Kennung der Beratung
planIdstring 1 bis 64optionalbei der Suche zum fertigen Plan: Kennung des Plans
querystringimmerdie Suche
optionsarray ≤ 100 von Objektimmerpassende Wirkstoffe, zuerst die Vorschläge
options[].keystring 1 bis 80immerKennung für draftAdded im Entwurf oder für add_substance am fertigen Plan
options[].namestring ≤ 256immerName des Wirkstoffs
options[].dosagestringoptionalMenge; nur im Entwurf
options[].timingstringoptionalEinnahmezeit als Schlüssel; nur im Entwurf
options[].stateavailable, inPlan, blocked, noProductsoptionalnur am fertigen Plan: available lässt sich mit add_substance hinzufügen, inPlan steht schon im Plan, blocked lässt sich nicht hinzufügen, noProducts steckt in keinem Produkt der gewählten Marken
options[].blockedReasonstring ≤ 500optional, auch nullbei blocked: der Grund als Text der App
moreCountinteger ab 0optionalnur am fertigen Plan: weitere Wirkstoffe, die sich über den Namen finden lassen

get_plan_products

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
includearray ≤ 1 aus trustneintrust: dazu die festen Texte „Was wir prüfen“ und „So wählen wir die Sets“ der Planseite

Antwort: Produkte zum Plan

Produkte zum Plan

FeldTypVorhandenBedeutung
planIdstring 1 bis 64immerKennung des Plans
statusok, plan_not_finalimmerplan_not_final: Entwurf, positions ist leer
positionsarray ≤ 64 von Positionimmerje Planpunkt
setsSetsoptionaldie zwei fertigen Sets der Planseite; als Auswahl anbieten, erst nach der Wahl des Mitglieds mit fill_cart_with_set in den Warenkorb
brandsarray ≤ 200 von Marke im Planoptionaldie Marken des Plans; Auswahl ändern mit set_brand_scope
brandsEditablebooleanoptionalfalse: die Marken sind durch einen Link festgelegt und lassen sich nicht ändern
shippingCountryDE, AToptionalVersandland, für das Preise der Sets und Summe des Warenkorbs gelten
cartWarenkorboptional, auch nullwas der Warenkorb des Plans jetzt enthält; null, solange er leer ist und nie gefüllt wurde
shippingCountrySourceaccount, defaultoptionalaccount: das Mitglied hat das Versandland gesetzt; default: keines gesetzt, die Preise gelten für Deutschland
trustTexte der Planseite zu Prüfung und Setsoptionalnur mit include trust: die festen Texte der Planseite
compliancearray von PflichttextoptionalPflichttexte einzeln: F4 und F5, ohne Freigaben F10, F6 zu den Werbelinks und F11 zur Rücksprache mit Arzt oder Apotheke

Position

FeldTypVorhandenBedeutung
positionIdstring 1 bis 128immerKennung des Planpunkts für add_to_cart
supplementNamestring ≤ 256immerWirkstoff
dosagestring ≤ 512immerMenge
tierstring ≤ 16immerbasic oder plus
productsarray ≤ 12 von Planproduktimmerpassende zuerst, heute höchstens 8
moreOnPlanPageinteger ab 0immerweitere Produkte, die nur auf der Planseite stehen
prioritybooleanoptionaltrue: einer der drei wichtigsten Wirkstoffe (Stern)
rolestring ≤ 300optionalSatz der App zur Rolle des Wirkstoffs im Plan
timingstring ≤ 300optionalEinnahmezeit in den Worten der App
descriptionstring ≤ 2000optionalwofür der Wirkstoff im Plan steht, geprüfter Text der App; fehlt, wenn der Text zurückgehalten wird
traditionalbooleanoptionaltrue: für den Wirkstoff liegt keine zugelassene gesundheitsbezogene Angabe vor; dann traditionalNote mit zeigen
traditionalNotestring ≤ 300optionalbei traditional: der Satz der App dazu
consultNoticestring ≤ 300optionalPflichttext F11: vor der Einnahme mit Arzt oder Apotheke sprechen; mit dem Wirkstoff zeigen
userAddedbooleanoptionaltrue: das Mitglied hat den Wirkstoff hinzugefügt; remove_substance nimmt ihn wieder heraus
alreadyTakingstring ≤ 300optionalnur, wenn das Mitglied ihn schon nimmt: der Satz der App
preferredFormstring ≤ 300optionalnur, wenn das Mitglied eine Darreichungsform bevorzugt: der Satz der App
gapReasonstring ≤ 2000optionalnur, wenn kein Produkt steht: der Grund wie in der App
partnerRecommendationstring ≤ 2000optionalnur, wenn der Partner, über den das Mitglied kam, dafür ein Produkt außerhalb von Choicera empfiehlt: der Satz der App

Sets

FeldTypVorhandenBedeutung
cheapSet „Günstig“immerSet „Günstig“: niedrigster Gesamtpreis mit Versand
valueSetimmerSet „Empfohlen“: das empfohlene Produkt je Wirkstoff

Marke im Plan

FeldTypVorhandenBedeutung
brandIdstring 1 bis 64immerKennung der Marke für set_brand_scope
namestring ≤ 256immerName der Marke
selectedbooleanimmerfalse: das Mitglied hat die Marke abgewählt, ihre Produkte fehlen im Plan
disclosurestring ≤ 500optionalvollständiger Werbehinweis zu Links dieser Marke; mit ihren Produkten zeigen

Warenkorb

FeldTypVorhandenBedeutung
linesarray ≤ 200 von Warenkorbzeileimmerdie Zeilen des Warenkorbs
moreOnPlanPageinteger ab 0immerweitere Zeilen, die nur die Planseite zeigt
itemCountinteger ab 0immerZahl der Packungen
totalnumberimmerSumme
currencystring ≤ 16immerWährung
setcheap, valueimmer, auch nullwelches Set unverändert im Warenkorb liegt; null bei eigener Auswahl oder geändertem Set
starOnlybooleanoptionaltrue: der Warenkorb enthält nur die drei wichtigsten Wirkstoffe des eingelegten Sets
shopsarray ≤ 64 von Kosten je ShopoptionalKosten je Shop wie im Warenkorb der Planseite
discountTotalnumberoptionalSumme der Nachlässe
shippingUnknownbooleanoptionaltrue: mindestens ein Shop nennt keine Versandkosten; es gilt der Preis des Shops
priceNotestring ≤ 300optionalHinweis der App zu den Preisen

Texte der Planseite zu Prüfung und Sets

FeldTypVorhandenBedeutung
checksObjektimmerText „Was wir prüfen“
checks.titlestring ≤ 300immerÜberschrift
checks.sectionsarray ≤ 6 von TextabschnittimmerAbschnitte
checks.closingstring ≤ 300immerSchlusssatz
setsObjektimmerText „So wählen wir die Sets“
sets.titlestring ≤ 300immerÜberschrift
sets.sectionsarray ≤ 6 von TextabschnittimmerAbschnitte
sets.footerstring ≤ 300immerSatz unter den Abschnitten

Planprodukt

FeldTypVorhandenBedeutung
productIdstring 1 bis 64immerProdukt-Kennung für add_to_cart
brandstring ≤ 256immerName der Marke
titlestring ≤ 512immerProduktname
defaultVariantIdstring 1 bis 128immervorgeschlagene Variante
variantsarray 1 bis 32 von Planvarianteimmernur lieferbare Varianten
badgesarray ≤ 4 von string ≤ 32immerheute cheapest oder recommended; leer bei weniger passenden
lessFittingbooleanimmertrue: passt weniger gut
needsConfirmationbooleanimmertrue: nur nach ausdrücklicher Bestätigung des Warnhinweises in den Warenkorb
warningsarray ≤ 16 von Objektimmermit dem Produkt zeigen
warnings[].codestring 1 bis 64immerKennung des Hinweises
warnings[].levelhint, warnimmerStufe des Hinweises
warnings[].textstring 1 bis 500immerText des Hinweises
alternativeForstring ≤ 256immer, auch nullWirkstoff, für den das Produkt als Ausweichprodukt dasteht
alsoCoversarray ≤ 16 von string ≤ 256immerweitere Wirkstoffe des Plans, die das Produkt abdeckt
formFactorstring ≤ 64optional, auch nullDarreichungsform laut Marke, etwa capsule
dietCompatibilityarray ≤ 16 von string ≤ 64optionalErnährungsformen laut Marke, etwa vegan
originstring ≤ 256optional, auch nullHerstellungsort laut Marke
fitfull, near, lowoptionalwie gut eine Portion die Menge deckt: full, near (knapp darunter) oder low
servingsPerDayinteger größer 0optionalPortionen am Tag für die Menge des Plans
fitTextstring ≤ 300optionalSatz der App zur Passung
monthlyTextstring ≤ 300optionalMonatspreis der vorgeschlagenen Variante wie in der App
alternativeTextstring ≤ 300optionalnur bei einer anderen Form des Wirkstoffs: der Satz der App
caffeineTextstring ≤ 300optionalnur, wenn das Produkt Koffein enthält: der Satz der App
recommendedBystring ≤ 300optionalnur, wenn der Partner, über den das Mitglied kam, das Produkt empfiehlt
adLabelstring ≤ 64optionalKennzeichnung der App neben einem Produkt, an dem Choicera eine Provision verdienen kann; der volle Hinweis steht in brands[].disclosure

Set „Günstig“

Alle Felder von Set, dazu:

FeldTypVorhandenBedeutung
sameAsValuebooleanimmertrue: dieselben Produkte wie im Set „Empfohlen“; dann nur „Empfohlen“ anbieten

Set

FeldTypVorhandenBedeutung
labelstring 1 bis 64immerName des Sets auf der Planseite
descriptionstring 1 bis 256immerwie die Planseite das Set wählt, Text der App
linesarray ≤ 64 von Setzeileimmerje ein Produkt für jeden Basis-Wirkstoff und jeden selbst hinzugefügten Wirkstoff; Plus-Wirkstoffe gehören nicht dazu
totalnumberimmer, auch nullPreis des Sets mit Versand und Rabatten der Marken, wie die Planseite ihn zeigt; null ohne Zeilen
currencystring ≤ 16immer, auch nullWährung
starOnlyObjektoptionalnur die drei wichtigsten und die selbst hinzugefügten Wirkstoffe aus diesem Set, wie der Schalter der Planseite; mit starOnly an fill_cart_with_set
starOnly.linesarray ≤ 64 von Objektimmerdie Zeilen
starOnly.lines[].positionIdstring 1 bis 128immerPlanpunkt
starOnly.lines[].productIdstring 1 bis 64immerProdukt
starOnly.lines[].variantIdstring 1 bis 128immerVariante
starOnly.totalnumberimmer, auch nullPreis wie auf der Planseite; null ohne Zeilen
starOnly.currencystring ≤ 16immer, auch nullWährung

Warenkorbzeile

FeldTypVorhandenBedeutung
positionIdstring 1 bis 128immerPlanpunkt
productIdstring 1 bis 64immerProdukt
variantIdstring 1 bis 128immerVariante
lineIdstring 1 bis 64immerKennung der Zeile für update_cart_line
brandstring ≤ 256immerName der Marke
titlestring ≤ 512immerProduktname
variantTitlestring ≤ 512immer, auch nullName der Variante
quantityinteger größer 0immerZahl der Packungen
unitPricenumberimmerPreis je Packung

Kosten je Shop

FeldTypVorhandenBedeutung
brandIdstring 1 bis 64immerKennung der Marke
brandstring ≤ 256immerName der Marke
itemCountinteger ab 0immerZahl der Packungen
subtotalnumberimmerZwischensumme
discountnumberimmer, auch nullNachlass durch das Angebot der Marke; null ohne Angebot
discountTextstring ≤ 300immer, auch nulldas Angebot in den Worten der App; null ohne Angebot
shippingnumberimmer, auch nullVersandkosten; null, wenn der Shop keine nennt
shippingTextstring ≤ 300immerVersandkosten in den Worten der App
freeShippingTextstring ≤ 300immer, auch nullwie weit der Warenkorb vom kostenlosen Versand entfernt ist
totalnumberimmerSumme des Shops

Textabschnitt

FeldTypVorhandenBedeutung
titlestring ≤ 300immerÜberschrift des Abschnitts
linesarray ≤ 12 von string ≤ 300immerZeilen des Abschnitts

Planvariante

FeldTypVorhandenBedeutung
variantIdstring 1 bis 128immerVarianten-Kennung für add_to_cart
titlestring ≤ 512immerName der Variante
flavorstring ≤ 256immer, auch nullGeschmack; null, wenn das Produkt keinen hat
containerSizenumberimmer, auch nullPackungsgröße in containerUnit; null, wenn der Shop keine nennt; nie schätzen
containerUnitstring ≤ 32immer, auch nullEinheit der Packungsgröße
pricenumberimmer, auch nullPreis
currencystring ≤ 16immerWährung
monthlyPricenumberoptional, auch nullMonatspreis der Variante bei der Menge des Plans
basePriceGrundpreisoptionalGrundpreis; im selben Satz wie den Preis zeigen

Setzeile

FeldTypVorhandenBedeutung
positionIdstring 1 bis 128immerPlanpunkt
productIdstring 1 bis 64immerProdukt
variantIdstring 1 bis 128immerVariante
brandstring ≤ 256immerName der Marke
titlestring ≤ 512immerProduktname
pricenumberimmer, auch nullPreis

add_to_cart

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
itemsarray 1 bis 20 von Objektjadie Produkte, die das Mitglied gewählt hat
items[].positionIdstring 1 bis 128jaaus get_plan_products
items[].productIdstring 1 bis 64jaaus get_plan_products
items[].variantIdstring 1 bis 128jaaus get_plan_products
items[].quantityinteger 1 bis 20neinZahl der Packungen, Standard 1
items[].confirmWarningbooleanneinnur nach ausdrücklicher Bestätigung des Warnhinweises im Chat

Antwort

FeldTypVorhandenBedeutung
planIdstring 1 bis 64immerKennung des Plans
statusok, plan_not_finalimmerStand des Plans wie bei get_plan_products
addedarray ≤ 20 von Objektimmerhinzugefügt
added[].positionIdstring 1 bis 128immerPlanpunkt
added[].productIdstring 1 bis 64immerProdukt
added[].variantIdstring 1 bis 128immerVariante
added[].quantityinteger größer 0immerZahl der Packungen
added[].lineIdstring 1 bis 64optionalKennung der Zeile für update_cart_line
needsConfirmationarray ≤ 20 von Objektimmernicht hinzugefügt: der Warnhinweis braucht die Bestätigung des Mitglieds
needsConfirmation[].positionIdstring 1 bis 128immerPlanpunkt
needsConfirmation[].productIdstring 1 bis 64immerProdukt
needsConfirmation[].variantIdstring 1 bis 128immerVariante
needsConfirmation[].reasonCodesarray ≤ 16 von string ≤ 64immerGründe als Kennungen
rejectedarray ≤ 20 von Objektimmernicht hinzugefügt
rejected[].positionIdstring 1 bis 128immerPlanpunkt
rejected[].productIdstring 1 bis 64immerProdukt
rejected[].variantIdstring 1 bis 128immerVariante
rejected[].reasonstring 1 bis 64immerGrund, etwa not_in_offer, rate_limited, upstream_error
cartWarenkorbsummeimmer, auch nullStand des Warenkorbs

Warenkorbsumme

FeldTypVorhandenBedeutung
itemCountinteger ab 0immerZahl der Packungen
totalnumberimmerSumme
currencystring ≤ 16immerWährung

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64neinKennung des Plans; genau eines von planId und productId
productIdstring 1 bis 64neinProdukt-Kennung aus dem Katalog; genau eines von planId und productId

Antwort

FeldTypVorhandenBedeutung
modepersonalized, catalogimmerpersonalized mit planId, catalog mit productId
linksarray von Linkimmermit planId genau ein Link, in die Kasse oder zur Planseite (siehe target); mit productId die Links in den Shop der Marke
reasoncatalog_links_emptyoptionalcatalog_links_empty: der Shop der Marke bietet für das Produkt gerade keinen Link; links ist dann leer
targetcheckout, plan_pageoptionalnur mit planId: checkout, wenn alle Verkäufer des Warenkorbs an der Kasse von Choicera bezahlt werden; der Link öffnet dann die Kasse bei „Bestellung prüfen“, ohne Adresse aus einer früheren Bestellung zuerst bei der Adresse; sonst plan_page
orderWarenkorb zum Bestellenoptionalnur mit planId: der Warenkorb, wie er bestellt würde; fehlt bei leerem Warenkorb und bei einem Entwurf
compliancearray von PflichttextoptionalF6 je Link, dazu F7 (Gutschein) und F8 (Preis), wenn sie dazugehören
FeldTypVorhandenBedeutung
brandstringimmer, auch nullName der Marke; null beim Link zur Planseite oder in die Kasse
brandSlugstringimmer, auch nullKennung der Marke
urlstring, nicht leerimmerdie Adresse; unverändert weitergeben
noticestringimmer, auch nullHinweis des Shops
displaystring, nicht leeroptionalLink mit Pflichttexten, fertig zum Anzeigen; zeige ihn statt url

Warenkorb zum Bestellen

FeldTypVorhandenBedeutung
linesarray ≤ 200 von Zeile zum Bestellenimmerdie Zeilen des Warenkorbs
hiddenLinesinteger ab 0immerweitere Zeilen, die diese Verbindung nicht nennt, weil ihr Warnhinweis Medikamente, Schwangerschaft oder Stillzeit betrifft; die verlinkte Seite zeigt sie
sellersarray ≤ 64 von Verkäufer im Warenkorbimmerje Verkäufer ein Eintrag mit Zahlweg und Kosten
shippingnumberimmer, auch nullVersand aller Verkäufer zusammen; null, wenn ein Verkäufer keine Versandkosten nennt
totalnumberimmerGesamtpreis mit den Nachlässen der Marken und Versand
currencystring ≤ 16immerWährung
priceNotestring ≤ 300immerHinweis der App zu den Preisen, wie ihr Warenkorb ihn neben der Summe zeigt

Zeile zum Bestellen

FeldTypVorhandenBedeutung
brandstring ≤ 256immerName der Marke
titlestring ≤ 512immerProduktname
variantTitlestring ≤ 512immer, auch nullName der Variante
quantityinteger größer 0immerZahl der Packungen
unitPricenumberimmerPreis je Packung
basePriceGrundpreisoptionalGrundpreis; im selben Satz wie den Preis zeigen; fehlt, wenn der Shop keine Füllmenge nennt

Verkäufer im Warenkorb

FeldTypVorhandenBedeutung
brandIdstring 1 bis 64immerKennung der Marke
sellerstring ≤ 256immerName der Marke, die verkauft und versendet
paymentPathshop, checkoutimmercheckout: bezahlt an der Kasse von Choicera; shop: bestellt und bezahlt im Shop der Marke
itemCountinteger ab 0immerZahl der Packungen
subtotalnumberimmerZwischensumme
discountnumberimmer, auch nullNachlass durch das Angebot der Marke; null ohne Angebot
shippingnumberimmer, auch nullVersandkosten; null, wenn der Verkäufer keine nennt
totalnumberimmerSumme des Verkäufers

fill_cart_with_set

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
setcheap, valuejadas Set, das das Mitglied gewählt hat
starOnlytrueneintrue: nur die drei wichtigsten und die selbst hinzugefügten Wirkstoffe, aus sets.<set>.starOnly

Antwort

FeldTypVorhandenBedeutung
planIdstring 1 bis 64immerKennung des Plans
setcheap, valueimmerdas eingelegte Set
starOnlybooleanoptionaltrue: nur die drei wichtigsten und die selbst hinzugefügten Wirkstoffe sind eingelegt
placedarray ≤ 64 von Objektimmerdie Produkte des Sets, jetzt im Warenkorb; sonst liegt nichts darin
placed[].positionIdstring 1 bis 128immerPlanpunkt
placed[].productIdstring 1 bis 64immerProdukt
placed[].variantIdstring 1 bis 128immerVariante
placed[].brandstring ≤ 256immerName der Marke
placed[].titlestring ≤ 512immerProduktname
placed[].pricenumberimmer, auch nullPreis
placed[].lineIdstring 1 bis 64optionalKennung der Zeile für update_cart_line
cartWarenkorbsummeimmer, auch nullStand des Warenkorbs

update_cart_line

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
lineIdstring 1 bis 64jalineId der Zeile aus cart.lines oder added
quantityinteger 0 bis 20jagewünschte Zahl der Packungen; 0 nimmt das Produkt aus dem Warenkorb

Antwort

FeldTypVorhandenBedeutung
planIdstring 1 bis 64immerKennung des Plans
lineIdstring 1 bis 64immerKennung der Zeile
quantityinteger ab 0immerZahl der Packungen jetzt; 0: die Zeile ist entfernt
cartWarenkorbsummeimmer, auch nullStand des Warenkorbs

add_substance

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
keystring 1 bis 80jakey einer Option mit state: available aus search_substances mit planId

Antwort: Produkte zum Plan mit neuem Wirkstoff

Produkte zum Plan mit neuem Wirkstoff

Alle Felder von Produkte zum Plan, dazu:

FeldTypVorhandenBedeutung
positionIdstring 1 bis 128immerPlanpunkt des neu hinzugefügten Wirkstoffs

set_brand_scope

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
deselectedBrandIdsarray ≤ 100 von string 1 bis 64jaalle brandIds, die das Mitglied nicht will, auch früher abgewählte; eine leere Liste wählt alle Marken wieder

Antwort: Produkte zum Plan

remove_substance

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
positionIdstring 1 bis 128japositionId eines Wirkstoffs mit userAdded: true aus get_plan_products

Antwort: Produkte zum Plan ohne den Wirkstoff

Produkte zum Plan ohne den Wirkstoff

Alle Felder von Produkte zum Plan, dazu:

FeldTypVorhandenBedeutung
removedPositionIdstring 1 bis 128immerPlanpunkt des herausgenommenen Wirkstoffs

set_shipping_country

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
countryDE, ATjaLand, in das das Mitglied liefern lassen will

Antwort: Produkte zum Plan nach neuem Versandland

Produkte zum Plan nach neuem Versandland

Alle Felder von Produkte zum Plan, dazu:

FeldTypVorhandenBedeutung
recomposedbooleanimmertrue: im Warenkorb lag das Set „Günstig“; es ist für das neue Land neu zusammengestellt, wie auf der Planseite

get_position_products

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId aus get_plan
positionIdstring 1 bis 128japositionId aus get_plan_products
sortrecommended, priceneinrecommended (Standard) wie auf der Planseite oder price
formcapsule, tablet, powder, liquid, sachetneinnur Produkte in dieser Darreichungsform
dietvegan, vegetarian, organic, gluten-free, lactose-free, sugar-freeneinnur Produkte, die laut Marke zu dieser Ernährungsform passen
widetrueneinnur bei einem Wirkstoff mit gapReason und brandsEditable: true: in allen Marken suchen, wie die Planseite

Antwort

FeldTypVorhandenBedeutung
planIdstring 1 bis 64immerKennung des Plans
positionIdstring 1 bis 128immerPlanpunkt
supplementNamestring ≤ 256immerWirkstoff
widebooleanimmertrue: die Produkte kommen aus allen Marken, nicht nur aus denen des Plans
productsarray ≤ 30 von Planproduktimmerdie Produkte des Planpunkts
moreOnPlanPageinteger ab 0immerweitere passende Produkte, die nur auf der Planseite stehen
compliancearray von PflichttextoptionalPflichttexte einzeln

rate_plan

Eingabe

FeldTypPflichtBedeutung
planIdstring 1 bis 64japlanId des fertigen Plans aus get_plan
starsinteger 1 bis 5jadie Sterne, die das Mitglied vergibt, 1 bis 5
reasonCodesarray ≤ 4 aus not_for_me, too_many_products, too_expensive, otherneinnur bei 1 bis 3 Sternen: die Gründe, die das Mitglied aus der Liste der App wählt, not_for_me, too_many_products, too_expensive, other
commentstring ≤ 500neinwas das Mitglied zum Plan schreibt, in seinen Worten; Medikamente nur mit advisor:medication, Schwangerschaft und Stillzeit nur mit advisor:maternal

Antwort

FeldTypVorhandenBedeutung
planIdstring, nicht leerimmerKennung des Plans
starsinteger 1 bis 5immerdie gespeicherten Sterne

rate_message

Eingabe

FeldTypPflichtBedeutung
messageIdstringjamessageId der Antwort aus start_consultation, send_message oder answer_intake
ratingup, down, nonejaup oder down; none nimmt den Daumen des Mitglieds zurück

Antwort

FeldTypVorhandenBedeutung
messageIdstring, nicht leerimmerKennung der Antwort
ratingup, down, noneimmerder gespeicherte Daumen; none: kein Daumen gespeichert

list_consultations

Eingabe: keine.

Antwort

FeldTypVorhandenBedeutung
consultationsarray ≤ 20 von Beratungimmereigene Beratungen, neueste zuerst, höchstens 20; Beratungen mit Inhalten, die diese Verbindung nicht sehen darf, fehlen ganz

Beratung

FeldTypVorhandenBedeutung
conversationIdstring 1 bis 64immerKennung der Beratung, für get_consultation, send_message und get_plan
startedAtstringimmerBeginn als ISO-Zeitpunkt
lastActivityAtstringimmerletzte Nachricht des Mitglieds oder der Beratung als ISO-Zeitpunkt
statusgathering_info, analyzing, plan_generated, refining_intake, refining, completedimmerStand des Gesprächs: gathering_info, analyzing (der Plan entsteht), plan_generated, refining_intake, refining oder completed
goalsarray ≤ 20 von ObjektimmerZiele der Beratung
goals[].slugstring 1 bis 64immerKennung wie in get_goals
goals[].namestring 1 bis 120immerName des Ziels in der Sprache der Antwort
topicObjektimmer, auch nullThema, mit dem die Beratung begann; null ohne Thema
topic.slugstring 1 bis 128immerKennung wie in list_topics
topic.namestring 1 bis 200immerName des Themas in der Sprache der Antwort
hasPlanbooleanimmertrue: zur Beratung gibt es einen Plan
channelagent, appimmeragent: über eine KI begonnen, app: in der App begonnen
resumablebooleanimmertrue: geht hier weiter; dieselben Beratungen, die die App zum Weitermachen anbietet
resumeHintcontinue_in_appoptionalcontinue_in_app: das Mitglied findet die Beratung in der App; sie geht hier nicht weiter

get_consultation

Eingabe

FeldTypPflichtBedeutung
conversationIdstring 1 bis 64jaaus list_consultations oder start_consultation

Antwort: Beratung mit offener Frage

Beratung mit offener Frage

Alle Felder von Beratung, dazu:

FeldTypVorhandenBedeutung
planIdstring 1 bis 64optionalKennung des Plans, für get_plan_products und get_checkout_link; fehlt ohne Plan
replyAntwort der Beratungoptionaloffene Frage oder letzte Antwort der Beratung wie bei send_message; ready_to_generate auch bei offenem Entwurf; fehlt, wenn hier nichts weiterzugeben ist
compliancearray von Pflichttextoptionaldie Pflichttexte einzeln; sie stehen auch am Ende von reply.text

get_profile

Eingabe: keine.

Antwort

FeldTypVorhandenBedeutung
profileVersionstring 1 bis 64immer, auch nullStand der gespeicherten Angaben, für confirm_profile; null, wenn nichts gespeichert ist
demographicsObjektimmerKörperwerte wie in der App
demographics.genderstring ≤ 32immer, auch nullGeschlecht; null ohne Angabe
demographics.ageRangestring ≤ 32immer, auch nullAltersspanne; null ohne Angabe
demographics.weightKgnumber größer 0immer, auch nullGewicht in kg; null ohne Angabe
demographics.heightCmnumber größer 0immer, auch nullGröße in cm; null ohne Angabe
demographics.confirmedAtstringimmer, auch nullletzte Bestätigung durch das Mitglied als ISO-Zeitpunkt; null, wenn nie bestätigt
demographics.daysSinceConfirmedintegerimmer, auch nullTage seit der letzten Bestätigung; null, wenn nie bestätigt
demographics.isStalebooleanimmertrue ab 300 Tagen oder ohne Bestätigung: die App würde fragen, ob die Angaben noch stimmen
dietarray ≤ 20 von string 1 bis 64immerangegebene Ernährungsformen, etwa vegan
allergiesarray ≤ 30 von string 1 bis 64immerangegebene Allergien
existingSupplementsstring ≤ 2000immer, auch nullPräparate, die das Mitglied schon nimmt; null ohne Angabe
formPreferencestring ≤ 64immer, auch nullbevorzugte Darreichungsform; null ohne Angabe
sportPreferencesObjektimmerAntworten aus dem Formular zur Sportnahrung; leer ohne Antworten
sportPreferences.proteinany, lactose_free, plant_onlyoptionalEiweißquelle
sportPreferences.textureany, creamy, clearoptionalKonsistenz
sportPreferences.sweetnessany, no_artificial, unsweetenedoptionalSüße
sportPreferences.formpowder_ok, capsule_tabletoptionalDarreichungsform
sportPreferences.caffeinewithout, withoptionalKoffein
medicationObjektoptionalnur mit advisor:medication: gespeicherte Medikamente
medication.drugClassesarray ≤ 16 von string 1 bis 64immerMedikamentenklassen wie im Formular
medication.freetextstring ≤ 2000immer, auch nulleigene Worte des Mitglieds; null ohne
medication.recognizedDrugClassesarray ≤ 16 von string 1 bis 64immerKlassen, die Choicera im Freitext erkennt
medication.confirmedAtstringimmer, auch nullletzte Bestätigung durch das Mitglied als ISO-Zeitpunkt; null, wenn nie bestätigt
medication.daysSinceConfirmedintegerimmer, auch nullTage seit der letzten Bestätigung; null, wenn nie bestätigt
medication.isStalebooleanimmertrue ab 90 Tagen oder ohne Bestätigung, wenn Medikamente gespeichert sind
maternalObjektoptionalnur mit advisor:maternal: Schwangerschaft oder Stillzeit
maternal.lifeStagestring ≤ 32immer, auch nullpregnant oder lactating; null ohne Angabe
maternal.trimesterinteger 1 bis 3immer, auch nullSchwangerschaftsdrittel 1 bis 3; null ohne Angabe
maternal.confirmedAtstringimmer, auch nullletzte Bestätigung durch das Mitglied als ISO-Zeitpunkt; null, wenn nie bestätigt
maternal.daysSinceConfirmedintegerimmer, auch nullTage seit der letzten Bestätigung; null, wenn nie bestätigt
maternal.isStalebooleanimmertrue ab 90 Tagen oder ohne Bestätigung

confirm_profile

Eingabe

FeldTypPflichtBedeutung
facetsarray 1 bis 3 aus demographics, medication, maternaljaTeile, denen das Mitglied zugestimmt hat: demographics, mit advisor:medication auch medication, mit advisor:maternal auch maternal
profileVersionstring 1 bis 64japrofileVersion aus der get_profile-Antwort, die das Mitglied gesehen hat

Antwort

FeldTypVorhandenBedeutung
confirmedarray 1 bis 3 aus demographics, medication, maternalimmerdie jetzt bestätigten Teile
confirmedAtstringimmerZeitpunkt der Bestätigung
profileVersionstring 1 bis 64immerneuer Stand der Angaben, für ein weiteres confirm_profile

get_orders

Eingabe

FeldTypPflichtBedeutung
orderNumberstring 1 bis 32neineine Bestellnummer des Mitglieds, etwa aus der Bestellmail; ohne sie die neuesten Bestellungen

Antwort

FeldTypVorhandenBedeutung
ordersarray ≤ 20 von Bestellungimmereigene Bestellungen an der Kasse, neueste zuerst, höchstens 20, auch mit offener Zahlung; fehlgeschlagene und abgelaufene Zahlungen fehlen
ordersUrlstring, nicht leerimmerSeite der App mit den bezahlten und stornierten Bestellungen; eine Bestellung mit offener Zahlung steht dort noch nicht; ohne Sitzung im Browser kommt zuerst die Anmeldung

Bestellung

FeldTypVorhandenBedeutung
orderNumberstring 1 bis 32immerBestellnummer wie in der Bestellmail und in der App, Eingabe für get_orders
orderedAtstringimmerZeitpunkt der Bestellung als ISO-Zeitpunkt
paymentpaid, pending, cancelledimmerpaid: Zahlung bestätigt; pending: der Zahlungsdienst hat sie noch nicht bestätigt; cancelled: storniert
totalnumberimmerGesamtbetrag mit Versand
currencystring ≤ 16immerWährung
sellersarray ≤ 64 von Teil einer Bestellungimmerje Verkäufer ein Teil der Bestellung

Teil einer Bestellung

FeldTypVorhandenBedeutung
sellerstring ≤ 256immerName der Marke, die verkauft und versendet
itemCountinteger ab 0immerZahl der Packungen
amountnumberimmerBetrag des Verkäufers mit Versand
deliveryordered, shipped, cancelled, refunded, withdrawn, undeliverableimmerordered: noch nicht versandt; shipped: dem Versand übergeben; cancelled: storniert; refunded: erstattet; withdrawn: vom Kunden vor dem Versand widerrufen, stornierte Ware kostet ihn nichts; undeliverable: das Paket war nicht zustellbar und geht zur Marke zurück, der Kunde bekommt sein Geld zurück oder zahlt nichts, wenn noch nichts abgebucht war
expectedDeliveryObjektimmer, auch nullerwartetes Lieferfenster; null nach der Zustellung, solange die Zahlung offen ist oder ohne Lieferzeit des Verkäufers
expectedDelivery.earlieststring ≤ 10immererster Tag, JJJJ-MM-TT
expectedDelivery.lateststring ≤ 10immerletzter Tag, JJJJ-MM-TT
deliveredAtstringimmer, auch nullZustellung als ISO-Zeitpunkt; null davor
trackingUrlstring ≤ 2048immer, auch nullSeite der Sendungsverfolgung; null ohne

Beispiele

Katalog: von der Suche zum Produkt

Ohne Konto, mit curl:

curl -s https://choicera.com/agent/mcp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"search_products","arguments":{"query":"magnesium","limit":1}}}'

structuredContent der Antwort hat den Aufbau {"products":[<Katalogprodukt>],"total":<Zahl>,"limit":1,"offset":0,"matchMode":"all"}. Der Treffer in products[0] ist die schlanke Form aus der Feldreferenz, mit matchReasons.

Danach ein Produkt im Einzelnen, hier als Beispiel:

{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"get_product","arguments":{"productId":"4087c20a-c60f-4050-b3d9-86f530242f9b"}}}

Antwort des Servers, Inhalt von structuredContent (Stand November 2026):

{
  "id": "4087c20a-c60f-4050-b3d9-86f530242f9b",
  "title": "Acerola Vitamin C (120 Lutschtabletten)",
  "sourceLanguage": "de",
  "brand": { "id": "3d89bd07-0724-41e0-91de-42ab539ab8be", "slug": "lifelight", "name": "Life Light", "color": "#007ab3", "logoUrl": "https://choicera.com/brand-logos/lifelight.webp?v=1" },
  "price": 20.8,
  "currency": "EUR",
  "basePrice": { "amount": 173.33, "amountLabel": "173,33", "unit": "kg" },
  "imageUrl": "https://choicera.com/product-images/4087c20a-c60f-4050-b3d9-86f530242f9b.webp?v=d4172c6a83d9",
  "productUrl": "https://choicera.com/go/4087c20a-c60f-4050-b3d9-86f530242f9b?c=agent",
  "productUrlDisplay": "Life Light: https://choicera.com/go/4087c20a-c60f-4050-b3d9-86f530242f9b?c=agent\n\nWerbelink: Choicera kann bei einem Kauf über diesen Link eine Provision vom Partnershop erhalten. Choicera vermittelt ausschließlich Produkte seiner Partnermarken.",
  "compliance": [
    { "id": "F6", "text": "Werbelink: Choicera kann bei einem Kauf über diesen Link eine Provision vom Partnershop erhalten. Choicera vermittelt ausschließlich Produkte seiner Partnermarken.", "trigger": "buy_link:4087c20a-c60f-4050-b3d9-86f530242f9b" },
    { "id": "F8", "text": "Preisangabe: Gesamtpreis 20,80 €; Grundpreis 173,33 €/kg.", "trigger": "price:4087c20a-c60f-4050-b3d9-86f530242f9b" }
  ],
  "formFactor": "tablet",
  "servingSizeDisplay": "2 Tabletten",
  "servingsPerContainer": 60,
  "dosageText": "Täglich 2 Tabletten im Mund lutschen.",
  "strengthPerServing": "200 mg",
  "servingUnit": "Tabletten",
  "pricePerServing": 0.3467,
  "primaryIngredients": ["Vitamin C", "Vitamin C aus Acerola-Kirschen", "Acerola-Kirschen", "Acerola Fruchtsaft Pulver", "Traubenzucker", "Magnesiumsalze der Speisefettsäuren"],
  "dietCompatibility": [],
  "allergens": [],
  "minAgeYears": null,
  "maxAgeYears": null,
  "intakeAdvice": "Täglich 2 Tabletten im Mund lutschen.",
  "warnings": null,
  "pzn": null,
  "servingIntervalDays": 1,
  "ingredientsDeclaration": ["Acerola-Fruchtsaftpulver 56%", "Traubenzucker", "Trennmittel: Stearinsäure", "Magnesiumsalze der Speisefettsäuren", "Kirscharoma", "Süßungsmittel: Steviolgylcoside"],
  "variants": [
    { "id": "e1c446b4-7cbd-49fa-8cb8-75f75d63a1d7", "title": "Standard", "position": 1, "containerSize": null, "containerUnit": null, "price": 20.8, "basePrice": { "amount": 173.33, "amountLabel": "173,33", "unit": "kg" }, "available": true, "imageUrl": null, "servingSizeMin": null, "servingSizeMax": null, "servingSizeUnit": null, "servingsPerContainerMin": null, "servingsPerContainerMax": null, "flavor": null }
  ],
  "substanceDescription": "Vitamin C ist ein wasserlösliches Vitamin, das in vielen Obst- und Gemüsesorten vorkommt."
}

So zeigst du es: Titel und Marke; Preis mit Grundpreis in einem Satz („20,80 € (173,33 €/kg)“) und daneben den F8-Text aus compliance; statt der nackten Adresse productUrlDisplay vollständig. Bestellt wird über productUrl im Shop der Marke.

Beratung: Folge der Aufrufe

Skizze mit Konto (Token mit advisor checkout:personalized offline_access). Gezeigt sind die params von tools/call und was in der Antwort zählt; Kennungen und Werte sind Beispiele, die vollständigen Felder stehen in der Feldreferenz.

SchrittAufrufAntwortDein Agent
1{"name":"start_consultation","arguments":{"goalSlugs":["sleep-relaxation"],"message":"Ich komme abends schlecht zur Ruhe."}}conversationId cmhq8x2k40001abcd, status gathering_info, reply.type question mit options und freeText: truereply.text vollständig zeigen, Optionen als Auswahl
2{"name":"send_message","arguments":{"conversationId":"cmhq8x2k40001abcd","message":"Länger als 30 Minuten"}}reply.type demographic_intake, reply.form.kind demographicsFelder einzeln abfragen
3{"name":"answer_intake","arguments":{"conversationId":"cmhq8x2k40001abcd","kind":"demographics","demographics":{"gender":"female","ageBracket":"30_44","weightBracket":"60_75"}}}reply.type question oder messageweiterreichen; Schritte 2 und 3 wiederholen sich, bis ready_to_generate
4{"name":"get_plan","arguments":{"conversationId":"cmhq8x2k40001abcd"}}status pending, jobId job_7f3c, retryAfterSeconds 55 Sekunden warten
5{"name":"get_plan","arguments":{"conversationId":"cmhq8x2k40001abcd","jobId":"job_7f3c"}}status draft_review, plan und draft.rowsEntwurf zeigen, Zeile für Zeile fragen
6{"name":"search_substances","arguments":{"conversationId":"cmhq8x2k40001abcd","query":"zink"}}options mit key zincnur, wenn das Mitglied etwas hinzufügen will
7{"name":"get_plan","arguments":{"conversationId":"cmhq8x2k40001abcd","draftFeedback":[{"key":"magnesium","feedback":"preferred_form","form":"capsule"}],"draftAdded":["zinc"]}}je nach Beratung pending, refining_intake (dann reply wie bei send_message) oder completedbis completed weiter wie in Plan erzeugen
8(bei completed)plan.planId cmhqa4d2s000blmno, plan.phases, disclosurePlan mit disclosure vollständig zeigen
9{"name":"get_plan_products","arguments":{"planId":"cmhqa4d2s000blmno"}}status ok, positions mit productsProdukte mit warnings und Grundpreis zeigen, Mitglied wählen lassen
10{"name":"add_to_cart","arguments":{"planId":"cmhqa4d2s000blmno","items":[{"positionId":"pos_magnesium","productId":"b1e0c7a2-0000-4000-8000-000000000001","variantId":"v_120","quantity":1}]}}added, needsConfirmation, rejected, cartErgebnis nennen; Zeilen in needsConfirmation erst nach Bestätigung erneut senden
11{"name":"get_checkout_link","arguments":{"planId":"cmhqa4d2s000blmno"}}mode personalized, order mit Zeilen, Verkäufern, Versand und Gesamtpreis; target checkout mit links[0].url https://choicera.com/supps/checkout?plan=cmhqa4d2s000blmno&step=review&via=ai, sonst plan_page mit https://choicera.com/supps/plan?conv=cmhq8x2k40001abcd; links[0].displayWarenkorb aus order zeigen, dann links[0].display vollständig
12{"name":"get_orders","arguments":{}}orders[0].orderNumber C7K2M9P4QXR, orders[0].payment paid, je Verkäufer deliverywenn das Mitglied zurückkommt: Bestellnummer, Zahlstand und Versandstand nennen

Zum Vergleich, eine vollständige Antwort aus Schritt 1 (Beispielwerte, Aufbau nach Schema, ohne die Freigaben für Medikamente und Schwangerschaft):

{
  "conversationId": "cmhq8x2k40001abcd",
  "status": "gathering_info",
  "reply": {
    "type": "question",
    "text": "Wie lange brauchst du meistens zum Einschlafen?\n\nDiese Empfehlung wurde automatisiert durch das KI-System von Choicera erstellt.\n\nDies ist keine medizinische Beratung und ersetzt keine ärztliche oder apothekerliche Beratung. Bei bestehenden Erkrankungen, Medikamenteneinnahme, Schwangerschaft oder Stillzeit hole vor der Einnahme ärztlichen Rat ein.\n\nWechselwirkungen mit Medikamenten konnten nicht geprüft werden\n\nEignung bei Schwangerschaft/Stillzeit nicht geprüft",
    "options": [
      { "label": "Unter 15 Minuten", "value": "Unter 15 Minuten" },
      { "label": "15 bis 30 Minuten", "value": "15 bis 30 Minuten" },
      { "label": "Länger als 30 Minuten", "value": "Länger als 30 Minuten" }
    ],
    "multiSelect": false,
    "freeText": true
  },
  "compliance": [
    { "id": "F4", "text": "Diese Empfehlung wurde automatisiert durch das KI-System von Choicera erstellt.", "trigger": "ai_recommendation" },
    { "id": "F5", "text": "Dies ist keine medizinische Beratung und ersetzt keine ärztliche oder apothekerliche Beratung. Bei bestehenden Erkrankungen, Medikamenteneinnahme, Schwangerschaft oder Stillzeit hole vor der Einnahme ärztlichen Rat ein.", "trigger": "health_recommendation" },
    { "id": "F10", "text": "Wechselwirkungen mit Medikamenten konnten nicht geprüft werden", "trigger": "degraded_medication" },
    { "id": "F10", "text": "Eignung bei Schwangerschaft/Stillzeit nicht geprüft", "trigger": "degraded_maternal" }
  ]
}

Als erste Antwort der Beratung trägt diese Frage die Pflichttexte. Ein Formular wie in Schritt 2 und eine spätere reine Frage (question) tragen keine: reply.text ist dann nur die Frage, compliance ist leer.