SuggestAPISuggestAPIDocumentation
Contact usOpen app
Console

Merchandising

Pin documents for an exact query with precedence and campaign windows from Search rules on Configuration.

Copy page
Open in ChatGPTOpen with page contextOpen in ClaudeOpen with page context

Open the index → Configuration → Search rules (Paid). Merchandising pins specific documents to the top of results when the shopper’s query matches a rule exactly.

Pins apply only to SuggestAPI hosted search. In search proxy mode, /v1/autocomplete does not use these rules.

This control is plan-gated. On plans without merchandising, the panel explains that Search rules require a paid plan. See Billing and usage.

Saves are locked while an import or reindex is running.

How a rule works

Each rule has:

  • Exact query — the shopper query that must match (for example widget).
  • Pinned documents — ordered document IDs forced to the top for that query.
  • Precedence — lower numbers run first when more than one rule could apply.
  • Active — inactive rules are stored but not applied.
  • Start / End — optional campaign window (UTC).

Create a rule

  1. New rule.
  2. Set the exact query, precedence, optional description, and optional window.
  3. Pin documents: search by title or keyword, or paste a document ID.
  4. Reorder pins with Up / Down.
  5. Apply to list, then Save rules.

Deactivate, edit, or remove rules from the list. Save rules is required after list changes; unsaved edits are not live.

Validate

Open Test Search and type the exact query. Pinned IDs should appear first, in pin order, while the rule is active and inside its window.