try out ↗

← API Index


/api/items20

provide items of a category and related data

Parameters

Name Description Type
categoryid the category id to list items for int
rubricid alternativly, the rubric id to list items for int
subcategoryid alternativly, the subcategory id to list items for int
noitems dont include the items themselves, just their accompanying data (like units or tour limits) any value
hidden if 1, include all hidden items (which are otherwise skipped) boolean
max a maximum nuber 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
shuffle shuffle result 1 or 0
xcache if 1, utilize edge cache. use it to get fast responses. Caches are cleared at midnight, if not explicitly requested. int
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-auth if provided, the request will fail if there is no authenticated session. Use it to re-authenticate if needed. 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 22 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)
XUnit 5 Alternative Units

OpenAPI

See items20.yaml

Referenced in skills

Other versions