Application Programming Interface (API) Guide

Transcription

1 Application Programming Interface (API) Guide 1

2 Table of Contents Release Notes Introduction...9 Prerequisites,...9 Installation Instructions.. 9 API Support Policy Using the M.O.M. API. 13 API Functions Frequently Asked Questions..198 Appendix A (Sample Code)..199 Appendix B (Data Dictionary) Reference 337 2

3 Release Notes Version Date Notes /27/2012 Product Attribute related functions o Product_Attribute_Create() o Product_Attribute_Data_Get_XML() o Product_Attribute_Delete() o Product_Attribute_Info() o Product_Attribute_Mapping_Create() o Product_Attribute_Mapping_Data_Get_XML() o Product_Attribute_Mapping_Delete() o Product_Attribute_Mapping_Info() o Product_Attribute_Value_Create() o Product_Attribute_Value_Delete() o Product_Attribute_Value_Info() Miva related functions: o Product_Miva_SKU_Create() o Product_Miva_SKU_Info() o Product_Miva_SKU_Data_Get_XML() o Product_Miva_FeedMgr_Create() o Product_Miva_FeedMgr_Delete() o Product_Miva_FeedMgr_Info() o Product_Miva_FeedMgr_Get_XML() Purchase related functions: o Purchase_Receive_Product_All() o PurDetail_Receive_Product() o PurDetail_Deliverto() Inventory related functions: o Inventory_Process_Updates() Tax related functions: o Tax_SalesTaxRate_Avalara() /20/2012 Patch Release Fixed issue with DB_CONNECT_VFP() function. The build, version, and license properties were not being set after call to function. Product_Miva_SKU_Create(). Fixed issue with SKU parameter is being ignored when MIVA tables are created. It was following MOM s default behavior of using the 1 st 10 characters of the MOM stock Item Number. Also, fixed COM Exception when the system is using a VFP backend. Product_Miva_FeedMgr_Info(). COMException occurs when a stock item number already exists in FeedMgr table. 3

4 Product_Miva_FeedMgr_Get_XML(). Changed input parameter to be the MOM Stock Item Number instead of the MIVA Sku. Fix COMException with mom_api.momparams object. Miva related functions: Product_Miva_SKU_Create() Product_Miva_SKU_Info() Product_Miva_SKU_Data_Get_XML() Product_Miva_FeedMgr_Create() Product_Miva_FeedMgr_Delete() Product_Miva_FeedMgr_Info() Product_Miva_FeedMgr_Get_XML() 4

5 /02/2012 Patch Release Fix COM Exception was unhandled error: Creating an instance of the COM component with CLSID {97EDD E89- A344-3F344F00E93D} from the IClassFactory failed due to the following error: /21/2012 Shipping related functions: Get shipping method Shipping_Method_Get_XML() Shipping_Method_Set_Data_Pull() Shipping_Method_Get_Data_Pull() Accounting related functions: Get Credit Card Merchant Accounts Accounting_CCMerchantAccount_Get_XML Accounting_CCMerchantAccount _Set_Data_Pull () Accounting_CCMerchantAccount_Get_Data_Pul () Update sales tax rates Tax_National_SalesTaxRate() Tax_State_SalesTaxRate() Tax_County_SalesTaxRate() Tax_Zip_SalesTaxRate() Output sales tax rates Tax_National_SalesTaxRate_Get_XML() Tax_National_SalesTaxRate_Set_Data_Pul() Tax_National_SalesTaxRate_Get_Data_Pul () Tax_State_SalesTaxRate_Get_XML () Tax_State_SalesTaxRate_Set_Data_Pull() Tax_State_SalesTaxRate_Get_Data_Pul () Tax_County_SalesTaxRate_Get_XML () Tax_County_SalesTaxRate_Set_Data_Pull () Tax_County_SalesTaxRate_Get_Data_Pul () Tax_Zip_SalesTaxRate_Get_XML () Tax_Zip_SalesTaxRate_Set_Data_Pull () Tax_Zip_SalesTaxRate_Get_Data_Pul () Order related functions: Order_Payment_PP() Allow paypal orders. Order_Payment_CC_Ex() Allow Pre-paid Credit Cards Bug fixes Shipping is not updated using Order_Shipping() with llshipmodify parameter. Price is not updated when using OrdDetail_Create() with lluse_price parameter /20/2012 Order related functions: Update order fulfillment status 5

6 (Picked, Packed, marked as Shipped, Invoiced) Order_Process_Pick() Order_Process_Pack() Order_Process_Invoice() Order_Process_ForceShip() Cancel an order Order_Cancel() Update pick location of order line item OrdDetail_SetPickLocation() Box tracking information Order_Box_SetTracking() Output related functions: Get status and box information of order Order_Status_Get_XML() Order_Box_Get_XML() Order_BoxContent_Get_XML() Get full order information Order_Data_Get_XML() Get invoice information Invoice_Data_Get_XML () Get Stock Bin locations Stock_Bin_Get_XML() 6

