Oldest known version of this page was edited on 2007-08-29 16:44:31 by LukeK []
Page view:
01 vAPI_build_multi_order
Wrapper to build a complete order object ready for output, takes multiple header IDs and consolodates them all into one order.
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 / soh_id_array |
YES |
Array of INTs |
-- |
each 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 |
Output Generated by vAPI_build_order |
|
|
Additional details follow: |
| $record / header / order_total |
NUMERIC |
Sum of order_total accross all order headers |
| $record / header / sub_total |
NUMERIC |
Sum of sub_total accross all order headers |
| $record / header / tax_total |
NUMERIC |
Sum of tax_total accross all order headers |
| $record / header / freight_total |
NUMERIC |
Sum of freight_total accross all order headers |
| $record / lines / row_type |
STRING |
Type of line item row. 'header': order-header subheading, 'item': normal item |
Error Codes:
Called API Functions:
notifyAPI:vAPI_build_order
Return to:
Notify_API Reference