Most recent edit on 2007-08-29 15:16:36 by LukeK

No differences.

---

Edited on 2007-08-28 15:39:28 by LukeK

Additions:
Return to:
Item_API Reference

---

Oldest known version of this page was edited on 2007-08-28 15:38:14 by LukeK []

01 vAPI_add_edit_item

Add or edit item record

Inputs:

Input Name	Required	Type	Max Length	Details
$arg_array	YES	ASSOC	--	Details follow:
$arg_array / company_id	YES	INT	--	references: company_master.company_id
$arg_array / employee_id	YES	INT	--	references: employee_maser.employee_id
$arg_array / vendor_code	YES	STRING	25	references: vendor_master.vendor_code
$arg_array / item_code	YES	STRING	32	references: item_master.item_code
$arg_array / vendor_item_code	YES	STRING	32	references: item_master.vendor_item_code
$arg_array / substitute_item_code	YES	STRING	32	references: item_master.substitute_item_code
$arg_array / item_type	YES	ENUM	--	references: item_master.item_type
				I: Item
				A: Assembly
				D: Drop-ship
$arg_array / product_class	YES	STRING	16	references: item_master.product_class
$arg_array / manufacturer	YES	STRING	32	references: item_master.manufacturer
$arg_array / default_warehouse_code	YES	STRING	8	references: warehouse_master.warehouse_code
$arg_array / description	YES	STRING	75	references: item_master.description
$arg_array / ecomm_publish_flag	YES	BOOLEAN	--	references: item_master.ecomm_publish_flag
$arg_array / consignment_flag	YES	BOOLEAN	--	references: item_master.consignment_flag
$arg_array / lead_in_description	YES	TEXT	--	references: item_master.lead_in_description
$arg_array / extended_description	YES	TEXT	--	references: item_master.extended_description
$arg_array / autoformat_description	YES	BOOLEAN	--	references: item_master.autoformat_description
$arg_array / unit_of_measure	YES	STRING	16	references: item_master.unit_of_measure
				Valid values are stored as a config variable
$arg_array / unit_weight	YES	NUMERIC	8.2	references: item_master.unit_weight
$arg_array / standard_pack	YES	INT	--	references: item_master.standard_pack
$arg_array / buy_ratio	YES	INT	--	references: item_master.buy_ratio
$arg_array / shipping_class	YES	INT	--	references: item_master.shipping_class
$arg_array / package_dim_length	YES	NUMERIC	8.2	references: item_master.package_dim_length
$arg_array / package_dim_width	YES	NUMERIC	8.2	references: item_master.package_dim_width
$arg_array / package_dim_height	YES	NUMERIC	8.2	references: item_master.package_dim_height
$arg_array / retail_price	YES	NUMERIC	15.5	references: item_master.retail_price
$arg_array / list_price	YES	NUMERIC	15.5	references: item_master.list_price
$arg_array / last_cost	YES	NUMERIC	15.5	references: item_master.last_cost
$arg_array / average_cost	YES	NUMERIC	15.5	references: item_master.average_cost
$arg_array / standard_cost	YES	NUMERIC	15.5	references: item_master.standard_cost
$arg_array / item_matrix	YES	NUMERIC	3.0	references: item_master.item_matrix
				Valid values: 0 - 999
$arg_array / taxable_flag	YES	BOOLEAN	--	references: item_master.taxable_flag
$arg_array / active_flag	YES	BOOLEAN	--	references: item_master.active_flag
$arg_array / freight_exception_flag	YES	BOOLEAN	--	references: item_master.freight_exception_flag
$arg_array / free_shipping_flag	YES	STRING	1	Detail: F: Ineligible for free shipping, T: Ships for free, E: Eligible
				references: item_master.free_shipping_flag
$arg_array / vendor_quantity_free	YES	NUMERIC	15.3	references: item_master.vendor_quantity_free
$arg_array / vendor_due_in	YES	NUMERIC	15.3	references: item_master.vendor_due_in
$arg_array / purchase_group	NO	INT	--	references: item_master.purchase_group
$arg_array / purchase_multiplier_group	NO	INT	--	references: item_master.purchase_multiplier_group
$arg_array / product_group	YES	INT	--	references: item_master.product_group
$arg_array / product_sub_group	YES	INT	--	references: item_master.product_sub_group
$arg_array / vendor_group	YES	INT	--	references: item_master.vendor_group
$arg_array / vendor_sub_group	YES	INT	--	references: item_master.vendor_sub_group
$arg_array / upc_code	YES	STRING	20	references: item_master.upc_code
$arg_array / cost_pool	YES	INT	--	references: item_master.cost_pool
$arg_array / base_cost	YES	NUMERIC	15.5	references: item_master.base_costxs
$arg_array / qty_break_1_amount	NO	INT	--	references: item_master.qty_break_1
$arg_array / qty_break_1_percent	NO	NUMERIC	6.4	references: item_master.qty_break_1
$arg_array / qty_break_2_amount	NO	INT	--	references: item_master.qty_break_2
$arg_array / qty_break_2_percent	NO	NUMERIC	6.4	references: item_master.qty_break_2
$arg_array / qty_break_3_amount	NO	INT	--	references: item_master.qty_break_3
$arg_array / qty_break_3_percent	NO	NUMERIC	6.4	references: item_master.qty_break_3
$arg_array / qty_break_4_amount	NO	INT	--	references: item_master.qty_break_4
$arg_array / qty_break_4_percent	NO	NUMERIC	6.4	references: item_master.qty_break_4
$arg_array / qty_break_5_amount	NO	INT	--	references: item_master.qty_break_5
$arg_array / qty_break_5_percent	NO	NUMERIC	6.4	references: item_master.qty_break_5
$arg_array / qty_break_6_amount	NO	INT	--	references: item_master.qty_break_6
$arg_array / qty_break_6_percent	NO	NUMERIC	6.4	references: item_master.qty_break_6
$arg_array / qty_break_7_amount	NO	INT	--	references: item_master.qty_break_7
$arg_array / qty_break_7_percent	NO	NUMERIC	6.4	references: item_master.qty_break_7
$arg_array / qty_break_8_amount	NO	INT	--	references: item_master.qty_break_8
$arg_array / qty_break_8_percent	NO	NUMERIC	6.4	references: item_master.qty_break_8
$arg_array / product_code	NO	STRING	32	references: item_master.product_code
$arg_array / thumbnail_image	NO	STRING	254	references: item_master.thumbnail_image
$arg_array / fullsize_image	NO	STRING	254	references: item_master.fullsize_image
$arg_array / display_template	NO	STRING	254	references: item_master.display_template
$arg_array / update_cost_allowed	NO	BOOLEAN	--	Whether supplied user has permissions to update stock
				NOTE: This will go away once permissions are in place
$dbconn	YES	DBHANDLE	--	Database Connection

Outputs:

Output Name	Type	Details
$record	ASSOC	Details follow:
$record / action	STRING	ADD: New record was added
		EDIT: Existing record was updated

Error Codes:

PGQUERY	Failed SQL query
NO_PERMISSION	User lacks sufficient permissions
INVALID_ITEM_TYPE	Item Type Is Invalid
INVALID_SUBSTITUTE_ITEM_CODE	Substitute Item Code Is Invalid
CHECKPOINT	Error when calling the checkpoint function

Called API Functions:
logAPI:vAPI_checkpoint_table_revision
itemAPI:vAPI_validate_item_code
itemAPI:vAPI_add_edit_item_simto