7 /06/2012 Patch Release Customer_Create() corrected invalid return value of 1 Order_Get() revert changes to XML tag. Next release will have new Order_Get_XML() function with descriptive XML tag Customer_Get() revert changes to XML tag. Next release will have new Customer_Get_XML() function with descriptive XML tag /20/2011 Introduce order import like functions Set Order Hold Status Stop Order for Review Set Alternate IDs: Alternate Order ID Internet ID Modify Order Instructions/Notes Introduce customer written/phone contact functions Create Customer Contact Entry Delete Customer Contact Entry Update Customer Contact Entry Get Customer Contact Entries /14/ /15/ /07/ /21/ /17/2011 Patch Release: OrdDetail_Create()- Erroneous Error message: Quantity is a required parameter for the OrdDetail_Create function call. Order_Get() Parsing Error: Encrypted Credit Card XML parsing issue. Stock_Create() - Erroneous Error message: Stock number already exists.. New Purchase Order related functions. Additional Order related function Patch Release Stock_Get()- COM error Order_Address functions - COM errors Patch Release COM exception error Data pull functions: Customer Stock Orders Receive payment authorization Echeck Credit Card Update Order Addresses Update Order Line Item information /01/2011 Initial Release 7

8 Here s the new functionality: Product Related Functions Product_Attribute_Create() Product_Attribute_Data_Get_XML() Product_Attribute_Delete() Product_Attribute_Info() Product_Attribute_Mapping_Create() Product_Attribute_Mapping_Data_Get_XML() Product_Attribute_Mapping_Delete() Product_Attribute_Mapping_Info() Product_Attribute_Value_Create() Product_Attribute_Value_Delete() Product_Attribute_Value_Info() Miva Product Related Functions Product_Miva_SKU_Create() Product_Miva_SKU_Info() Product_Miva_SKU_Data_Get_XML() Product_Miva_FeedMgr_Create() Product_Miva_FeedMgr_Delete() Product_Miva_FeedMgr_Info() Product_Miva_FeedMgr_Get_XML() Purchase Related Functions Purchase_Receive_Product_All() PurDetail_Receive_Product() PurDetail_DeliverTo() Inventory Related Functions Inventory_Process_Updates() Tax Related Functions Tax_SalesTaxRate_Avalara() 8

9 Introduction The M.O.M. API is a programmable interface that provides access to your M.O.M. system information using simple, powerful and secure application programming interfaces. To use this document and the API, you must have software development, programming and M.O.M. usage experience. The API was developed to provide high-level business-based transaction functions to interface with major areas of M.O.M., including Order, Customer, Stock and Inventory. By using the API instead of going directly to the database, data and usage is validated by M.O.M. s business logic. Transaction and data integrity is preserved the same way as if the data was entered through the User Interface. Prerequisites The API is developed to support M.O.M. 8.x The API will run on Microsoft Windows XP, Windows Vista and Windows 7 32-bit/64-bit The API is a COM-based interface thus programs working with M.O.M 8 API must allow use of a COM-based interface M.O.M. Workstation 8 is installed..net Framework 4.0 Installation Instructions 1. Log into the PC where API will be installed using a valid Windows account with admin rights. 2. Log into the Dydacomp support site: 3. Under On-Line Technical Support and Downloads, select Misc. Utilities and MOM 8 then click Go. 4. Click the link for M.O.M. API Installer to begin the download and save the file (MOM_API.exe) to a folder on the PC and note the location. 5. Go to Control Panel to unininstall the existing M.O.M. API install. 6. Go to the Windows System folder to verify the following 4 files are not found. If found, delete them manually: 9

10 7. Launch the installer. 8. Follow the on-screen instructions to finish the install. 9. Make sure Install Samples is checked to save the sample documentation/code and MOM API User Guide to the specified location. 10. Verify the install, as well as the API version, by viewing the Windows Add/Remove Programs screen (Figure 1) or viewing the Windows system folder (Figure 2). Figure 1a Windows 7 Programs and Features screen 10

11 Figure 1b WindowsXP Add/Remove Programs screen Figure 2a Windows7 64-bit system folder shows the MOM API files 11

12 Figure 2b Windows XP system folder shows the MOM API files NOTE: All 3 mom_api.* files must have the same Modified date. If not, uninstall (remove) the MOM API, then delete all 3 mom_api.* files, then reinstall the MOM API. 12

13 API Support Policy The API is developed to work with M.O.M. version 8.x. All questions regarding the API should be directed to customer support. Dydacomp does not guarantee that an application written against one API version will work with future API versions. Our intent is to keep the API consistent from version to version and minimize changes required to port applications to newer API versions. The API version supported coincides with the support lifecycle of the product version. This means that as long as M.O.M. 8 is not end-of-life and is supported, the API will be supported. Dydacomp provides support for the M.O.M. API but not programming advice and resources to interface with the API. It is assumed that the programmer working with the API will have the technical expertise on the language they chose to interface with the API. In the How-To Sample Code section later in this guide, we provide sample codes for several different programming languages to illustrate using the API to complete common transactions. If you require professional services to support your API programming needs, please contact our customer support at (800) Using the M.O.M. API The M.O.M. API is a programmable interface that enables other programs to exchange data with the M.O.M. database. This is a COM based interface and an instance of the API must be created and used as a reference for all the functions supported by the API. There are specific functions in the API that must be called to establish the working environment. They need to be called in a set order before using the API to exchange data with the M.O.M. system. These functions are listed in the appendix. Also, the API offers specific functions to help make working with orders, stock items and customers more streamlined. Establish the working environment Before you can use the API, you need to create an instance of the API object based on its class definition, and store the reference to the object you create for all future calls. An instance of the API is created by using the CREATEOBJECT command in the programming language you are using to access the API. The class definition of the MOM API is mom_api.momfunctions. Example: ox = CreateObject( mom_api.momfunctions ) 13

