Item Details
Beside the Information in the API Response Type, additional information may be available that is collected internally from different sources.
core item data
Please check the Item Response type for the core fields. Some non-obvious notes here.
| Field | Description |
|---|---|
| Item.weighted | Fresh goods are often weighted. This hint should be shown near the item, but is useful in the cart as well. |
| Item.alcohol: Same, show it in the cart too. Some countries may have addiitonal rules when selling alcoholics online. |
item types
Item.type tells what kind of item this is. Only the types below are relevant for a shop frontend; any other value is an internal
type (vouchers, discounts, placeholders, ...) that is handled by the server and never shown as a regular item.
| type | Name | Description |
|---|---|---|
| 0 | Regular item | Normal, physically delivered item. Item.pointer holds the unit id reference. |
| 2 | Organisation item | Internal item, used by the backend for bookkeeping. Not copied into new shop orders. |
| 3 | Supplementary main ingredient | Delivered item that is added without an availability check. |
| 4 | Key | The item represents a key (e.g. for a depot / pick-up box). |
| 10 | Recipe, not resolvable | Delivered recipe item. It can not be resolved into its component items. |
| 11 | Recipe, resolvable | Delivered recipe item. It may be resolved into its component items. |
| 12 | Package, not resolvable | Package (bundle) item. It can not be resolved into its component items. |
| 13 | Package, resolvable | Package (bundle) item. It may be resolved into its component items. |
| 14 | School fruit, not resolvable | School fruit program item. It can not be resolved into its component items. |
| 15 | School fruit, resolvable | School fruit program item. It may be resolved into its component items. |
| 16 | Gift basket, not resolvable | Gift basket. It can not be resolved into its component items. |
| 17 | Gift basket, resolvable | Gift basket. It may be resolved into its component items. |
| 20 | Pointer: subscription type | Links to a subscription type (Abo box). Item.pointer is the target id. |
| 21 | Pointer: subscription type group | Links to a group of subscription types. Item.pointer is the target id. |
| 22 | Pointer: price list | Links to a price list (rubric). Item.pointer is the target id. |
| 23 | Pointer: group | Links to an item group. Item.pointer is the target id. |
| 24 | Pointer: subgroup | Links to an item subgroup. Item.pointer is the target id. |
| 25 | Pointer: navigation | Links to a main navigation entry. Item.pointer is the target id. |
| 26 | Pointer: subscription content group | Links to a subscription content group. Item.pointer is the target id. |
| 27 | Pointer: URL | Links to an external page. Item.pointer is the URL. |
| 78 | Donation | Donation item. |
Pointer items (20 - 27) are not sold. They are placed in the assortment as a navigation aid: render them as a link to the target instead of an item with price and cart button. Resolvable items (11, 13, 15, 17) may be expanded into their component items, e.g. to let the customer see or adapt the content.
Referenced in the Item Response Type
Indicators for more data is in the Item Response Type:
| Indicator | /endpoint/Url | |
|---|---|---|
| Item.hasLongInfo | if true, long information (typically maintained in the backend PCG system manually) can be fetched | /embed/info.jsp?itemid=ITEMID |
| Item.producerid | if > 0 , we know more about the producer. It typically will match Item.producerName, Item.brandcode and Item.brandName | embed/info1.html?itemid=ITEMID |
| Item.infoReference=1 | more data from the Ecoinform data provider is available (*) | /embed/eco.jsp?id=ITEMID |
| Item.infoReference=2 | more data from the DataNatuRe data provider is available (*) | /embed/inc_dnr_detail.jsp?itemid=ITEMID |
| Item.imageCode | if set, a (big) image exists. See the api doc on how to fetch it using the proxy endpoint | Use the imageproxy: /b.px?bs.id=ITEMID&PARAMS |
| Item.thumbnailCode | if set, a (small) image exists. See the api doc on how to fetch it using the proxy endpoint | Use the imageproxy: /t.px?bs.id=ITEMID&PARAMS |
| Item.imageCount | if > 0, it gives the number of extra images assigned to an item. You may render them as gallery. | Use the imageproxy: /bNUM.px?bs.id=ITEMID&PARAMS |
| Item.verband | Certification association. The provided well known codes will be translated into Icons in a web shop. | Use the imageproxy: /ab.px?bs.i=CODE&bs.w=0&bs.h=0 (note: bs.i, not bs.id) |
| Item.euorigin | The codes PGI, TSG or PDO translate to the three eu origin markers. The field may carry the protected name after a colon (e.g. "PDO:Capri"). | Use the imageproxy to obtain the official icons: /eu.px?bs.i=CODE&bs.w=0&bs.h=0 (note: bs.i, not bs.id) |
(*) You must have a contract with us (Oekobox-Online.de) in order to use this data. This implies, that you are selling these items and that you obtained them from a vendor or reseller that you have a contract with.
ITEMID and PARAMS must be replaced accordingly.
Additionally referenced using labels:
| Indicator | |
|---|---|
| Item.originId | references origins (provided as Label) |
| Item.labels | a int array with label ids. . |
Details can be obtained as part of Navigation response See how to use labels
Referenced in other Response Types
Item calls response not only with the items, but also accompanying data for the returned item set.