Oldest known version of this page was edited on 2007-08-29 16:18:09 by LukeK []

33 vAPI_advanced_item_search

Advanced search through items

Inputs:

Input Name	Required	Type	Max Length	Details
$arg_array	YES	ASSOC	--	Details follow:
$arg_array / company_id	YES	INT	--	references: sales_order_header.company_id
$arg_array / customer_code	NO	STRING	--	references: customer_master.customer_code
				If supplied, item code aliases for this customer are returned
$arg_array / search_sort	NO	STRING	--	Field from which to sort results
$arg_array / search_order	NO	STRING	--	Order Type (ASC|DESC)
$arg_array / limit_override	NO	BOOLEAN	--	TRUE will override system rows returned limit
$arg_array / query_rules	YES	ARRAY of ASSOCs	--	Row Details Follow:
$arg_array / query_rules / column	YES	STRING	--	Query Rule Column - Table Column this rule is referencing
$arg_array / query_rules / value	YES	STRING	--	Query Rule Value - Value to search for in table row
$arg_array / query_rules / type	NO	STRING	--	Query Rule Type - Type of operation to search with:
				LIKE: LIKE Operation (wild card on either side)
				NOTLIKE: NOT LIKE Operation (wild card on either side)
				GTHAN: Greater-Than Operation
				LTHAN: Less-Than Operation
				BETWEEN: Between Operation (Value: 'startval|||endval')
				NOTEXACT: Is Not Equal-to operation (for non-strings)
				NOTEXACTSTR: Is Not Equal-to operation (for strings)
				EXACT: Is Not Equal-to operation (for non-strings)
				EXACTSTR: Is Equal-to operation (for strings)
				- defaults to 'EXACTSTR'
$dbconn	YES	DBHANDLE	--	Database Connection

Outputs:

Output Name	Type	Details
$record	ARRAY of ASSOCs	Row Details follow:
$record / item_code	STRING	references: item_master.item_code
$record / item_type	STRING	references: item_master.item_type
$record / ecomm_publish_flag	BOOLEAN	references: item_master.ecomm_publish_flag
$record / free_shipping_flag	BOOLEAN	references: item_master.free_shipping_flag
$record / freight_exception_flag	BOOLEAN	references: item_master.freight_exception_flag
$record / manufacturer	STRING	references: item_master.manufacturer
$record / description	STRING	references: item_master.description
$record / unit_of_measure	STRING	references: item_master.unit_of_measure
$record / unit_weight	NUMERIC	references: item_master.unit_weight
$record / last_cost	NUMERIC	references: item_master.last_cost
$record / standard_cost	NUMERIC	references: item_master.standard_cost
$record / average_cost	NUMERIC	references: item_master.average_cost
$record / retail_price	NUMERIC	references: item_master.retail_price
$record / list_price	NUMERIC	references: item_master.list_price
$record / vendor_quantity_free	NUMERIC	references: item_master.vendor_quantity_free
$record / vendor_due_in	NUMERIC	references: item_master.vendor_due_in
$record / added_by	STRING	references: item_master.added_by
$record / date_added	DATE	references: item_master.date_added
		format: YYYY-MM-DD
$record / modified_by	STRING	references: item_master.modified_by
$record / last_date_modified	DATE	references: item_master.last_date_modified
		format: YYYY-MM-DD
$record / last_po_date	DATE	Last date_entered recorded in po_header
		format: YYYY-MM-DD
$record / quantity_free	NUMERIC	references: item_warehouse.quantity_free
		sum across all warehouses
$record / quantity_due_in	NUMERIC	references: item_warehouse.quantity_due_in
		sum across all warehouses
$record / quantity_on_hand	NUMERIC	references: item_warehouse.quantity_on_hand
		sum across all warehouses
$record / quantity_allocated	NUMERIC	references: item_warehouse.quantity_allocated
		sum across all warehouses
$record / quantity_on_backorder	NUMERIC	references: item_warehouse.quantity_on_backorder
		sum across all warehouses
$record / item_code_aliases	STRING	comma-separated list of all records in item_aliases for this customer

Error Codes:

PGQUERY

Failed SQL query

Return to:
Item_API Reference