14 ox now contains a reference to the M.O.M. API object and all of the API functions/properties are exposed to it. There are two additional function calls that MUST be made, in sequence, to complete the API to M.O.M. connection. These only need to be called once for each session. 1. Connect the API to a specific M.O.M. database. If using the SQL version of M.O.M., use the DB_Connect_SQL function. For the FoxPro version of M.O.M., use the DB_Connect_VFP function. 2. Log into the API with a valid M.O.M. user ID and password. It is highly recommended that you do not use a login ID that is active in M.O.M. during the time the API will be in use. API Functions System Related Functions The following functions allow you to connect and login to the API. The System Related Functions include: DB_Connect_SQL DB_Connect_VFP Log_In Add_Parameter Clear_Parameters Get_Parameter_Count Is_Parameter Is_ParameterList_ok 14

15 DB_Connect_SQL This function connects the API to a specified SQL M.O.M. database. Parameters: Name Description Required lcconnstr String value - connection information for the server and database the API will connect to Return Values: Return Value Description -1 Failure to connect to specified server/database Positive Value Success Output: None Examples: Visual FoxPro: Connecting using a trusted connection: nretval = ox.db_connect_sql( Driver=SQL Server;server=momserver;database=mailordermanager ) Connecting using a non trusted connection: nretval = ox.db_connect_sql( Driver=SQL Server;server=momserver;database=mailordermanager;uid=userid;pwd=password;trusted_connection =no ) 15

16 DB_Connect_VFP This function connects the API to a specified FoxPro M.O.M. database. Parameters: Name Description Required lcmaindir lcshareddir String value - full path to the folder where specific company M.O.M. database (momdata.dbc) resides String value - full path to the folder where shared M.O.M. database (momshare.dbc) resides Return Values: Return Value Description -1 Failure to connect to M.O.M. database Positive Value Success Output:.Error_Msg will contain reason for failed connection. Examples: Visual FoxPro: nretval = ox.db_connect_vfp( E:\MOMWIN\Company2, E:\MOMWIN ) 16

17 Log_In This function must be called after connecting to a VFP or SQL M.O.M. database. M.O.M. user login ID and password to use the API. You will need a valid Parameters: Name Description Required lcusercode lcuserpassword String value - valid three character M.O.M. Login ID String value - valid password for M.O.M. Login ID Return Values: Return Value Description -1 Failure to log in 1 Successfully logged in Output: ox.error_msg will contain reason for failed log in attempt. Examples: Visual FoxPro: nretval = ox.log_in( MOM, Password ) 17

18 Add_Parameter This function returns the number of parameters added using the ADD_PARAMETER() API function. Parameters: Name Description Required lcfieldname Field Name lcvalue String representation of field names data type. See Function s optional parameter table. No Return Values: Return Value Description -1 Failed to add parameter 1 Successfully added parameter Output: None Examples: Visual FoxPro: nretval = ox.add_parameter( NTAXR, ) 18

19 Clear_Parameters This function clears the parameters that were added using the ADD_PARAMETER() API function. Parameters: Name Description Required None Return Values: Return Value Description -1 Failed to clear the parameters added using the ADD_PARAMETER() 1 Successfully cleared the parameters added using the ADD_PARAMETER() Output: None Examples: Visual FoxPro: nretval = ox.clear_parameters() 19

20 Get_Parameter_Count This function returns the number of parameters added using the ADD_PARAMETER() API function. Parameters: Name Description Required None Return Values: Return Value Description -1 Failed to determine parameter count Zero value or positive value If successful, returns the number of parameters added using the ADD_PARAMETER() Output: None Examples: Visual FoxPro: nretval = ox.get_parameter_count() 20

21 Order Related Functions The following functions expose the ability to modify existing or new orders in the M.O.M. database. You can work on multiple orders at the same time using this API. By default, the API will not automatically save changes to the database for new orders created using the Order_Create function if the reference to the API object is released before explicitly calling the Order_Save function for each open order. To override this default behavior, set the Save_Partial_Orders property of the API object to True. This can be done as follows: ox.save_partial_orders =.t. Before working on an order, you either have to create a new order using the Order_Create function, or open an existing order using the Order_Modify function. You can create and edit as many orders as you want in a single session, as all the other order related functions accept the order number as a parameter. The data dictionary, located in the M.O.M. help file, provides definitions of every field of information stored in the CMS file. The Order Related Functions Include: Order_Create Order_Modify Order_Save Order_Payment_CC Order_Payment_CC_Auth Order_Payment_EC Order_Payment_EC_Auth Order_Payment_CK Order_Payment_IN Order_Payment_COD Order_Payment_PP Order_Sales_Info Order_Promotion Order_Shipping Order_Calculate_Totals Order_Address_ShippingType Order_Address_BillTo Order_Address_ShipTo Order_Address_SoldTo Order_Add_Item OrdDetail_Delete OrdDetail_Info OrdDetail_Address 21

