als_get_products.cgi

The als_get_products.cgi interface will retrieve all Product and information about those products i.e.( Vendor, Category, Location ) available to in your system based on if the products that are active and web enabled.

A Note about Products: By default AL-Desk products are defined to not be available to the AL-Desk Web Portal. This is done by design to allow AL-Desk administrators to have full control over what products will be shown on the web site. Products must be tagged as being available to the web portal interface.

Parameter	Description	Required	Example	Data Type
Location	Location Code to limit the result set to a specific location See also als_get_locations.cgi for Location Codes	Optional	location=5	Integer
Category	Category Code to limit the result set to a specific category See also als_get_categories.cgi for Category Codes	Optional	category=2	Integer
Vendor	Vendor to limit the result set to a specific location See also als_get_vendors.cgi for Vendor Codes	Optional	vendor=4	Integer
Product	Product Code to limit the result to a specific product	Option	product=1	Integer
includedesc	Includes Expanded Description Information.	Optional	includedesc=true	Boolean
content=true	Includes Content Management Information	Optional	content=true	Boolean
nodefaultcontent	To limit content to NOT include product default content	Optional	nodefaultcontent=true	Boolean
productsearch	Searches product Name for match	Optional	productsearch=golf	String
descriptionsearch	Searches product Description for match	Optional	descriptionsearch=golf	String
categorygroup	CategoryGroup code to limit the reusult to a specific category group	Optional	categorygroup=1	Integer
contentname	allows the content Manager to be invoked to manage Content Product Lists.	Optional	contentname=topten	String
inactive	Used only if you are writing a product management system that maintains products via a web interface and need to handle products tagged as inactive. Note this may include products not marked to be handled via a web interface.	Optional	inactive=true	Boolean

#	Field Name	Description	Data Type
1	Code	AL-Desk Associated Code	Integer
2	Name	Name of the Product	String
3	Vendor	AL-Desk Associated Code	Integer
4	VendorName	Name of the Vendor	String
5	Location	AL-Desk Associated Code	Integer
6	LocationName	Name of the Location	String
7	Category	Product Category AL-Desk Associated Code	Integer
8	CategoryName	Name of the Category	String
9	WebJPGLocation	Product Picture. Location path	String
10	Description	Product Description if includedesc=true is invoked	String
11	Voucher Notes	Voucher Notes included if includedesc=true is invoked	String