Search Documentation

Search for a documentation page...

Search API

Full-text product search across your store.

Search Products

GET /api/v1/search

Full-text search across product names and descriptions. Results are ranked by relevance and cached for performance.

Query Parameters

ParameterTypeDefaultDescription
querystringRequired. Search term (1-200 characters)
limitnumber10Results per page (1-100)
offsetnumber0Results to skip

Response

{
"items": [
{
"id": "0191abc0-1234-7def-8000-000000000001",
"name": "Classic Tee",
"slug": "classic-tee",
"summary": "A comfortable everyday tee",
"images": ["https://cdn.example.com/tee.jpg"]
}
],
"pagination": {
"total": 3,
"offset": 0,
"limit": 10,
"hasMore": false
}
}
curl -H "Authorization: Bearer your_api_key" \
"https://your-store.yns.store/api/v1/search?query=tee&limit=5"