22 OrdDetail_GiftMessage Order_Hold Order_StopReview Order_Notes Order_BoxLabel Order_Instructions Order_Memo_Default Order_Memo_Custom Order_Alternate_ID Order_Internet_ID Order_Create This function is used to create a new order in the M.O.M. database. You need to supply the M.O.M. customer number that will be the bill-to customer for the order. Optionally, you can also set the ship-to customer, sold-to customer and type of order. Parameters: Name Description Required lncustnum lnshipnum lnsoldnum lcshiptype Integer value M.O.M. customer number. This will be the bill-to customer for the order. Integer value M.O.M. customer number. This will be the ship-to customer for the order. Integer value M.O.M. customer number. This will be the sold-to customer for the order. String value - Order shipping type. If not blank, value must be one of the following: B, S, M, G No default 0 No default 0 No default B B = Billing Address is same as Shipping address 22

23 S = Separate Shipping Address for Entire Order M = Multiple Separate Shipping Address for each Line Item G = Gift Order One or More Recipients Return Values: Return Value Description -1 Failure to create new order Positive value New Order Number required for other order specific functions Output: ox.error_msg will contain reason why system could not create new order. Examples: Visual FoxPro: nretval = ox.order_create(1001,0,0, B ) 23

24 Order_Modify This function must be called once before modifying an existing order in the M.O.M. database. If the order is being accessed in the M.O.M. system, the API will not be able to modify it. If the API can grab the order, users in the M.O.M. system will not be able to access the order until the API releases it. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. Return Values: Return Value Description -1 Failure - could not modify order 1 Success Output: ox.error_msg will contain reason why system could not modify the order. Examples: Visual FoxPro: nretval = ox.order_modify(1001) 24

25 Order_Save This function will save any changes you have made to the order; release the hold on the order the API has, and makes the order available in the M.O.M. system. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_save(1001) 25

26 Order_Payment_CC This function will set the payment method for an order to credit card. Parameters: Name Description Required lnorderno lccardtype lccardnumber lcexp_date lccc_cvc Integer value M.O.M. order number to modify. String value two digit M.O.M. credit card type value String value credit card number ** String value credit card expiration date format MM/YY String value credit card CVC code No Return Values: Return Value Description -1 Failure 1 Success ** The credit card number can be passed in as plain text, or as an encrypted value as long as you set the Enc_Key and Enc_Type properties of the API. See the Reference section for supported encryption types. If lcreference and paid are set the order will be marked as pre-paid and ignore the pre-approval information. Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_cc(1001, VI, ,01/13,1234 ) 26

27 Order_Payment_CC_Ex This function will set the payment method for an order to credit card. Similar to Order_Payment_CC(), but provides additional parameters. The card holder name, the pre-paid amount, and pre-paid reference information. Parameters: Name Description Required lnorderno lccardtype lccardnumber lcexp_date lccc_cvc Integer value M.O.M. order number to modify. String value two digit M.O.M. credit card type value String value credit card number ** String value credit card expiration date format MM/YY String value credit card CVC code No lccardholder Name on Credit Card No lcreference Reference for pre-paid amount No lnpaid Pre-Paid Amount. If not zero, the pre-approval information is ignored. No Return Values: Return Value Description -1 Failure 1 Success ** The credit card number can be passed in as plain text, or as an encrypted value as long as you set the Enc_Key and Enc_Type properties of the API. See the Reference section for supported encryption types. 27

28 If lcreference and paid are set the order will be marked as pre-paid and ignore the pre-approval information. Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_cc_ex(1001, VI, ,01/13,1234, John Doe, ref123, 24.98) 28

29 Order_Payment_CC_Auth This function will set the payment method for an order to credit card with a payment authorization code. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lccardtype String value two digit M.O.M. credit card type value lccardnumber String value credit card number ** lcexp_date String value credit card expiration date format MM/YY lccc_cvc String value credit card CVC code No Default: Empty String lcrcode String value response code of the transaction lcapproval String value approval code of the transaction lcantrans_id String value transaction id for this authorization. lnauth_amt Number value dollar amount that has been authorized. lcauth_time String value datatime format YYYY-MM-DD lcavs String value -Address verification response No Default: Empty String lccardholder String value name as it appears on the credit card. No Default: Empty String 29

30 lcreference String value- Extra info regarding pre-payment amount No Default: Empty String lnpaid Number value- Pre-payment amount No Default: 0.00 Return Values: Return Value Description -1 Failure 1 Success ** If parameter is not required, you will still need to pass the default parameter value. ** The credit card number can be passed in as plain text, or as an encrypted value as long as you set the Enc_Key and Enc_Type properties of the API. See the Reference section for supported encryption types. If lcreference and paid are set the order will be marked as pre-paid and ignore the pre-approval information. Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_cc_auth( 1001, VI, , 01/13,1234, 1, , 12345, 99.99, ,,,,0 ) 30

