02 vAPI_build_order

Wrapper to build a complete order object ready for output

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 / sales_order_header_id	YES	INT	--	references: sales_order_header.sales_order_header_id
$arg_array / retail_enabled	NO	BOOLEAN	--	Allows functions to operate in retail mode if applicable
$dbconn	YES	DBHANDLE	--	Database Connection

Outputs:

Output Name	Type	Details
$record	ASSOC	Details follow:
$record / header	ASSOC	Output Generated by vAPI_get_order_header
		Additional details follow:
$record / header / retail_mode	BOOLEAN	TRUE: header is using retail mode for display
$record / header / sales_tax_percent	NUMERIC	Sales Tax Percentage, generated by getTaxRateInfo
$record / header / order_taxable	BOOLEAN	TRUE: Order is taxable, FALSE: Order is not taxable
$record / header / order_total	NUMERIC	Order Total, Generated by vAPI_get_order_total
$record / header / sub_total	NUMERIC	Order Subtotal, Generated by vAPI_get_order_total
$record / header / tax_total	NUMERIC	Tax Total, Generated by vAPI_get_order_total
$record / header / freight_total	NUMERIC	Freight Total, Generated by vAPI_get_order_total
$record / lines	ASSOC	Output Generated by vAPI_get_order_body
		Additional details follow:
$record / lines / primary_bin_location	STRING	Primary Bin Location, Generated by vAPI_item_wh_locations
$record / lines / secondary_bin_location	STRING	Secondary Bin Location, Generated by vAPI_item_wh_locations
$record / lines / bin_location_1	STRING	ALT Bin Location 1, Generated by vAPI_item_wh_locations
$record / lines / bin_location_2	STRING	ALT Bin Location 2, Generated by vAPI_item_wh_locations
$record / lines / bin_location_3	STRING	ALT Bin Location 3, Generated by vAPI_item_wh_locations
$record / lines / bin_location_4	STRING	ALT Bin Location 4, Generated by vAPI_item_wh_locations
$record / lines / item_code	STRING	If lines.item_code_alias is set, that value here instead of lines.item_code
$record / lines / amount	NUMERIC	Extended price of the item
$record / company_info	ASSOC	Output Generated By vAPI_get_company
$record / customer_info	ASSOC	Output Generated By vAPI_get_customer
$record / freight_info	ASSOC	Details follow:
$record / freight_info / freight_carrier_id	NUMERIC	references: freight_carrier.freight_carrier_id
$record / freight_info / company_id	NUMERIC	references: freight_carrier.company_id
$record / freight_info / description	STRING	references: freight_carrier.description
$record / freight_info / email_tracking_text	STRING	references: freight_carrier.email_tracking_text
$record / freight_info / ltl_carrier_flag	BOOLEAN	references: freight_carrier.ltl_carrier_flag
$record / freight_info / is_active_flag	BOOLEAN	references: freight_carrier.is_active_flag
$record / freight_info / sort_order	NUMERIC	references: freight_carrier.sort_order

Error Codes:

PGQUERY

Failed SQL query

Called API Functions:
customerAPI:vAPI_get_customer
companyAPI:vAPI_get_company
salesOrderProcessingAPI:vAPI_get_order_header
salesOrderProcessingAPI:vAPI_get_order_body
itemAPI:vAPI_item_wh_locations
orderAPI:vAPI_get_order_total

Return to:
Notify_API Reference