If_ItemDetail
If_ItemDetail interface provides commands to view and manage item records
|
| load | | This is called to load an item into the item detail viewer: | | | | Required arguments: | | item_id - The item ID# | | | | This returns 'yes' or 'no' depending on whether the item was loaded. |
|
| These are commands to print/get info about the current item
All of these that print something support 'prefix' and 'postfix'. |
|
| isonsale | | Returns 'yes' or 'no' depending on whether item is on sale |
|
| ishot | | Returns 'yes' or 'no' depending on whether item is hot |
|
|
| longdesc | | Prints item long description |
|
| shortdesc | | Prints short description |
|
| tinydesc | | Prints tiny description |
|
| feature | | Prints item feature |
|
| unit | | Prints item_unit field |
|
| shortdescquiet | | Returns short description |
|
|
| getpartno | | Returns item part number |
|
| date | | Prints & formats item last modifified date |
|
| articlefile | | Prints the article file |
|
| hasphoto | | Returns 'yes' or 'no' depending on whether the item has a photo |
|
| photo | | Prints item photo with imageprefix | | Caller is responsible for putting image tags in prefix and postfix | | The 'blankimage' attribute should be the full URL path to the image | | to use for blank or null image fields. |
|
| tnphoto | | Same as above for tiny photo |
|
| price | | Prints and returns item price |
|
| saleprice | | Prints and returns item sale price |
|
| itemid | | Prints and returns item ID |
|
| cli_id | | Prints and returns cli_id and emp_id |
|
| partno | | Prints and returns item part # |
|
| venpartno | | Prints and returns item vendor part # |
|
| getcategory | | This returns the name of a category of a given depth | | | | Arguments: | | depth=category depth, starts at 1 |
|
| templatesummaryitemlist | | This is a template summary part list. It lists all summary parts for the currently loaded item. Returns 'ok' or 'error:...'. | | | | Template variables: | | ##NAME## - Summary part name | | ##FEATURE## - Item feature field | | ##PRICE## - Price of item | | ##PHOTO## - URL to photo | | ##TNPHOTO## - URL to thumbnail photo | | ##ISONSALE## - 1 or 0 depending on whether item is on sale | | ##ISHOT## - 1 or 0 depending on whether item is hot | | ##DESC## - Description | | ##SHDESC## - Short description | | ##TNDESC## - Tiny description | | ##ID## - Item ID | | ##CLI_ID## - Client Owner | | ##EMP_ID## - Employee Owner | | ##PARTNO## - Part number | | ##SALEPRICE## - Item sale price | | ##UNIT## - Item unit field | | ##ALT## - Alternates between 0 and 1 | | ##CTR## - List counter, starts at 0 | | | | Arguments: | | template - Template to use to generate list (required) | | blankimage - Image to use for missing photo (default=blank.gif) | | altcat - Altcat spec (default=none) |
|
| summaryitemcount | | Returns the count of how many clone/sub items exist for this summary item | | | | Arguments: | | altcat - Altcat spec (default=none) |
|