Skip to main content
GET
/
api
/
agent
/
catalog
/
search
Get Catalog Search
curl --request GET \
  --url https://api.example.com/api/agent/catalog/search \
  --header 'X-Site-ID: <x-site-id>'
{
  "query": "<string>",
  "products": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "slug": "<string>",
      "description": "<string>",
      "vendor": "<string>",
      "product_type": "<string>",
      "tags": [
        "<string>"
      ],
      "image_url": "<string>",
      "price_min_cents": 123,
      "price_max_cents": 123,
      "currency": "<string>",
      "in_stock": true,
      "total_inventory": 123,
      "variant_count": 123,
      "variants": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "<string>",
          "price_cents": 123,
          "options": {},
          "inventory_quantity": 123,
          "in_stock": true,
          "sku": "<string>"
        }
      ],
      "summary_for_llm": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "pages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.stella-commerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

X-Site-ID
string
required
authorization
string | null

Query Parameters

q
string
required
Required string length: 1 - 256
page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 50

Response

Successful Response

Response shape for GET /api/agent/catalog/search.

Mirrors StorefrontSearchResponse for paginator semantics so any Phase 7 SDK can share the underlying client; the per-product shape is the LLM-friendly AgentCatalogProduct.

query
string
required
products
AgentCatalogProduct · object[]
required
total
integer
required
page
integer
required
limit
integer
required
pages
integer
required