31 Order_Payment_EC This function will set the payment method for an order to echeck. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcroutingnum String value ABA Routing No Default: empty string lcbankname String value Bank No Default: empty string lcaccountnum String value Account No Default: empty string lcaccttype2 String value P or B No Default: empty string lcaccttype String value Checking or Savings No Default: empty string lcchecknum String value Check No Default: empty string lccardholder String value Account Holder No Default: empty string lcbankstate String value Bank State No Default: empty string lcdrlicense String value Driver s License No Default: empty string lcdlstate String value License State No Default: empty string ** If parameter is not required, you will still need to pass the default parameter value. Return Values: Return Value Description -1 Failure 1 Success 31

32 ** The routing number and account number can be passed in as plain text, or as an encrypted value as long as you set the Enc_Key and Enc_Type properties of the API. See the Reference section for supported encryption types. Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_ec( 10031, , XYZ Bank, , P, Checking, 0755, ,,, ) 32

33 Order_Payment_EC_Auth This function will set the payment method for an order to echeck with a payment authorization code. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcroutingnum String value ABA Routing lcbankname String value Bank lcaccountnum String value Account lcaccttype2 String value P or B No Default: empty string lcaccttype String value Checking or Savings lcchecknum String value Check No Default: empty string lccardholder String value Account Holder No Default: empty string lcbankstate String value Bank State No Default: empty string lcdrlicense String value Driver s License No Default: empty string lcdlstate String value License State No Default: empty string lcrcode lcapproval String value- Response code of the transaction. For an authorize.net account this field should be 1= approved. 2 = declined. This should always be a 1 because you should not allow an order to go through on the web if the echeck is declined. String value-approval code of the transaction provided by authorize.net lcantrans_id String value the authorize.net 33

34 lnauth_amt transaction ID for this authorization. This must be filled in otherwise the system will not be able to locate the authorization on authorize.net to capture the funds. The Authorize.net transaction ID is 9 digits long. Number value dollar amount that has been authorized. lcauth_time String value datatime format : YYYY-MM-DD Note: If not passing in parameter value, use empty string for string parameters and zero for numeric parameters. Return Values: Return Value Description -1 Failure 1 Success ** The routing number and account number can be passed in as plain text, or as an encrypted value as long as you set the Enc_Key and Enc_Type properties of the API. See the Reference section for supported encryption types. If lcreference and paid are set the order will be marked as pre-paid and ignore the pre-approval information. Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_ec_auth( 34

35 10031, , XYZ Bank, , P, Checking, 0755, ,,,,, 1, , ,99.99, ) Order_Payment_CK This function will set the payment method for an order to check. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcchecknum String value Check number lncheckamount Numeric value Check amount Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_ck(1001, 12345,10.95) Order_Payment_IN This function will set the payment method for an order to invoice. Parameters: Name Description Required 35

36 lnorderno lndiscountpercent lndiscountdays lnduedays lcponumber Integer value M.O.M. order number to modify. Numeric value discount percentage if offering terms Numeric value discount days if offering terms Numeric value due days if offering terms String value purchase order number No No No No Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_in(1001,5,10,30, PO12345 ) 36

37 Order_Payment_COD This function will set the payment method for an order to COD. Parameters: Name Description Required lnorderno llcashonly llfedexanypayment llfedexguaranteedfunds llfedexcurrency Integer value M.O.M. order number to modify. No No No No Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_payment_cod(1001) 37

38 Order_Payment_PP This function will set the payment method for an order to PayPal. Parameters: Name Description Required lnorderno lcpaypalid lcantrans_id lnauth_amt lcauth_time Integer value M.O.M. order number to modify. String value The PayPal ID (Typically Address) of the Buyer. String value 17 Digit Code that comes back from PayPal called the txn_id value. Number value dollar amount of the PayPal Transaction String value datatime format YYYY-MM-DD The date and time in which the PayPal Transaction was completed. Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: 38

39 Visual FoxPro: nretval = ox.order_payment_pp(1001) 39

40 Order_Sales_Info This function allows you to set specific data elements related to sales information on the order. Parameters: Name Description Required lnorderno lcsourcekey lccatalog_code lcsales_id lcorder_type lcorder_priority Integer value M.O.M. order number to modify. String value source key for order. String value catalog code for order String value M.O.M. sales ID for order. String value M.O.M. order type. String value M.O.M. order priority. Either blank or H for high priority. No No No No No Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_sales_info(1001, SOURCE11, CAT11, MOM, WEB, H ) 40

41 Order_Promotion This function allows you to set or remove an order promotion code on the order. Parameters: Name Description Required lnorderno lcordpromo llremove Integer value M.O.M. order number to modify. String value M.O.M. order promotion code. Boolean value will remove any existing order promotion from the order if True. No No Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_promotion(1001, PROMO11 ) 41

42 Order_Shipping This function allows you to set specific the shipping method, charges and ship ahead flag on the order. Parameters: Name Description Required lnorderno lcshippingmethod llshipahead lnshippingamount llshipmodify Integer value M.O.M. order number to modify. String value M.O.M. shipping method code. Boolean value True to ship available items now, False to wait for all items to be filled before shipping. Numeric value fixed shipping amount to be used for the order. Boolean value setting to True will lock shipping charge at it s current value. No No No Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_shipping(1001, UPS,.F.,10.95,.T.) 42

