Searches documents of a specific datatype using a search phrase. Useful for autocomplete or lookup scenarios within the admin UI.
Requires authentication.
Request
GET /documents/search/{dataType}
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
dataType | string | Yes | The document type to search. Common values: product, category, manufacturer. |
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | No | The search phrase. Defaults to an empty string (returns all documents). |
language | string | No | Language identifier to scope the search. Defaults to the instance default language. |
Headers
| Header | Value |
|---|---|
Authorization | Bearer <token> |
Example Request
GET /documents/search/category?q=shoes&language=de
Authorization: Bearer <token>Response
Returns a JSON array of matching document objects.
Response Body
Each object in the array contains:
| Field | Type | Description |
|---|---|---|
id | string | Document identifier. |
active | boolean | Whether the document is active. |
title | string | Display title of the document. |
url | string | URL of the document. |
manufacturer_title | string | Manufacturer name (for products). |
category_title | string | Category name (for products). |
ean | string | EAN/barcode (for products). |
Example Response
[
{
"id": "cat-123",
"active": true,
"title": "Men's Shoes",
"url": "/men/shoes",
"category_title": null,
"manufacturer_title": null,
"ean": null
}
]