/api/search2
Item search: the items matching a search term, with their accompanying data (alternative units, tour limits). Same output as /api/items23.
Change Note: first version in the typed format; replaces the legacy /api/search and /api/search1
Parameters
| Name | Description | Type |
|---|---|---|
| q | the search term (required; alternative name: searchterm). Some terms trigger special searches, e.g. the shop's words for regional items, favourites or 'Nicht vergessen'. A plain number also matches the item id. | string |
| fuzzy | 0: like search, 1: like + full text, 2: fuzzy (sounds like, needs 3+ chars), 3/4: semantic, if configured (otherwise 1). Default from the shop config. Alternative name: searchfuzzy | int |
| searchfull | which fields to search: 0 name only, 1/2/3 include search words and description. Alternative name: fields | int |
| qe | allow query extension (only with fuzzy=1/2), default 1 | boolean |
| semfilter | if true and semantic search is configured, keep only results of the categories the semantic search returns (applied with more than 3 results) | boolean |
| ng | shop navigation group list (1,2,3): leave out items that are not in these navigation groups | string |
| sorting | 0: shop config (default groups.sorting), 1: item sorting, 2: item id, 3: price, 4: name | int |
| hidden | if 1, include hidden items (admins get them by default) | boolean |
| max | a maximum number of records to be returned. | int |
| scroll | scrolling offset. Use it together with max to implement result scrolling. If nothing was returned, you reached the end of the list. | int |
| noitems | dont include the items themselves, just their accompanying data (like units or tour limits) | any value |
| img_b64 | request that images are provided as data urls. The value can be between 20 and 150, it defines the px size of the image square. | int |
| oo-rf | optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml | String |
| oo-auth | optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. | int |
Response Types
| Type | Version | Description |
|---|---|---|
| Item | 25 | A warehouse Item |
| TourLimit | 2 | Item order limits applicable for individual tours |
| RelatedItem | 2 | Items may have relations to other items (like recommended additions or as ingredient) |
| B2BInfo | 1 | Wholesale (B2B) net price and packaging option for an item. May occur multiple times per item, one per pick option. Exists only in B2B systems. |
| XUnit | 5 | Alternative Units |
OpenAPI
See search2.yaml