43 Order_Calculate_Totals This function will calculate the order total by running the same business logic used in M.O.M. Order promotions, shipping calculations and tax calculations are all performed in this step. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_calculate_totals(1001) 43

44 Order_Address_ShippingType This function is used to update the shipping type of an order in the M.O.M. database. Parameters: Name Description Required lnorderno lnbillnum lnshipnum lnsoldnum lcshiptype Integer value M.O.M. order number the item belongs to. Integer value M.O.M. Bill-to customer number to modify. Integer value M.O.M. Ship-to customer number to modify. Integer value M.O.M. Sold-to customer number to modify. String value - Order shipping type. If not blank, value must be one of the following: B, S, M, G B = Billing Address is same as Shipping address S = Separate Shipping Address for Entire Order M = Multiple Separate Shipping Address for each Line Item No Default: 0 No Notes: Default: Empty String When lcshiptype= B, lnshipnum must be zero When lcshiptype= S, lnshipnum must be greater than zero When lcshiptype= G, lnshipnum must be zero When lcshiptype= M, lnshipnum must be zero G = Gift Order One or More Recipients Return Values: 44

45 Return Value Description -1 Failure to add line item 1 Success ** If parameter is not required, you will still need to pass the default parameter value. Output: ox.error_msg will contain reason why system could not update order. Examples: Visual FoxPro: nretval = ox.order_address_shippingtype( , 1234, 2468, 3691, S ) 45

46 Order_Address_BillTo This function is used to update the bill-to address of an order in the M.O.M. database. Parameters: Name Description Required lnorderno lnbillnum Integer value M.O.M. order number the item belongs to. Integer value M.O.M. Bill-to customer number to modify. Return Values: Return Value Description -1 Failure to add line item 1 Success Output: ox.error_msg will contain reason why system could not update order. Examples: Visual FoxPro: nretval = ox.order_address_billto( , 1234) 46

47 Order_Address_ShipTo This function is used to update the ship-to address of an order in the M.O.M. database. Parameters: Name Description Required lnorderno lnshipnum Integer value M.O.M. order number the item belongs to. Integer value M.O.M. Ship-to customer number to modify. Return Values: Return Value Description -1 Failure to add line item 1 Success Output: ox.error_msg will contain reason why system could not update order. Examples: Visual FoxPro: nretval = ox.order_address_shipto( , 1234) 47

48 Order_Address_SoldTo This function is used to update the sold-to address of an order in the M.O.M. database. Parameters: Name Description Required lnorderno lnsoldnum Integer value M.O.M. order number the item belongs to. Integer value M.O.M. Sold-to customer number to modify. Return Values: Return Value Description -1 Failure to add line item 1 Success Output: ox.error_msg will contain reason why system could not update order. Examples: Visual FoxPro: nretval = ox.order_address_soldto( , 1234) 48

49 Order_Add_Item This function is used to add a new line item to an order in the M.O.M. database. Parameters: Name Description Required lnorderno lcitem lnquantity lluse_price lnprice Integer value M.O.M. order number the item belongs to. String value - full M.O.M. stock number of item to be added. Numeric value quantity of item to add to the order. Boolean value - If True, you must also pass the lnprice and lndiscount parameters. Numeric value selling price of item. No default False No lndiscount Integer value discount on item. No lnship_to lcship_via Integer value ship-to customer number for item. (Used for Multiple ship-to and Gift-to orders) String value Valid three character M.O.M. shipping code. Shipping method for this item. No No lcgiftmsg1 String value gift message line 1 No lcgiftmsg2 String value gift message line 2 No lcgiftmsg3 String value gift message line 3 No lcgiftmsg4 String value gift message line 4 No lcgiftmsg5 String value gift message line 5 No lcgiftmsg6 String value gift message line6 No 49

50 Return Values: Return Value Description -1 Failure to add line item 1 Success Output: ox.error_msg will contain reason why system could not add line item. Examples: Visual FoxPro: nretval = ox.order_add_item(1001, A-OTHER,1,.T.,100,10) 50

51 OrdDetail_Create This function is used to add a new line item to an order in the M.O.M. database. Parameters: Name Description Required lnorderno lcnumber lnqty lluse_price lnprice Integer value M.O.M. order number the item belongs to. String value - full M.O.M. stock number of item to be added. Numeric value quantity of item to add to the order. Boolean value - If True, you must also pass the lnprice and lndiscount parameters. If FALSE, MOM will set default price and discount. Numeric value selling price of item. No default False No lndiscount Integer value discount on item. No Return Values: Return Value Description -1 Failure to add line item Positive value Success Output: ox.error_msg will contain reason why system could not create line item. Examples: Visual FoxPro: nretval = ox.orddetail(1001, A-OTHER,1,.T.,100,10) 51

52 OrdDetail_Delete This function is used to update the Order Line Item general info in the M.O.M. database. Parameters: Name Description Required lnorderno lnitem_id lcreasoncode Integer value M.O.M. order number the item belongs to. Integer value Order Line Item ID String value M.O.M. Reason Code Return Values: Return Value Description -1 Failed to update 1 Success Output: ox.error_msg will contain reason why system could not delete line item. Examples: Visual FoxPro: nretval = ox.orddetail_delete( , 8888, Z ) 52

