Skip to main content

Ecommerce API — Common Workflows

Golden, copy-pasteable request/response paths for the most common ecommerce tasks. Each workflow should show the ordered calls, a minimal request body, and what success looks like.

Stub — add real workflows.

Capture the workflows the team actually uses and link each step to the corresponding operation in the interactive reference.

Suggested workflows to document (see the reference for exact contracts):

  1. Create an index and load a catalog — create the index, then ingest documents.
  2. Run a search — issue a search/recommendation query and read results.
  3. Agentic shopping — drive the conversational experience (SSE + POST modes; see agentic_api_poc_ui for a working client).
  4. Read analytics — pull usage/analytics for an index.

For authentication on every call, see Authentication.