/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

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 (14 records)

idnamepriceunitinfotxtcategoryidvatrefundtypehiddenreferencePricethumbnailCodehasLongInfopreorderPossibleinfoReferenceorderPeriodEndorderPeriodStartdeliveryPeriodStartdeliveryPeriodEndweightedpreOrderOnOrderStoppointerspecialOffersearchTermsreferenceUnitimageCodepacknameverbandoriginIdisRegionalAmountMinAmountMaxAmountDefAmountStepimageCountlastPricelabelshasRelatedproducerIdhasLG5saleLeftcertificateavailableunitspackageCodeeuOriginalcoholCodetradingClassseasonalpackingStationIdweightreferenceUnitFactormaxDiscountunitHintbulkPricebulkAmountbulkPriceReferencenoSubscriptiondateBorderbrandcodeinfoReferencePointersproducerNamesaleTypebrandNamepartnerIdlocationHintpacksidpackseqisBiopcgIdbestBeforeDaysrefundPricerefundNamerefundVat
12939 →create2 →item1BBS Lammsbräu Winterfestbier1.75Stückbayr. Bio-Siegel 5,6% vol.20 →items21 →items22 →items20 →items23 ⬆19.00.00false3.5190148cfalsefalse12027-11-221899-12-302026-10-232026-12-31falsefalse3truel71a911a8BBS Lammsbräu WinterfestbierBioland37false0.00.01.00.000.0[896, 847, 849, 851, 852, 853, 854, 855, 858, 859, 860, 862, 863, 880, 886, 892, 611]false383true-1.0DE-ÖKO-005trueStück21false41.0040.5100.00.00.00.0false2026-10-23NEUean:4012852001087, ecoinform:null, datanature:195899ae-dd1a-4acf-b799-5d1c6cc00674BioKristall0Neumarkter Lammsbräu000true000.00.0
12940 →create2 →item1Weihnachts Festbier 5,5%vol1.8StückSaisonartikel20 →items21 →items22 →items20 →items23 ⬆19.00.00false3.6e9ec1446falsefalse12027-11-221899-12-302026-10-232026-12-31falsefalse3truel6f2f11a3Weihnachts Festbier 5,5%volBioland37false0.00.01.00.000.0[847, 858, 859, 863, 896, 611]false399true-1.0DE-ÖKO-005trueStück21false41.0260.5100.00.00.00.0false2026-10-23RBBean:4027013030028, ecoinform:null, datanature:c3bc7ae9-6cc1-4055-a31c-6453e12e79caRIEDENBURGER Brauhaus0Riedenburger Brauhaus000true000.00.0
12927 →create2 →item1Lammsbräu Dunkel& Pure Zitrone1.45Stückalkoholfrei 0,5% vol.20 →items21 →items22 →items20 →items23 ⬆19.00.00false4.39411a714aefalsefalse12027-11-221899-12-302022-08-012027-11-22falsefalse3falsel80ec11caLammsbräu Dunkel& Pure ZitroneNaturland37false0.00.01.00.000.0[892, 886, 880, 863, 862, 860, 859, 858, 855, 854, 853, 852, 851, 849, 847, 896, 611]false383true-1.0DE-ÖKO-005trueStück21false40.790.33100.00.00.00.0false2022-08-01NEUean:4012852001780, ecoinform:null, datanature:7592a3b4-b157-424d-83d0-c82c44e6cf86BioKristall0Neumarkter Lammsbräu000true000.00.0
12918 →create2 →item1Lammsbräu Dunkel alkoholfrei1.450,33l0,33l20 →items21 →items22 →items20 →items23 ⬆19.00.00false4.39413aa14bcfalsefalse12027-11-221899-12-302018-04-012027-11-22falsefalse81falsel829111e4Lammsbräu Dunkel alkoholfrei100% Bioanbau37false0.00.01.00.000.0[847, 849, 851, 852, 853, 854, 855, 858, 859, 860, 862, 863, 880, 886, 892, 896, 611]false383true-1.0DE-ÖKO-005true0,33l21IIfalse40.790.33100.00.00.00.0false2026-09-26NEUean:4012852001667, ecoinform:null, datanature:73427f4d-26ef-400b-9ab1-7115f54ddd4eBioKristall0Neumarkter Lammsbräu000false000.00.0
12943 →create2 →item1Ur Helles Riedenburger Bier1.9Stück20 →items21 →items22 →items20 →items23 ⬆19.00.00false3.8da75141afalsefalse12027-11-221899-12-302023-04-142027-11-22falsefalse3falsel4dfe1134Ur Helles Riedenburger BierBioland37false0.00.01.00.000.0[847, 858, 859, 863, 896, 855, 611]false399true-1.0DE-ÖKO-005trueStück21IIfalse40.9870.5100.00.00.00.0false2026-09-26RBBean:4027013027004, ecoinform:null, datanature:7034500b-2875-4e64-9744-309d72ea0f20RIEDENBURGER Brauhaus0Riedenburger Brauhaus000true000.00.0
12920 →create2 →item1Radler 0,5l1.95StückLammsbräu20 →items21 →items22 →items20 →items23 ⬆19.00.00false3.9de147ffalsefalse12027-11-221899-12-302014-03-012027-11-22falsefalse3falsel717811b3Radler 0,5l100% Bioanbau37false0.00.01.00.000.0[886, 892, 896, 847, 849, 851, 852, 853, 854, 855, 858, 859, 860, 862, 863, 880, 611]false383true-1.0DE-ÖKO-005trueStück21IIfalse41.0040.5100.00.00.00.0false2026-09-26NEUean:4012852201715, ecoinform:null, datanature:12f638b1-faa2-4be6-aa81-06121db37d28BioKristall0Neumarkter Lammsbräu000false000.00.0
12900 →create2 →item1Bier alkoholfrei 0,33l1.45StückDeutschland, 100% kbA, Lammsbräu20 →items21 →items22 →items20 →items23 ⬆19.00.00false4.394ffab147efalsefalse12027-11-221899-12-302006-01-012027-11-22falsefalse3falsel707111a2Bier alkoholfrei 0,33l100% Bioanbau37false0.00.01.00.000.0[863, 880, 886, 892, 896, 847, 849, 851, 852, 853, 854, 855, 858, 859, 860, 862, 611]false383true-1.0DE-ÖKO-005trueStück21IIfalse40.790.33100.00.00.00.0false2026-09-26NEUean:4012852001650, ecoinform:null, datanature:a2713b38-f341-404d-b335-3424715e525aBioKristall0Neumarkter Lammsbräu000false000.00.0
12949 →create2 →item1Bier Urstoff hell 0,5l1.950,5lDeutschland, 100% kbA, Lammsbräu20 →items21 →items22 →items20 →items23 ⬆19.00.00false3.916e1496falsefalse12027-11-221899-12-302006-01-012027-11-22falsefalse32falsel719c11b6Bier Urstoff hell 0,5l100% Bioanbau37false0.00.01.00.000.0[849, 851, 852, 853, 854, 855, 858, 859, 860, 862, 863, 880, 886, 892, 896, 847, 611]false383true-1.0DE-ÖKO-005true0,5l21IIfalse41.0040.5100.00.00.00.0false2026-09-26NEUean:4012852001100, ecoinform:null, datanature:b87630d1-8005-4c94-b9a0-1c3a5094218dBioKristall0Neumarkter Lammsbräu000false000.00.0
12912 →create2 →item1Dinkelmalz Bier alk.frei 0,331.60,33l20 →items21 →items22 →items20 →items23 ⬆19.00.00false4.848ff57147dfalsefalse12027-11-221899-12-302026-02-282027-11-22falsefalse81falsel6fff119bDinkelmalz Bier alk.frei 0,33Bioland37false0.00.01.00.000.0[847, 858, 859, 855, 863, 896, 611]false399true-1.0DE-ÖKO-005true0,33l20IIfalse40.7980.33100.00.00.00.0false2026-09-26RBBean:4027013023013, ecoinform:null, datanature:f910fe32-f830-4ee8-90db-0dd8e622b682RIEDENBURGER Brauhaus0Riedenburger Brauhaus000true000.00.0
12906 →create2 →item1Dinkelradler alkoholfrei 0,33l1.6StückRiedenburger20 →items21 →items22 →items20 →items23 ⬆19.00.00false4.848da5b140ffalsefalse12027-11-222024-03-282014-03-012027-11-22falsefalse3falsel4e1c113aDinkelradler alkoholfrei 0,33lBioland37false0.00.01.00.000.0[855, 847, 858, 859, 863, 896, 611]false399true-1.0DE-ÖKO-001trueStück21IIfalse40.7980.33100.00.00.00.0false2026-09-26RBBean:4027013016015, ecoinform:null, datanature:e6145731-01f7-4e73-bae0-8c9109b1f4f1RIEDENBURGER Brauhaus0Riedenburger Brauhaus000true000.00.0
12904 →create2 →item1Edelpils 0,33 l1.45StückNeumarkter Lammsbräu20 →items21 →items22 →items20 →items23 ⬆19.00.00false4.394a3148dfalsefalse12027-11-221899-12-302010-03-292027-11-22falsefalse3falsel710311a1Edelpils 0,33 l100% Bioanbau37false0.00.01.00.000.0[847, 849, 851, 852, 853, 854, 855, 858, 859, 860, 862, 863, 880, 886, 892, 896, 611]false383true-1.0DE-ÖKO-005trueStück21IIfalse40.790.33100.00.00.00.0false2026-09-26NEUean:4012852001056, ecoinform:null, datanature:a1a3e899-545c-4f1a-8bef-953c8b333f17BioKristall0Neumarkter Lammsbräu000false000.00.0
12921 →create2 →item1Natur-Radler alkoholfrei 0,33l1.45StückLammsbräu20 →items21 →items22 →items20 →items23 ⬆19.00.00false4.394130714b9falsefalse12027-11-221899-12-302012-07-302027-11-22falsefalse3falsel821e11e3Natur-Radler alkoholfrei 0,33lNaturland37false0.00.01.00.000.0[]false383false-1.0DE-ÖKO-001trueStück21IIfalse40.790.33100.00.00.00.0false2026-09-26NEUean:4012852001735, ecoinform:null, datanature:fe01f4c5-383c-48c4-a40d-7c04353ba717BioKristall0Neumarkter Lammsbräu000true000.00.0
12903 →create2 →item1Weißbier 0,5l1.90,5lDeutschland, Bioland, Riedenburger20 →items21 →items22 →items20 →items23 ⬆19.00.00false3.8dad5141efalsefalse12027-11-221899-12-302006-01-012027-11-22falsefalse32falsel4e61113fWeißbier 0,5lBioland37false0.00.01.00.000.0[858, 859, 863, 896, 847, 862, 855, 611]false399true-1.0DE-ÖKO-005true0,5l21IIfalse40.990.5100.00.00.00.0false2026-09-26RBBean:4027013028001, ecoinform:null, datanature:80618b92-b6ad-4f1e-b230-4cecac5a0ebcRIEDENBURGER Brauhaus0Riedenburger Brauhaus000true000.00.0
12907 →create2 →item1Weißbier alkoholfrei 0,5l1.90,5lRiedenburger20 →items21 →items22 →items20 →items23 ⬆19.00.00false3.8db9f1425falsefalse12027-11-221899-12-302010-03-292027-11-22falsefalse32falsel4ef71152Weißbier alkoholfrei 0,5lBioland37false0.00.01.00.000.0[855, 847, 858, 859, 863, 896, 611]false399true-1.0DE-ÖKO-005true0,5l21IIfalse40.9870.5100.00.00.00.0false2026-09-26RBBean:4027013024003, ecoinform:null, datanature:4cba22d8-a329-4403-9a07-be52b954e5e8RIEDENBURGER Brauhaus0Riedenburger Brauhaus000true000.00.0