← API Documentation
/api/items21
provide items of a category and related data
Parameters
categoryid
(int)
the category id to list items for
🔗 group_id
rubricid
(int)
alternativly, the rubric id to list items for
🔗 rubric_id
subcategoryid
(int)
alternativly, the subcategory id to list items for
🔗 subgroup_id
packsid
(int)
alternatively, as admin, the packing station id to list items for
🔗 packsid
noitems
(any value)
dont include the items themselves, just their accompanying data (like units or tour limits)
hidden
(boolean)
if 1, include all hidden items (which are otherwise skipped)
max
(int)
a maximum nuber of records to be returned.
scroll
(int)
scrolling offset. Use it together with max to implement result scrolling. If nothing was returned, you reached the end of the list.
shuffle
(1 or 0)
shuffle result
xcache
(int)
if 1, utilize edge cache. use it to get fast responses. Caches are cleared at midnight, if not explicitly requested.
img_b64
(int)
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.
oo-auth
(int)
if provided, the request will fail if there is no authenticated session. Use it to re-authenticate if needed.
oo-rf
compact
compacts
full
fulls
json
md
html
js
openapi
yaml
(String)
optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
oo-auth
(int)
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.
▶ Try it
Response Types