53 OrdDetail_Info This function is used to update the Order Line Item general info in the M.O.M. database. Parameters: Name Description Required lnorderno lnitem_id lnorderqty Integer value M.O.M. order number the item belongs to. Integer value Order Line Item ID Integer value Order Qty of line item No Default: 0 lndisc Integer value - Discount % off No Default: 0 lccustinfo String value Line Item Custom Info No Default: Empty String lcship_when String value Order Line Item Schedule Shipment Date No Default: Empty String lcshipvia String value Order Line Item Special Shipping Via (Optional) No Default: Empty String Return Values: Return Value Description -1 Failed to update 1 Success ** If parameter is not required, you will still need to pass the default parameter value. Output: ox.error_msg will contain reason why system could not add line item. Examples: Visual FoxPro: nretval = ox.orddetail_info(1534, 2021, 2, 0, ****,, UPN ) 53

54 OrdDetail_Address This function is used to update the order line item address in the M.O.M. database. Parameters: Name Description Required lnorderno lnitem_id lncustnum Integer value M.O.M. order number the item belongs to. Integer value Order Line Item ID Integer value M.O.M. customer number. This will be the Ship-to or Gift-to customer number for the order. Return Values: Return Value Description -1 Failed to update 1 Success Output: ox.error_msg will contain reason why system could not update line item. Examples: Visual FoxPro: nretval = ox.orddetail_address( , 8888, 1234) 54

55 OrdDetail_GiftMessage This function is used to update the order line item gift message in the M.O.M. database. Parameters: Name Description Required lnorderno lnitem_id Integer value M.O.M. order number the item belongs to. Integer value Order Line Item ID lcgiftmsg1 String value gift message line 1 No Default: Empty String lcgiftmsg2 String value gift message line 2 No Default: Empty String lcgiftmsg3 String value gift message line 3 No Default: Empty String lcgiftmsg4 String value gift message line 4 No Default: Empty String lcgiftmsg5 String value gift message line 5 No Default: Empty String lcgiftmsg6 String value gift message line 6 No Default: Empty String Return Values: Return Value Description -1 Failed to update 1 Success ** If parameter is not required, you will still need to pass the default parameter value. Output: ox.error_msg will contain reason why system could not update line item. Examples: Visual FoxPro: nretval = ox.orddetail_giftmessage( , 8888, you, say, goodbye, I, say, hello ) 55

56 Order_Hold This function is used to put an order on Hold in the M.O.M. database. Parameters: Name Description Required lnorderno lnholdtype lcholdreason Integer value M.O.M. order number. Integer value Hold Type. 0 = Remove from Hold 1 = Do Not Ship/Manifest Until 2= Do Not Process Order Until 3= On Permanent Hold String value Valid M.O.M. Order Hold Reason Code. No default 0 No default: Empty String lchold_until String value Date YYYY-MM-DD when lnholdtype = 1 or 2 Return Values: Return Value Description -1 Failure to create new order 1 Success Output: ox.error_msg will contain reason why system could not put order on hold. Examples: Visual FoxPro: nretval = ox.order_hold(1001,1, H1, ) 56

57 Order_StopReview This function stops an order for review and prevents further processing of order. Once order is marked, it requires a manager s Authorization to release the order for processing. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lccomment Stop Review Comment No llrelease Release from Order Review. User must be a manager to release order for processing. No Default: false 57

58 Return Values: Return Value Description -1 Failure - could not modify order 1 Success Output: ox.error_msg will contain reason why system could not stop order for review. Examples: Visual FoxPro: nretval = ox.order_stopreview(1001, API,.F.) 58

59 Order_Notes This function will update the Order Notes of a specified Order Number. Left pane of Instructions/Notes tab on order entry screen. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcnote String value Order Notes No Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_notes(1001, Order Notes ) 59

60 Order_BoxLabel This function will set the Instructions to Appear on All Box Labels of a specified Order Number. Center pane of Instructions/Notes tab on order entry screen. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcinstruct1 String value Instructions to Appear on All Box Label Line 1. No Default: Empty String lcinstruct2 String value Instructions to Appear on All Box Label Line 2. No Default: Empty String lcinstruct3 String value Instructions to Appear on All Box Label Line 3. No Default: Empty String lcinstruct4 String value Instructions to Appear on All Box Label Line 4. No Default: Empty String lcinstruct5 String value Instructions to Appear on All Box Label Line 5. No Default: Empty String lcinstruct6 String value Instructions to Appear on All Box Label Line 6. No Default: Empty String Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_boxlabel(1001, line1, line2, line3, line4, line5, line6 ) 60

61 Order_Instructions This function will update the Order Instructions of a specified Order Number. Right pane of Instructions/Notes tab on order entry screen. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcinstruct String value Order Instructions No Default: Empty String Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_instructions(1001, Order Instructions ) 61

62 Order_Memo_Default This function will update the Order Memo of a specified Order Number based on the source key parameter. Sales Information tab of order entry screen. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcsourcekey String value Valid Source Key No Default: empty string ** If parameter is not required, you will still need to pass the default parameter value. Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_memo_default(1001, Source Key ) 62

