← API Index


Item (v22)

A warehouse Item

# Field Type Description
0 id int Internal Id
1 name string item name
2 price double item base price
3 unit string item base unit (plain text) (translatable)
4 infotxt string short info text, Item teaser line
5 categoryid int id of the warehouse category this item belongs to
6 vat double item vat percentage (0..100)
7 refund double refund value associated with that item (CHECKME)
8 type int Item type. 0: regular item that comes in piece, -1 regular item with a weighted unit, other ids: see item type documentation
9 hidden bool items may be (temporarily) hidden, as such not to be part of the offering
10 referencePrice double reference price: price/referenceAmount
11 thumbnailCode string if 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)
12 hasLongInfo bool true if a long info exists. Fetch it separately
13 preorderPossible bool true if the item can be pre ordered for a delivery later than the current selected delivery date
14 infoReference int if > 0, where to get more information. 1: Ecoinform, 2: Datanature
15 orderPeriodEnd date if set, date when the ordering period ends.
16 orderPeriodStart date if set, date when the ordering period starts.
17 deliveryPeriodStart date if set, date when the delivery period starts.
18 deliveryPeriodEnd date if set, date when the delivery period ends.
19 weighted bool true if the item is weighted (and thus, the price might change slightly)
20 preOrderOnOrderStop bool aka orderStopNew. if true , the item shall be pre-ordered the following possible delivery day
21 pointer string If 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.
22 specialOffer bool (aka flag2), if true, this item shall be highlighted as special offer
23 searchTerms string alternative search terms for this item
24 referenceUnit string reference unit (translatable)
25 imageCode string if 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)
26 packname string alternative internal name. For vouchers, this field transports the semi-secret voucher code.
27 verband string The main (organic) certification association. These are well-known codes
28 originId int reference to the geografic origin (aka Herkunft) of that item.
29 isRegional bool true if this item is sourced regionally
30 AmountMin double if > 0, minimum amount of this item when ordered
31 AmountMax double if > 0, maximum amount of this item when ordered
32 AmountDef double if > 0, default amount of this item when picked in a UI without amount selection options or as initial value when placed into the cart
33 AmountStep double if > 0, the increment and decrement when plus or minus buttons are used to modify the order amount
34 imageCount int number of extra images available for this product. Add the index (1..9) to the proxy call like BASEURL/b1.px?...
35 lastPrice double if > 0, last price of this item, set by the last price detection mechanism
36 labels int[] list of label ids that apply to this item
37 hasRelated bool true if this item has referenced items (transported in Object RelatedItem)
38 producerId int if > 0, reference to the producer of that item.
39 hasLG5 bool has data for the label group 5 (Nutrition data). Fetch them separately if needed.
40 saleLeft double if -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)
41 certificate string organic monitoring certifiation code
42 available bool true if this item is available for purchase (aka legacy protection)
43 units string cleartext unit name (translatable)
44 packageCode int Refund type: 0: unset, 1: One-Way, 2: Reusable (aka Mehrweg-Pfand), 3: no refund
45 euOrigin string can be one of the three EU source labels (DOOR) PGI (1), TSG (2), PDO (0)
46 alcoholCode int Alcohol code: 0: unset, 1: Alcohol, 2: Non-Alcohol
47 tradingClass string aka Handelsklasse, german trade quality class (applicable for regular items type 0 only)
48 seasonal bool true if this item is seasonal (not always available at fullfillment time)
49 packingStationId int reference to a packing station. A packing station may imply limits when ordering.
50 weight double weight of this item in kilograms
51 referenceUnitFactor double if > 0, how to translate the packaging unit (field unit) into the reference unit (for displaying the reference price)
52 maxDiscount double maximum discount that can be applied for this item (<=100)
53 unitHint string hint 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)
54 bulkPrice double bulk price for this item. If > 0, this item has a discounted price if the buldAmount is exceeded
55 bulkAmount double this item has a discounted price if the buldAmount is exceeded
56 bulkPriceReference double reference price in reference units (bulkprice / refAmount)
57 noSubscription bool true if this item is not available for subscription
58 dateBorder date This record shows values relevant for the sessions selected delivery date. Some field may change after this date
59 brandcode string brand shortcode of the item
60 infoReferencePointers string if enabled, shows pointers to external information (ean, ecoinform, datanature
61 producerName string name of the producer of that item (translatable)
62 saleType int (aka Abverkauf), there are several saleout types, see the documentation. 0: no sale, 1: regular (forever) sale
63 brandName string name of the brand of that item (through Item/Datanature (translatable)
64 partnerId int if > 0, it is the Id of a partner that handles fulfillment
65 locationHint string Location information in a physical store. May be used to creat creative shop ideas. (translatable)

Used in endpoints

Referenced in skills

Other versions