try out ↗

← API Index


/api/items23

provide items of a category and related data, incl. deposit (Pfand) info

Change Note: Item now carries the deposit (Pfand): refundPrice, refundName and refundVat, resolved from the item's refund category

Parameters

Name Description Type
categoryid the category id to list items for. Use 0 to indicate all items that are marked as special offering (default). -1 indicates all items, regardless off their category. Results in big data and potential timeouts, use it only with max+scroll or noitems=1 int
rubricid alternatively, the rubric id to list items for int
subcategoryid alternatively, the subcategory id to list items for int
i alternatively, a comma separated list of item ids int
packsid alternatively, as admin, the packing station 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.Dont use this, if you request sensitive data (like individual prices) 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-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 items23.yaml

Other versions