63 Order_Memo_Custom This function will update the Order Memo of a specified Order Number. Sales Information tab of order entry screen. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcline1 String value Order Memo Line 1 No Default: empty string lcline2 String value Order Memo Line 2 No Default: empty string lcline3 String value Order Memo Line 3 No Default: empty string ** If parameter is not required, you will still need to pass the default parameter value. Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_memo_custom(1001, Line1, Line2, Line3 ) 63

64 Order_Alternate_ID This function will update the Alternate Order ID of a specified Order Number Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcalt_order String value Alternate Order ID No Default: empty string ** If parameter is not required, you will still need to pass the default parameter value. Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_alternate_id(1001, ORD12345 ) 64

65 Order_Internet_ID This function will update the Internet ID of a specified Order Number Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lcinternetid String value Internet ID No Default: empty string ** If parameter is not required, you will still need to pass the default parameter value. Return Values: Return Value Description -1 Failure 1 Success Output: ox.error_msg will contain reason for failure. Examples: Visual FoxPro: nretval = ox.order_internet_id(1001, INET12345 ) 65

66 Order_Process_Pick This function performs the stage 1 order processing in MOM, if possible. Because this stage is the first stage, it is not latched to any other stage. However, depending on whether you require an order to be picked before or after the credit card is charged, this stage may be dependent on the completion of credit card approval before processing. Currently, MOM orders having Fedex shipping methods will not generate the tracking number. However, if the Fedex tracking number is generated externally, the tracking number can be updated using the ORDER_BOX_SETTRACKING() API function. Notes: Check status of order after running this function to determine if succesfull. Pick List/Tickets can be completely eliminated from order processing. Some retail mail order companies prefer to pick from the packing slip instead. See Maintain Global Parameters - Forms. Parameters: Name Description Required lnorderno Integer value M.O.M. order number. Return Values: Return Value Description -1 Failure to process order 1 Success Output: ox.error_msg will contain reason why system could not perform action. Examples: Visual FoxPro: nretval = ox.order_modify(268380) nretval = ox.order_process_pick(268380) 66

67 Order_Process_Pack This function performs stage 2 order processing in MOM, if possible. This stage is dependent on completion of Stage 1 unless that stage is not included in order processing, and then the stage is dependent on Credit Card Processing. Currently, MOM orders having Fedex shipping methods will not generate the tracking number. However, if the Fedex tracking number is generated externally, the tracking number can be updated using the ORDER_BOX_SETTRACKING() API function. Note: Check status of order after running this function to determine if succesfull. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. Return Values: Return Value Description -1 Failure - could not process order 1 Success Output: ox.error_msg will contain reason why system could not perform action. Examples: Visual FoxPro: nretval = ox.order_modify(268380) nretval = ox.order_process_pack(268380) 67

68 Order_Process_Invoice This function performs stage 11 order processing in MOM, if possible. For orders that must be shipped, this stage is dependent on the completion of Stage 10. For drop shipped orders, this stage is dependent on the completion of Stage 8-9. For service item orders that are not shipped or drop shipped, this stage is dependent only on the completion of Credit Card Processing. Notes: Check status of order after running this function to determine if succesfull. Some companies prefer to combine invoices with packing slips and pack the invoice right in the customer's box. M.O.M. provides several options for this. See Maintain Global Parameters - Forms for more information. Parameters: Name Description Required lnorderno llinvoicecopy Integer value M.O.M. order number to modify. Boolean value Output Invoice Copy. Default=false lcinvoicepart String value invoice part if llinvoicecopy is false, Default to empty string. if llinvoicecopy is true, set to empty for all invoices Statement of the order. Set to specified inpart letter. Return Values: Return Value Description -1 Failure - could not process order 1 Success Output: ox.error_msg will contain reason why system could not perform action. Examples: 68

69 Visual FoxPro: nretval = ox.order_modify(268380) nretval = ox.order_process_pack(268380) 69

70 Order_Process_ForceShip This function forces the status of the order to shipped, if possible. Note: Check status of order after running this function to determine if succesfull. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. Return Values: Return Value Description -1 Failure - could not process order 1 Success Output: ox.error_msg will contain reason why system could not perform action. Examples: Visual FoxPro: nretval = ox.order_modify(268380) nretval = ox.order_process_forceship(268380) 70

71 Order_Box_SetTracking This function updates the tracking number for a specified box of an order in MOM. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lnbox_id Integer value M.O.M. box id lctrackingno String value tracking # lcship_date String Value YYYY-MM-DD. A valid date string or empty string for blank date. Return Values: Return Value Description -1 Failure - could not process order 1 Success Output: ox.error_msg will contain reason why system could not perform action. Examples: Visual FoxPro: nretval = ox.order_modify(268380) nretval = ox.order_box_settracking(268380, 2345, 1Z , ) 71

72 Order_Cancel This function cancels an order in MOM. Parameters: Name Description Required lnorderno Integer value M.O.M. order number to modify. lclostcode String value M.O.M. lost code lcreturncode lcnotation String value M.O.M. return code String value Notation for cancellation No. Return Values: Return Value Description -1 Failure - unable to perform action on order 1 Success Output: ox.error_msg will contain reason why system could not perform action. Examples: Visual FoxPro: nretval = ox.order_modify(268380) nretval = ox.order_cancel(268380, Z, L, not needed ) 72