rb.catalogue.item.itemInfoType

Main catalogue item or product including prices, associated file identifiers and custom data.

Elements

The rb.catalogue.item.itemInfoType struct has 15 elements:

Name	Type/Value	Range/Length	Description
itemID	number	integer	Optional. System assigned identifier of item. Required for modify() and when adding more prices and/or file associations to an item using create(). Added into the interface from version 0.9.36.
code	string	1..250	Optional. Item code. Required for create().
type	string	0..30	Optional. Short classification string to allow applications to distinguish between different 'things' stored in catalogue items.
name	string	0..250	Optional. Item name. Optional field in which to store a user-readable name for this product (as distinct from the code field).
description	string	0..1000	Optional. Description of the item. Required for create().
keywords	string	0..250	Optional. Predetermined words with which item can be searched.
containerMkr	number	1 = container, 2 = contained, 3 = self-contained or ungrouped item.	Optional. System assigned (read-only) marker indicating membership of and status within a group of items.
containerID	number	Valid itemID	Optional. Identifier of the containing item which is itemID of a self-contained or container item. Required only if adding an item to a group (i.e. making it contained) using create() or modify() and if removing or transferring an item from a group (making it self-contained or contained) using modify().
itemData	MetaData	0-200K	Optional. Buffer for custom item information.
stockData	MetaData	0-200K	Optional. Buffer for custom stock information for item.
fileRefs	array of struct item.fileRefTypes	see definition	Optional. Array of binary file associations for item.
prices	array of struct item.priceInfoTypes	see definition	Optional. Array of price information for item.
modifiedTime	number	date	Optional. Timestamp (milliseconds since epoch) representing the time at which this item was last saved. Added into the interface from version 0.9.35.
relevance	number		Optional. Read-only - returned when search method is 'rank'. Returns the number of keywords that appeared in the selected search area Added into the interface from version 1.1.0.
nodeCount	number		Optional. Read-only - returned when bit 3 (8) of allData is set, or 'sortBy' is 'nodes'. Returns the number of matching nodes to which this item is linked. If 'isItemInNodes' is not used then this field will be the number of nodes to which this item is linked, otherwise it is the count of nodes in the list to which this node is linked.

Remarks

By default, a new item is an 'orphan' item (i.e. implicitly linked to the virtual root node) until it is explicitly linked to one or more category nodes. Also, a new item will have containerMkr=2 or 3 (indicating contained or self-contained) if containerID is set or is undefined respectively.

Note from version 0.9.35 the size of the 'code', 'description' and 'keywords' attributes have been increased to 250 characters.