Product Resource

This resource describes details of a single Product

"K". The field physkey is expected in the "k" (key) parameter for FD1 edit functions.

Available Fields

Name	Description	Datatype	Resource	"q"
pid		Number
description	Shopper friendly description of item as might be printed on receipts and invoices	String
shortname	A short product description that can be used where space to print may be limited	String
price	Retail Price. List/base price as shown when price is requested, but may not be actual price charged to customer. This price is typically tax inclusive	Money/Currency
spid		Number
plu	PLU code used by retailer to quickly locate a product. PLU codes are generally considered retailer specific although some industry standardisation does exist.	String
depid	Department Id used to group this product into a broad area	Number
cost	Last known cost price of single item, typically exclusive of tax	Money/Currency
purchasecontrol		Number
pom		Number
measurement	Unit of measure for this product. Is the product a 'unit' or measured in Kg, gm, L, time ....	Number
taxflag		Number
displaymeasurement	Unit of measure to be used for display purposes.	Number
billofmaterialsid		Number
freight	Last known freight allocation for this product, exclusive of tax	Money/Currency
priceband1	An alternative price step that allows customers or stores to use alternative 'bands'
packaging	Last known packaging allocation for this product, exclusive of tax	Money/Currency
sellflags		Number
nosell	Disable product from being sold
nodelete	Item cannot be deleted from sale once added
nolookupsell	Disable product from being selected from a list for selling. Some products have specific process flows that must be followed and while the product should appear on a list it cannot simply be selected. For example in fuel stations petrol can only be sold via a pump controller interface.
qohzero	When showing Quantity On Hand to staff, system should show zero at sales counters
hidden	Indicates a hidden product that isn't immediately visible
writeoffreturn	If this item is returned from a customer it should automatically be written off. Typically used on food products that cannot be resold.
promptserial	Prompt for serial numbers whenever sold.
isvariant	This item is tracked by variant or issue#. A variant is a specifically numbered attribute, such as monthly issues of a magazine.
mustprint	Indicates that a physical (or email) receipt must be generated if this item is included in the sale
ingredient
noreports	A suggestion to reporting that this item should not normally be included. Reports are free to honour or ignore this flag
nodiscount		Number
category0		Number
category1		Number
stockimportance	A number from 1 to 10 indicating broad level of importance of this product. This value is manually set and often used as a broad sorting order	Number
nolevels	Stock levels are ignored on this product. The system may still attempt to maintain them but they are not considered important or used in reconcilations.
supplierlocked	The supplier for this product is considered locked and should not be changed except via explicit user action. This does not mean the supplier cannot be changed, only that it is not done if the system detects a different supplier.
webgroup	The broad group this product should be placed on an eCommerce site
bookauthor	Book author
isbn	Standard ISBN number for books and publications. Provided in full
noloyalty	This item is not to be included in loyalty calculations for a customer
supplysrc	Where is product broadly supplied from
promptemployee	When sold causes system to ask for an employee name to be recorded against this sale item. This might be used to record which employee delivered a service product.
publish	Allow product to be visible to external public systems such as customer websites	Number
deleted	Indicates item has been deleted from the system and can only be used for historic reporting
tracked	Each individual item is tracked through the system.
promptprice	Price should be asked every time item is sold. Used on items that do not have set pricing. Items that are normally sold in variable quantities using scales do not require this attribute set, as the quantity is changing not the underlying price.
retired	Product is going, can be sold but not ordered
photocust
photostaff
storepricing
returnpromptwriteoff
semihidden	Product is halfway between hidden and visible. Typically resulting in it being shown with a faded effect on search screens
withdrawn	Product has been withdrawn from sale
physkey		String
partcount	Number of parts that make up this item. Used for tracked items only.
printedname	How item is to be printed on warehouse labels
packagingweight	A weight to be subtracted from any measured weight before the weight of the item is processed. This permits an estimate of the weight of the packaging to be excluded from pricing.
consignment
returntype
fractions
poscommand		String
createdt
priority	Relative priority for ordering and stock control purposes. Products can be assigned to "Core", "On Special", "Other", "Retiring" or "Normal".
ordermessage	A message that is shown when item is being ordered. Allows communication between a stock controller and ordering staff on a per product basis
noorder	This product cannot be ordered, it has been manually blocked. Typically used on products you wish to retire
minorderqty	A minimum quantity of items that can be ordered. This value is the retailers minimum and suppliers may apply different minimums.
maxorderqty	A maximum quantity of items that can be ordered on a single order. This is the retailers maximum, not a supplier maximum. Typically used to control over ordering.
retirestart	The date this product was placed in retirement state
retireend	The date this product will end retirement and enter the deleted state
removaldt	The date after which is item can be physically removed from remote systems.
shelflabelline1	The first line to be placed on a shelf label
shelflabelline2	The second line to be placed on a shelf label
shelflabelline3	The third line to be placed on a shelf label
perishable	Indicates that product is perishable
polarised	Indicates this item is polarised
mirrored	Indicates this item has mirror finishing
mktgcolor1	A descriptive colour used for marketing descriptions
mktgcolor2	A descriptive colour used for marketing descriptions
mktgcolor3	A descriptive colour used for marketing descriptions
mktgcolor4	A descriptive colour used for marketing descriptions
placement	A general indication of where this item might be found in a store
organiccertid	Organic Certification
puburlinst	An internet URL containing installation instructions. Typically used as part of receipts to aid customers
puburlterms	An internet URL containing terms and conditions for warranties or guarantees. Typically used as part of receipts to aid customers
puburlupsell	An internet URL containing additional offers for purchasers of a product. May contain accesories (eg "Carry case", "Desktop stand") or spare parts ("Replacement bulb").
puburlmarketing	An internet URL with marketing details of this product. Typically would be included on a quotation to refer them to you website.
ordericons	Bitmask indicating additional icons to be displayed when on ordering screens, where supported.
rve	Internal system field used for replication, ignore this field.	Double
nationalproduct
processflags
totaloneod	Should total sales, if any, be printed on End of Day
itemiseoneod	Should each sale line, if any, be listed on End of Day
comments	Internal general purpose product specific comments	String
recordlevels	Stock levels are specifically enabled on this product regardless of other options saying not to record them
priceband2	An alternative price step that allows customers or stores to use alternative 'bands'
priceband3	An alternative price step that allows customers or stores to use alternative 'bands'
priceband4	An alternative price step that allows customers or stores to use alternative 'bands'
priceband5	An alternative price step that allows customers or stores to use alternative 'bands'
priceband6	An alternative price step that allows customers or stores to use alternative 'bands'
priceband7	An alternative price step that allows customers or stores to use alternative 'bands'
priceband8	An alternative price step that allows customers or stores to use alternative 'bands'
priceband9	An alternative price step that allows customers or stores to use alternative 'bands'
priceband10	An alternative price step that allows customers or stores to use alternative 'bands'
priceband11	An alternative price step that allows customers or stores to use alternative 'bands'
priceband12	An alternative price step that allows customers or stores to use alternative 'bands'
pageyield	Number of pages this product can print or produce	String
manupartcode	The part code assigned by the original manufacturer	String
publishtype	A coded number indicating how this product should be used on a website. 0=normal selling item. 1=display purposes only, cannot be added to shopping trolleys	Number
websearchrank	Suggested ranking order to display on a web search page. 1=highest	Number
sellingmsg	Simple text message displayed on screen when item sold	String
websitecontrol	Free form text that is sent to website as an indicator for programs. Do not use for general product details
webdisplayrank	Suggested display order to display on a web. 1=highest/first
reorderlevel		Number
reordermax		Number
glcode
needpriceconfirm
pricefollowspricebook
franchiseprice	Franchise Retail Price. Price recommended by head office or franchise owner. This price is not used as part of selling process directly.	Money/Currency
proddef		Number
vintage
ordercategory
globalkey
glacct
gldesc
nonstock
maxpurchase
nocredit
foreignprice
foreigncurrency
siteprice1
siteprice2
siteprice3
transferprice
landedprice
extractflags		Number
extractzerocost	External extract programs should extract at zero cost
extractdisabled	External extract programs should not extract the product
extractsite1	Reserved for site specific extracts
decimalplaces	Overrides number of decimal places to print for a product	Number
model		String
shelflabelformat		String
depid2	Department Id(2) used to group this product into a broad area	Number
depid3	Department Id(3) used to group this product into a broad area	Number
depid4	Department Id(4) used to group this product into a broad area	Number
length	Length in mm of product	Number
width	Width in mm of product	Number
height	Height in mm of product	Number
shippingcubic	Shipping size in cubic metres	Double
itemcolor	Color of the item itself. A red pen packaged in a blue box would have red in this field	String
cartridge	Name of the cartridge used by this product	String
categorisationflags		Number
refillable	This item can be refilled
internalsupporturl	A url reference for this product to an internal web page that may contain additional information	String
bluelight	Mark a product as having blue light attribute. Typically used in the eyewear industry	Number
releasedate	The date this product is released into your store. Typically used for eCommerce sites	DateTime
availablefromdate	The date this product is available for purchase. Typically used for eCommerce sites. This date does not stop the POS from selling the item, but a future release might prompt for verification	DateTime
classificationflags		Number
sport
lifestyle
fastfashion
highfashion
technical
depid5	Department Id(5) used to group this product into a broad area	Number
depid6	Department Id(6) used to group this product into a broad area	Number
depid7	Department Id(7) used to group this product into a broad area	Number
depid8	Department Id(8) used to group this product into a broad area	Number
supplierrrp	RRP as outlined by a supplier or manufacturer	Money/Currency
wholesaleprice1	A wholesale price, whatever that means within your environment	Money/Currency
wholesaleprice2	A wholesale price, whatever that means within your environment	Money/Currency
wholesaleprice3	A wholesale price, whatever that means within your environment	Money/Currency
wholesaleprice4	A wholesale price, whatever that means within your environment	Money/Currency
rxable	Can this item be used as part of a prescription	Number
productcase	Product that is the case of this item	String
warranty	Short warranty description as might be printed on customer receipts	String
productmanufacturer	The original manufacturer of this item	String
preposcommand	PosCommand issued before item is added to sale. When used, the product is not usually automatically added to the sale.	String
firmware	Current firmware level of product. Typically used as part of product lookup and checking	String
sellingmsgdist	Simple text message provided by central server that is displayed on screen when item sold.
sellcondition	A control applied to the product when selected for selling to ensure current POS is able to sell this item.	String
applydatetime	A future datetime that this update should be applied. Changes requested are buffered until this time
taxscalefactor	An approximation of a ratio to multiple price by to remove tax
siteadditionalinfo
sitebulkqty
sitecartridgeid		Number
checksheetreqd
ltsapmtnoreqd
regnoreqd
brand	Brand Name. The actual textual description of the brand.	String
weightgm	Weight, in Grams	Number
commonsizes	Pipe seperated list of common packaging sizes for non unit items. For example carrots may be commonly sold in 500gm and 1Kg bags, in which case this field would contain "500|1000"
size	Size of this item in terms relating to the item, eg SM, M, L, XL, XXL or Single, Double, Queen, King
maincolour	Main colour of item packaging if only one single colour was to be named. A red pen packaged in a blue box would have blue in this field	Number
knownbrandid	Reference to standard brand names. Rarely used
madefrom	List of materials this item is made from
designshape	Shape of the item
backcolor	Preferred background color for this item. This provides a color triple (in HTML #RRGGBB format) that can be used for this product. If product priority (f220) is used, then those colours will be used first, otherwise department colours and defined colours will be used.
pricefloor	Lowest price this item can be sold for by any staff member
pricelimit1	Lowest price for selling by staff holding security right limit-band-1
pricelimit2	Lowest price for selling by staff holding security right limit-band-2
pricelimit3	Lowest price for selling by staff holding security right limit-band-3
pricelimit4	Lowest price for selling by staff holding security right limit-band-4
pricelimit5	Lowest price for selling by staff holding security right limit-band-5
webdescription	English. Descriptive text of item. Short. Expected to be less than 200 letters. Typical use is under reference images on menu pages
webgroupstack
webonspecial	Special indicator. Used by Websites to indicate product should be marked on special or other agreed purpose.	Number
webonlyinstore	Only available instore indicator. Used to indicate to websites that this product should be marked in-store purchase only
webhighlight	Highlight indicator. Used by Websites as a suggestion they should prioritise or highlight this product.
webblurb
isglutenfree	Gluten Free Indicator	Number
isorganic	Organic Indicator
isdairyfree	Dairy Free Indicator
islowsugar	Low Sugar Indicator
isvegan	Vegan Indicator	Number
islowsalt	Low Salt Indicator
isyeastfree	Yeast Free Indicator
islowfat	Low Fat Indicator
israw	Raw/Unprocessed Indicator
iskosher	Kosher Indicator
isedible	Edible Indicator, set to 1 for edible products
fairtrade	Fair Trade Indicator.
countrymade	Country of Manufacture (GDS Country Codes)
nzmade	New Zealand made indicator
lenstype
nzaus_1067		Number
promptregno	Prompt Vehicle registration number
promptltnzno	Prompt LTNZ Reference number
promptdocument	Prompt for external document serial number. This is used for serialised forms that are used as part of selling this item.
promptcustomer	Prompt Customer Details
gender	Person gender this product is mainly designed for. This is about the product, not the customers gender preference
webhighlightflags		Number
websitefeatured	Mark this product as featured to the website
websitepromote	Mark this product to be promoted on the website
websitebackgrounditem
websitepositiontop
websitepositionleft
websitepositionbottom
websitepositionright
websitetag	A short phrase or single word 'tag' that might be applied to a product. Examples might be 'new' 'on special' 'reduced'	String