/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

(int) 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 🔗 group_id
(int) alternatively, the rubric id to list items for🔗 rubric_id
(int) alternatively, the subcategory id to list items for🔗 subgroup_id
(int) alternatively, a comma separated list of item ids
(int) alternatively, as admin, the packing station id to list items for🔗 packsid
(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.<b>Dont use this, if you request sensitive data (like individual prices)</b>
(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.
(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 · XUnit

Item (v25) docs

A warehouse Item

Fields (74)
#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)
66packsidintinternal packstation id. Only provided if the request comes with admin permissions
67packseqintinternal packing sequence number. Only provided if the request comes with admin permissions
68isBiobooltrue if the verband is an EU-certified organic association; the EU-Bio logo should be shown alongside the org logo
69pcgIdintinternal PCG backend id. Requires. Provided only if the caller has sufficient permissions
70bestBeforeDaysintbest-before days (aka MHD-days): the expected number of days one can assume from the moment of delivery. 0 if not maintained
71refundPricedoubledeposit (Pfand) charged per unit in addition to the item price, 0 if the item has no deposit
72refundNamestringname of the deposit category (e.g. 'Glasflaschen'), or a generic term for it if the item has no category. Empty if the item has no deposit
73refundVatdoubleVAT percentage of the deposit. 0 means it carries the item's own VAT

Data (15 records)

idnamepriceunitinfotxtcategoryidvatrefundtypehiddenreferencePricethumbnailCodehasLongInfopreorderPossibleinfoReferenceorderPeriodEndorderPeriodStartdeliveryPeriodStartdeliveryPeriodEndweightedpreOrderOnOrderStoppointerspecialOffersearchTermsreferenceUnitimageCodepacknameverbandoriginIdisRegionalAmountMinAmountMaxAmountDefAmountStepimageCountlastPricelabelshasRelatedproducerIdhasLG5saleLeftcertificateavailableunitspackageCodeeuOriginalcoholCodetradingClassseasonalpackingStationIdweightreferenceUnitFactormaxDiscountunitHintbulkPricebulkAmountbulkPriceReferencenoSubscriptiondateBorderbrandcodeinfoReferencePointersproducerNamesaleTypebrandNamepartnerIdlocationHintpacksidpackseqisBiopcgIdbestBeforeDaysrefundPricerefundNamerefundVat
144 →create2 →item1Paprika grün10.9kgAus EIGENEM ANBAU8 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0bf5a10cdfalsefalse02027-11-221899-12-302026-07-062027-11-22truefalse1falsece3b10e2Paprika grünNaturland39true0.09990.01.00.100.0[]false898false-1.0DE-ÖKO-005truekg00IIfalse3-1.00.0100.00.00.00.0false2026-11-30eigean:2700000100524, ecoinform:null, datanature:Eigenbau0000true000.00.0
255 →create2 →item1Hokkaidokürbis3.9kgaus eigenem Anbau9 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.05aa12f1falsefalse02027-11-221899-12-302026-08-102027-11-22truefalse1falsec799116fHokkaidokürbisNaturland39false0.09990.01.00.100.0[]false898false-1.0DE-ÖKO-005truekg00IIfalse31.1220.0100.00.00.00.0false2026-11-30----ean:2700000100610, ecoinform:null, datanature:Eigenbau0000true000.00.0
256 →create2 →item1Kürbis Sweet Dumpling4.9kgaus eigenem Anbau9 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0d07b1105falsefalse02027-11-221899-12-302026-09-142027-11-22truefalse1falsedf83111fKürbis Sweet DumplingNaturland39false0.09990.01.00.100.0[]false898false-1.0DE-ÖKO-005truekg00IIfalse3-1.00.0100.00.00.00.0false2026-11-30----ean:2700000100644, ecoinform:null, datanature:Eigenbau0000true000.00.0
257 →create2 →item1Kürbis Butternut4.2kgaus eigenem Anbau9 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.09f651065falsefalse02027-11-221899-12-302026-09-142027-11-22truefalse1false9e6e1057Kürbis ButternutNaturland39false0.09990.01.00.100.0[]false898false-1.0DE-ÖKO-005truekg00IIfalse3-1.00.0100.00.00.00.0false2026-11-30----ean:2700000100630, ecoinform:null, datanature:Eigenbau0000true000.00.0
258 →create2 →item1Muskatkürbis4.3kgaus eigenem Anbau9 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0d0b51110falsefalse02027-11-221899-12-302026-08-242027-11-22truefalse1falsece9410f1MuskatkürbisNaturland39false0.09990.01.00.100.0[]false898false-1.0DE-ÖKO-005truekg00IIfalse31.0020.0100.00.00.00.0false2026-11-30----ean:270000010044, ecoinform:null, datanature:Eigenbau0000true000.00.0
344 →create2 →item1Paprika grün9.5kg25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.08fad1044falsefalse02027-11-221899-12-302026-11-302027-11-22truefalse1falsef2d512d4Paprika grünBioland37true0.09990.01.00.100.0[]true135false-1.0ES-ECO-001-ANtruekg00IIfalse30.220.0100.00.00.00.0false2026-11-30Lean:2700000100521, ecoinform:null, datanature:Landweg0000true000.00.0
345 →create2 →item1Paprika rot10.9kg25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0d10b110dfalsefalse02027-11-221899-12-302024-07-062027-11-22truefalse1falsee02e1131Paprika rotEG-Kontrolliert9false0.09990.01.00.100.0[]false135false-1.0ES-ECO-001-ANtruekg00IIfalse30.2270.0100.00.00.00.0false2026-11-30Lean:2700000100586, ecoinform:null, datanature:Landweg0000false000.00.0
349 →create2 →item1Paprika gelb10.9kg25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.044cc1432falsefalse02027-11-221899-12-302026-10-122027-11-22truefalse1false2c512a1Paprika gelbEG-Kontrolliert9false0.09990.01.00.100.0[]false135false-1.0ES-ECO-001-ANtruekg00IIfalse30.2410.0100.00.00.00.0false2026-11-30Lean:2700000100523, ecoinform:null, datanature:Landweg0000false000.00.0
340 →create2 →item1Romatomaten9.0kglangoval25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0be7710c4falsefalse02027-11-221899-12-302026-11-092027-11-22truefalse1falsece3a10e6RomatomatenEG-Kontrolliert9false0.09990.01.00.100.0[]false135false-1.0DE-ÖKO-003truekg00IIfalse30.0990.0100.00.00.00.0false2026-11-30Lean:2700000100517, ecoinform:null, datanature:Landweg0000false000.00.0
346 →create2 →item1Tomaten8.9kg25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0a38e1634falsefalse12027-11-221899-12-302026-10-122027-11-22truefalse1falseb8161653TomatenEG-Kontrolliert9false0.09990.01.00.100.0[]false135false-1.0ES-ECO-001-ANtruekg00IIfalse30.1080.0100.00.00.00.0false2026-11-30Lean:2700000100511, ecoinform:null, datanature:Landweg0000false000.00.0
347 →create2 →item1Kirschtomaten1.6100g25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0bf5d10d0falsefalse02027-11-221899-12-302026-10-192027-11-22truefalse2falsece5610efKirschtomatenEG-Kontrolliert5false0.49950.01.00.100.0[]false135false-1.0DE-ÖKO-001true100g00IIfalse30.0210.0100.00.00.00.0false2026-11-30Lean:2700274400110, ecoinform:null, datanature:Landweg0000false000.00.0
348 →create2 →item1Auberginen6.9kg25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0d1141118falsefalse02027-11-221899-12-302024-07-062027-11-22truefalse1falsecefd10fdAuberginenDemeter5false0.09990.01.00.100.0[]false135false-1.0ES-ECO-001-ANtruekg00IIfalse30.2920.0100.00.00.00.0false2026-11-30Lean:2700000100399, ecoinform:null, datanature:Landweg0000true000.00.0
351 →create2 →item1Zucchini6.9kg25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0d0a9110efalsefalse02027-11-221899-12-302026-09-072027-11-22truefalse1falsece7f10ecZucchiniEG-Kontrolliert5false0.09990.01.00.100.0[]false135false-1.0DE-ÖKO-005truekg00IIfalse30.2410.0100.00.00.00.0false2026-11-30Lean:2700000100722, ecoinform:null, datanature:Landweg0000false000.00.0
353 →create2 →item1Schlangengurken2.9Stück25 →items21 →items22 →items20 →items23 ⬆7.00.00false0.09f781069falsefalse12027-11-221899-12-302026-09-072027-11-22falsefalse3falseaeef108eSchlangengurkenEG-Kontrolliert9false0.00.01.00.000.0[]false135false-1.0DE-ÖKO-003trueStück00IIfalse30.390.0100.00.00.00.0false2026-11-30Lean:2700000100685, ecoinform:null, datanature:Landweg0000false000.00.0
354 →create2 →item1Landgurken4.9kg25 →items21 →items22 →items20 →items23 ⬆7.00.0-1false0.0303513dbfalsefalse02027-11-221899-12-302026-11-232027-11-22truefalse1falseef521255LandgurkenEG-Kontrolliert5false0.09990.01.00.100.0[]false135false-1.0DE-ÖKO-003truekg00IIfalse30.1980.0100.00.00.00.0false2026-11-30Lean:2700000100682, ecoinform:null, datanature:Landweg0000false000.00.0

XUnit (v5) docs

Alternative Units

Fields (10)
#FieldTypeDescription
0iidintitem id reference
1namestringuntranslated unit name
2partsdoublehow many of these alternative units make up ONE base unit of the item (e.g. 3.57 pieces per kg). The price of one alternative unit is therefore item price / parts.
3typestringunit type: S for pices, W for a weighted unit
4unitidintiternal unit id reference (to units)
5preferredbooltrue, if this is the preferred unit among alternatives
6translatedNamestringtranslated unit name (translatable)
7gramsdoubleoptional weight in grams (for non standard units like 'spoon'
8infoOnlyboolthis unit can not be selected, its just for display (in recipes or orders)
9pcgidintinternal reference

Data (14 records)

iidnamepartstypeunitidpreferredtranslatedNamegramsinfoOnlypcgid
144Stück5.0S-45falseStück0.0false45
255Stück1.0S-68falseStück0.0false68
256Stück1.0S-69falseStück0.0false69
257Stück1.0S-70falseStück0.0false70
258Stück0.4S-309falseStück0.0false309
340Stück10.0S-212falseStück0.0false212
344Stück5.0S-97falseStück0.0false97
345Stück5.0S-98falseStück0.0false98
346Stück12.5S-99falseStück0.0false99
347Stück5.0S-301falseStück0.0false301
348Stück4.0S-100falseStück0.0false100
349Stück5.0S-179falseStück0.0false179
351Stück5.0S-101falseStück0.0false101
354Stück6.0S-102falseStück0.0false102