/api/item1

Provides full detail for a single item including alternative units, tour-specific order limits, and related items (recipes/packages), if this data exists.

Change Note: replaces legacy json/item.jsp with POJO pattern

Parameters

(int) item id🔗 item_id
(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 · ItemDetail

Item (v22) docs

A warehouse Item

Fields (66)
#FieldTypeDescriptionLinks
0idintInternal Id⬆ 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🔗 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 (1 record)

idnamepriceunitinfotxtcategoryidvatrefundtypehiddenreferencePricethumbnailCodehasLongInfopreorderPossibleinfoReferenceorderPeriodEndorderPeriodStartdeliveryPeriodStartdeliveryPeriodEndweightedpreOrderOnOrderStoppointerspecialOffersearchTermsreferenceUnitimageCodepacknameverbandoriginIdisRegionalAmountMinAmountMaxAmountDefAmountStepimageCountlastPricelabelshasRelatedproducerIdhasLG5saleLeftcertificateavailableunitspackageCodeeuOriginalcoholCodetradingClassseasonalpackingStationIdweightreferenceUnitFactormaxDiscountunitHintbulkPricebulkAmountbulkPriceReferencenoSubscriptiondateBorderbrandcodeinfoReferencePointersproducerNamesaleTypebrandNamepartnerIdlocationHint
38302 →create2 →item1 ⬆Wirsingrouladen10.04 Pers.Wirsingrouladen mit Linsenfüllung109 →items22 →items20 →items21 →items237.00.011false0.0truefalse02027-11-221899-12-302026-10-262027-11-22falsefalse0falseec772008Wirsingrouladen0false0.00.01.00.000.0[]false0false-1.0DE-ÖKO-005true4 Pers.00false0-1.00.0100.00.00.00.0false2022-05-06ean:null, ecoinform:null, datanature:00

ItemDetail (v1) docs

Extended item information such as long description HTML

Fields (2)
#FieldTypeDescriptionLinks
0iidintitem id⬆ id🔗 item_id
1longinfoHtmlstringlong description as rendered HTML

Data (1 record)

iidlonginfoHtml
38302 →create2 →item1 ⬆