/api/items20

provide items of a category and related data

Parameters

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

Response Types

Item

Item (v22) docs

A warehouse Item

Fields (66)
#FieldTypeDescriptionLinks
0idintInternal Id🔗 item_id
1namestringitem name
2pricedoubleitem base price
3unitstringitem base unit (plain text) (translatable)
4infotxtstringshort info text, Item teaser line
5categoryidintid of the warehouse category this item belongs to⬆ categoryid🔗 group_id
6vatdoubleitem vat percentage (0..100)
7refunddoublerefund value associated with that item (CHECKME)
8typeintItem type. 0: regular item that comes in piece, -1 regular item with a weighted unit, other ids: see item type documentation
9hiddenboolitems may be (temporarily) hidden, as such not to be part of the offering
10referencePricedoublereference price: price/referenceAmount
11thumbnailCodestringif set, a thumbnail exists. Depending on the request (parameter ?img=b64), either a data URL or a image hashCode is returned. In the latter case, the image can be fetched by BASEURL/t.px?PARAMS (see docu)
12hasLongInfobooltrue if a long info exists. Fetch it separately
13preorderPossiblebooltrue if the item can be pre ordered for a delivery later than the current selected delivery date
14infoReferenceintif > 0, where to get more information. 1: Ecoinform, 2: Datanature
15orderPeriodEnddateif set, date when the ordering period ends.
16orderPeriodStartdateif set, date when the ordering period starts.
17deliveryPeriodStartdateif set, date when the delivery period starts.
18deliveryPeriodEnddateif set, date when the delivery period ends.
19weightedbooltrue if the item is weighted (and thus, the price might change slightly)
20preOrderOnOrderStopboolaka orderStopNew. if true , the item shall be pre-ordered the following possible delivery day
21pointerstringIf the type is not 0, this is a pointer item and it points to the target with that id. What kind of target is defined by the item type (dee reference). if item type is 27 (href link), its the URL this pointer points to. For type 0 , its the unit id reference.
22specialOfferbool(aka flag2), if true, this item shall be highlighted as special offer
23searchTermsstringalternative search terms for this item
24referenceUnitstringreference unit (translatable)
25imageCodestringif set, a (big) image) exists. Depending on the request (parameter ?img=b64), either a data URL or a image hashCode is returned. In the latter case, the image can be fetched by BASEURL/b.px?PARAMS (see docu)
26packnamestringalternative internal name. For vouchers, this field transports the semi-secret voucher code.
27verbandstringThe main (organic) certification association. These are well-known codes
28originIdintreference to the geografic origin (aka Herkunft) of that item.
29isRegionalbooltrue if this item is sourced regionally
30AmountMindoubleif > 0, minimum amount of this item when ordered
31AmountMaxdoubleif > 0, maximum amount of this item when ordered
32AmountDefdoubleif > 0, default amount of this item when picked in a UI without amount selection options or as initial value when placed into the cart
33AmountStepdoubleif > 0, the increment and decrement when plus or minus buttons are used to modify the order amount
34imageCountintnumber of extra images available for this product. Add the index (1..9) to the proxy call like BASEURL/b1.px?...
35lastPricedoubleif > 0, last price of this item, set by the last price detection mechanism
36labelsint[]list of label ids that apply to this item
37hasRelatedbooltrue if this item has referenced items (transported in Object RelatedItem)
38producerIdintif > 0, reference to the producer of that item.
39hasLG5boolhas data for the label group 5 (Nutrition data). Fetch them separately if needed.
40saleLeftdoubleif -1, this item is not limited by a saleout. If 0, item was just sold out. If > 0, it tells the number of still available items (in item unit)
41certificatestringorganic monitoring certifiation code
42availablebooltrue if this item is available for purchase (aka legacy protection)
43unitsstringcleartext unit name (translatable)
44packageCodeintRefund type: 0: unset, 1: One-Way, 2: Reusable (aka Mehrweg-Pfand), 3: no refund
45euOriginstringcan be one of the three EU source labels (DOOR) PGI (1), TSG (2), PDO (0)
46alcoholCodeintAlcohol code: 0: unset, 1: Alcohol, 2: Non-Alcohol
47tradingClassstringaka Handelsklasse, german trade quality class (applicable for regular items type 0 only)
48seasonalbooltrue if this item is seasonal (not always available at fullfillment time)
49packingStationIdintreference to a packing station. A packing station may imply limits when ordering.
50weightdoubleweight of this item in kilograms
51referenceUnitFactordoubleif > 0, how to translate the packaging unit (field unit) into the reference unit (for displaying the reference price)
52maxDiscountdoublemaximum discount that can be applied for this item (<=100)
53unitHintstringhint to be displayed next to the unit string. PCG liver does only use ISO Units so eny extra hint (like '6-pack' is expected here)
54bulkPricedoublebulk price for this item. If > 0, this item has a discounted price if the buldAmount is exceeded
55bulkAmountdoublethis item has a discounted price if the buldAmount is exceeded
56bulkPriceReferencedoublereference price in reference units (bulkprice / refAmount)
57noSubscriptionbooltrue if this item is not available for subscription
58dateBorderdateThis record shows values relevant for the sessions selected delivery date. Some field may change after this date
59brandcodestringbrand shortcode of the item
60infoReferencePointersstringif enabled, shows pointers to external information (ean, ecoinform, datanature
61producerNamestringname of the producer of that item (translatable)
62saleTypeint(aka Abverkauf), there are several saleout types, see the documentation. 0: no sale, 1: regular (forever) sale
63brandNamestringname of the brand of that item (through Item/Datanature (translatable)
64partnerIdintif > 0, it is the Id of a partner that handles fulfillment
65locationHintstringLocation information in a physical store. May be used to creat creative shop ideas. (translatable)

Data (15 records)

idnamepriceunitinfotxtcategoryidvatrefundtypehiddenreferencePricethumbnailCodehasLongInfopreorderPossibleinfoReferenceorderPeriodEndorderPeriodStartdeliveryPeriodStartdeliveryPeriodEndweightedpreOrderOnOrderStoppointerspecialOffersearchTermsreferenceUnitimageCodepacknameverbandoriginIdisRegionalAmountMinAmountMaxAmountDefAmountStepimageCountlastPricelabelshasRelatedproducerIdhasLG5saleLeftcertificateavailableunitspackageCodeeuOriginalcoholCodetradingClassseasonalpackingStationIdweightreferenceUnitFactormaxDiscountunitHintbulkPricebulkAmountbulkPriceReferencenoSubscriptiondateBorderbrandcodeinfoReferencePointersproducerNamesaleTypebrandNamepartnerIdlocationHint
6053 →create2 →item1Dinkel-Spirelli hell aus Deuts3.8500 g115 →items21 →items23 →items22 →items20 ⬆7.00.00false7.61541495falsefalse12027-11-221899-12-302021-01-012027-11-22falsefalse10falsekg717611a9Dinkel-Spirelli hell aus DeutsEG-Kontrolliert37false0.00.01.00.000.0[844, 847, 855, 858, 863, 896, 611]false249true-1.0ABCERTtrue500 g30IIfalse40.5370.5100.00.00.00.0false2026-09-26RAPean:4006040073055, ecoinform:null, datanature:7dd9d9b4-be04-4204-ac67-c1f7844114aaRapunzel0Rapunzel0
6340 →create2 →item1Dinkelnudel Strozzapreti al br3.5500g115 →items21 →items23 →items22 →items20 ⬆7.00.00false7.079db1c20falsefalse22027-11-221899-12-302021-11-152027-11-22falsefalse17false1kgb2e01c90Dinkelnudel Strozzapreti al br100% Bioanbau5false0.00.01.00.000.0[858, 844, 847, 855, 914, 896, 611]false719true-1.0DE-ÖKO-005true500g00IIfalse40.50.5100.00.00.00.0false2026-09-26IRIean:90064030508, ecoinform:null, datanature:f3eabb7c-eb11-4878-8f06-a62be3e11056IRI0IRIS 0
6313 →create2 →item1Dinkel Spaghetti 500g3.6StückAlb Natur115 →items21 →items23 →items22 →items20 ⬆7.00.00false7.2fc54147afalsefalse12027-11-221899-12-302024-12-282027-11-22falsefalse3false1kg805711cbDinkel Spaghetti 500gNaturland37false0.00.01.00.000.0[844, 847, 858, 611]false704true-1.0DE-ÖKO-006trueStück30false40.5260.5100.00.00.00.0false2026-09-26ALUean:4018722344681, ecoinform:null, datanature:154a5517-79b3-4e7b-b0db-b14d7fe8592fAlb-Natur0Alb-Natur®0
6332 →create2 →item1Suppennudeln hell 250g2.95250gGrosser115 →items21 →items23 →items22 →items20 ⬆7.00.00false0.094e11c27truefalse22027-11-221899-12-302021-11-152027-11-22falsefalse24false94d51c23Suppennudeln hell 250gBioland3true0.00.01.00.000.0[]false0false-1.0DE-ÖKO-005true250g00IIfalse4-1.00.0100.00.00.00.0false2026-09-26ean:4260419315027, ecoinform:null, datanature:00
6330 →create2 →item1Penne hell 500g Nudeln2.25500g100% kbA, Italien, bYODO115 →items21 →items23 →items22 →items20 ⬆7.00.00false4.5a31d1cf9falsefalse12027-11-221899-12-302007-01-012027-11-22falsefalse17false1kga31f1cfcPenne hell 500g NudelnEG-Kontrolliert5false0.00.01.00.000.0[]false279false-1.0DE-ÖKO-013true500g00IIfalse40.5330.5100.00.00.00.0false2026-09-26BYOean:4018462142202, ecoinform:null, datanature:1a099e30-4ec2-4faf-a646-118d4bdb74e7BYODO0Byodo0
6329 →create2 →item1Tagliatelle hell 250g3.05Stück100% kbA, Byodo115 →items21 →items23 →items22 →items20 ⬆7.00.00false12.28a901c64falsefalse12027-11-221899-12-302014-03-012027-11-22falsefalse3false1kg8a8d1c60Tagliatelle hell 250gEG-Kontrolliert5false0.00.01.00.000.0[]false279false-1.0DE-ÖKO-013trueStück00IIfalse40.3250.25100.00.00.00.0false2026-09-26BYOean:4018462143001, ecoinform:null, datanature:2a09a251-b8fb-4557-8cf8-00c51862b2feBYODO0Byodo0
6315 →create2 →item1Lasagne-Plattenhell 250g,Nudel3.05250gim Karton, Italien, AIAB, Byodo115 →items21 →items23 →items22 →items20 ⬆7.00.00false12.2944f1c40falsefalse12027-11-222024-03-282007-01-012027-11-22falsefalse24false1kg944b1c3cLasagne-Plattenhell 250g,NudelEG-Kontrolliert5false0.00.01.00.000.0[]false279false-1.0DE-ÖKO-013true250g00IIfalse40.2920.25100.00.00.00.0false2026-09-26BYOean:4018462142813, ecoinform:null, datanature:60116d3a-317b-4c3e-b593-1be98615ce3fBYODO0Byodo0
6335 →create2 →item1Spaghettini semola (dünne )2.6Stück500g, Byodo115 →items21 →items23 →items22 →items20 ⬆7.00.00false5.29e741cecfalsefalse12027-11-221899-12-302011-08-012027-11-22falsefalse3false1kg9e6d1ce7Spaghettini semola (dünne )EG-Kontrolliert5false0.00.01.00.000.0[]false279false-1.0DE-ÖKO-013trueStück00IIfalse40.5170.5100.00.00.00.0false2026-09-26BYOean:4018462142165, ecoinform:null, datanature:f75a6479-701a-4bec-99bf-36727e400de5BYODO0Byodo0
6352 →create2 →item1Farfalle di Semola 500g2.35500gSchleifchennudeln115 →items21 →items23 →items22 →items20 ⬆7.00.00false4.7bda81d21falsefalse22027-11-221899-12-302021-01-012027-11-22falsefalse17false1kgbdb11d2aFarfalle di Semola 500g100% Bioanbau5false0.00.01.00.000.0[896, 844, 847, 855, 863, 914, 611]false719true-1.0DE-ÖKO-005true500g00IIfalse40.50.5100.00.00.00.0false2026-09-26IRIean:90064030509, ecoinform:null, datanature:dce077c6-c057-48cb-9450-52a26c39d44aIRI0IRIS 0
6349 →create2 →item1Bunte Spiralen semola 500g3.05StückByodo115 →items21 →items23 →items22 →items20 ⬆7.00.00false6.1abf41d36falsefalse12027-11-221899-12-302014-03-012027-11-22falsefalse3false1kgabe01d29Bunte Spiralen semola 500g100% Bioanbau5false0.00.01.00.000.0[]false279false-1.0DE-ÖKO-013trueStück00IIfalse40.5330.5100.00.00.00.0false2026-09-26BYOean:4018462142509, ecoinform:null, datanature:23ab0aff-0ffe-4d80-8cbf-91bf64c9a391BYODO0Byodo0
6314 →create2 →item1Volanti Semola hell 500gNudeln3.05500gItalien, AIAB, Byodo115 →items21 →items23 →items22 →items20 ⬆7.00.00false6.1a6691cf2falsefalse12027-11-221899-12-302021-01-012027-11-22falsefalse17false1kga6601cebVolanti Semola hell 500gNudelnEG-Kontrolliert5false0.00.01.00.000.0[]false279false-1.0DE-ÖKO-013true500g00IIfalse40.5330.5100.00.00.00.0false2026-09-26BYOean:4018462142400, ecoinform:null, datanature:11e7600e-30a1-47e2-a235-0e53e0743dddBYODO0Byodo0
6316 →create2 →item1Spiralen hell 500g Nudeln1.7500g100% kbA, Rapunzel115 →items21 →items23 →items22 →items20 ⬆7.00.00false3.4ee43144cfalsefalse12027-11-221899-12-302021-11-152027-11-22falsefalse17falsekg60531179Spiralen hell 500g NudelnEG-Kontrolliert59false0.00.01.00.000.0[855, 863, 896, 847, 853, 611]false249true-1.0ICEAtrue500g30IIfalse40.5420.5100.00.00.00.0false2026-09-26RAPean:4006040155041, ecoinform:null, datanature:68bdea6f-a038-4783-af85-190766b7e718Rapunzel0Rapunzel0
6312 →create2 →item1Bandnudeln mit Ei, 250g2.95StückGrosser115 →items21 →items23 →items22 →items20 ⬆7.00.00false11.8a24f1ceatruefalse22027-11-221899-12-302021-11-152027-11-22falsefalse3falsekga24f1cebBandnudeln mit Ei, 250gBioland3true0.00.01.00.000.0[]false0false-1.0DE-ÖKO-005trueStück00IIfalse4-1.00.25100.00.00.00.0false2026-09-26ean:4260419315010, ecoinform:null, datanature:00
6319 →create2 →item1Penne Vollkorn 500g2.3500 gRapunzel115 →items21 →items23 →items22 →items20 ⬆7.00.00false4.6dd121424falsefalse12027-11-221899-12-302024-08-032027-11-22falsefalse10falsekg50201141Penne Vollkorn 500gEG-Kontrolliert59false0.00.01.00.000.0[847, 853, 855, 863, 896, 611]false249true-1.0ICEAtrue500 g30IIfalse40.5420.5100.00.00.00.0false2026-09-26RAPean:4006040229391, ecoinform:null, datanature:27d49340-593d-4340-85d9-eabc7ed0c5a3Rapunzel0Rapunzel0
6339 →create2 →item1Mie Noodles 250g2.4Stück115 →items21 →items23 →items22 →items20 ⬆7.00.00false9.613a914c1falsefalse12027-11-221899-12-302020-03-012027-11-22falsefalse3false1kg829411deMie Noodles 250g100% Bioanbau37false0.00.01.00.000.0[]false704false-1.0DE-ÖKO-006trueStück30IIfalse40.2920.25100.00.00.00.0false2026-09-26ALUean:4018722305699, ecoinform:null, datanature:eceb7664-bba5-4fe9-b310-0e748fd8f263Alb-Natur0Alb-Natur®0