Search (admin API)

Admin routes of the search module. Every route needs a staff session and the permission named on it; send X-Resolve-Locale: false to receive every locale of a translatable field for editing.

GET /v1/admin/search

Cross-entity admin search

Parameters:

• limit in query (number, min 1, max 20, optional).
• q in query (string, min length 2, required).
• types in query (array of "cms", "customer", "order", "product", optional).

Responses:

• 200: Grouped search results.

GET /v1/admin/search/analytics

Get search analytics

Parameters:

• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).
• period in query (7, 30, 90, optional).

Responses:

• 200: Analytics retrieved.
• 401: Unauthorized.
• 403: Insufficient permissions.

GET /v1/admin/search/merchandising

List merchandising rules

Parameters:

• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).

Responses:

• 200: Rules retrieved.
• 401: Unauthorized.
• 403: Insufficient permissions.

POST /v1/admin/search/merchandising

Create merchandising rule

Request body: CreateMerchandisingRuleDto.

Responses:

• 201: Rule created.
• 401: Unauthorized.
• 403: Insufficient permissions.

DELETE /v1/admin/search/merchandising/{id}

Delete merchandising rule

Parameters:

• id in path (string, required).

Responses:

• 204: Rule deleted.
• 401: Unauthorized.
• 403: Insufficient permissions.

POST /v1/admin/search/reindex

Reindex search

Responses:

• 200: Reindex started.
• 401: Unauthorized.
• 403: Insufficient permissions.

GET /v1/admin/search/synonyms

List search synonyms

Parameters:

• page in query (number, min 1, optional).
• pageSize in query (number, min 1, max 100, optional).

Responses:

• 200: Synonyms retrieved.
• 401: Unauthorized.
• 403: Insufficient permissions.

POST /v1/admin/search/synonyms

Create search synonym

Request body: CreateSynonymDto.

Responses:

• 201: Synonym created.
• 401: Unauthorized.
• 403: Insufficient permissions.

DELETE /v1/admin/search/synonyms/{id}

Delete search synonym

Parameters:

• id in path (string, required).

Responses:

• 204: Synonym deleted.
• 401: Unauthorized.
• 403: Insufficient permissions.

GET /v1/admin/search/zero-results

List queries that returned zero results

Parameters:

• page in query (string, optional).
• pageSize in query (string, optional).
• period in query (string, optional).

Responses:

• 200: Zero-result queries retrieved.
• 401: Unauthorized.
• 403: Insufficient permissions.

Schemas

CreateMerchandisingRuleDto

• type (string, required).
• query (string, max length 200, optional).
• productId (string, optional).
• position (number, min 0, optional).
• priority (number, optional).
• config (object, optional).

CreateSynonymDto

• terms (array of string, max length 100, required).