Generic Orders Export
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
In this module, the "order" tokens can be used in any of the other fields. The "product" tokens can be used in the "product row" template and the "attribute row" template. The "attribute" tokens can be used only in the "Attribute row template". Tokens used in a fields in which they were not intended will simply display in the displayed page.
|
| |||||||||
| The "Orders" tokens: | |||||||||
|
| |||||||||
| %orderdate% | order date | ||||||||
| %todaysdate% | todays date | ||||||||
| %yesterday% | yesterday's date | ||||||||
| %orderid% | Order id | ||||||||
| %cust_password% | Customers password (assuming the customer was logged into their account) | ||||||||
| %cust_login% | Customers login (assuming the customer was logged into their account) | ||||||||
| %cust_id% | Customer id (assuming the customer was logged into their account) | ||||||||
| %ship_fname% | shipping first name | ||||||||
| %ship_lname% | shipping last name | ||||||||
| %ship_email% | shipping email | ||||||||
| %ship_comp% | shipping comp | ||||||||
| %ship_phone% | shipping phone | ||||||||
| %ship_fax% | shipping fax | ||||||||
| %ship_addr% | shipping address | ||||||||
| %ship_city% | shipping city | ||||||||
| %ship_state% | shipping state | ||||||||
| %ship_zip% | shipping zip | ||||||||
| %ship_cntry% | shipping cntry | ||||||||
| %bill_fname% | billing first name | ||||||||
| %bill_lname% | billing last name | ||||||||
| %bill_email% | billing email | ||||||||
| %bill_comp% | billing company | ||||||||
| %bill_phone% | billing phone | ||||||||
| %bill_fax% | billing fax | ||||||||
| %bill_addr% | billing addr | ||||||||
| %bill_city% | billing city | ||||||||
| %bill_state% | billing state | ||||||||
| %bill_zip% | billing zip | ||||||||
| %bill_cntry% | billing cntry | ||||||||
| %storename% | Store's name | ||||||||
| %storeowner% | Store's owner | ||||||||
| %storeemail% | Store's email | ||||||||
| %storecompany% | Store's company | ||||||||
| %storeaddress% | Store's address | ||||||||
| %storecity% | Store's city | ||||||||
| %storestate% | Store's state | ||||||||
| %storezip% | Store's zip | ||||||||
| %storephone% | Store's phone | ||||||||
| %storefax% | Store's fax | ||||||||
| %storecountry% | Store's country | ||||||||
| %ordershipping% | Shipping method as stored in orders database | ||||||||
| %shippingmethod% | Shipping method as reported by shipping module | ||||||||
| %totalshipping% | Shipping total | ||||||||
| %paymentmethod% | Payment method as reported by payment module | ||||||||
| %paytype% | Payment method description (same as %paymentmethod% | ||||||||
| %orderpayment% | Payment method as stored in orders database | ||||||||
| %totaltax% | Amount of tax | ||||||||
| %totalwithshipping% | Subtotal with shipping | ||||||||
| %totalwithtax% | Subtotal with tax | ||||||||
| %ordertotal% | Total paid for order | ||||||||
|
| |||||||||
The tokens used for the payment data have a slightly peculiar form. The data displayed for the payment corresponds with the data displayed by the payment module in the >Order Processing section of admin (and identical to the data displayed for the order in the "Standard Batch Report"). So if you go to an order, to the payment module's tab for that order, you will see the data for the payment displayed, one item of data per line. For example, a credit card payment might show:
The label (eg. Card Type or Card Number) for the first line would be represented in the template with the token %paylabel|1|%. The data (eg. Visa or 5444 4444 4444 444) for the first line would be displayed with the token %paydata|1|%. And so on. So if your payment module collects 4 fields, to include the data for all four fields in the export, you will need the tokens %paydata|1|%, %paydata|2|%, %paydata|3|%, and %paydata|4|% in your template In the above example, to add the payment data to the end of the orders line in your export file, you could add to the end of "template for header" the labels (assuming that you are using the comma as the delimiter): ,CARD_TYPE,CARD_NUMBER,EXP_MONTH,EXP_YEAR and add to the end of the "Template for Order row" ,%paydata|1|%,%paydata|2|%,%paydata|3|%, %paydata|4|% | |||||||||
|
| |||||||||
| %paydata|x|% | the data for the xth payment field | ||||||||
| %paylabel|x|% | the label (as displayed at checkout) for the xth payment field | ||||||||
| %payfield|x|% | the abbreviated "code" used by the module to identify the payment field. For example, this might be ccnum for the card number | ||||||||
|
| |||||||||
| The "Products" tokens: | |||||||||
|
| |||||||||
| %prodname% | product's name | ||||||||
| %prodcode% | product's code | ||||||||
| %prodweight% | product's weight | ||||||||
| %prodprice% | product's price | ||||||||
| %prodcost% | product's cost | ||||||||
| %prodquantity% | quantity ordered | ||||||||
| %produpsold% | '1' if product was an upsell, '0' otherwise | ||||||||
| %prodtaxable% | '1' if product was a taxable purchase, '0' otherwise | ||||||||
| %prodtotal% | the total paid for that product (quantity x price) | ||||||||
| %prodtotalF% | the total paid for that product formatted using the currency module | ||||||||
|
| |||||||||
| The "Attribute" tokens: | |||||||||
|
| |||||||||
| %attrcode% | attributes's code | ||||||||
| %optcode% | option's code (if options was selected) | ||||||||
| %attrprice% | attributes's price. If there is no price, nothing will be displayed | ||||||||
| %attrdata% | data entered into attribute's "text" field (for text type attributes" | ||||||||
| %attrdatalong% | data entered into attribute's "memo" field (for memo type attributes". Note: since a single attribute can't have data in the %attrdata% and %attrdatalong% attribute at the same time, these two are often used together in templates such as: %attrdata%%attrdatalong% | ||||||||
| %attrtotal% | the attribute's total price (quantity x attribute price) | ||||||||
| %attrtotalF% | the attribute's total price formatted with the currency module | ||||||||
Ok here is what I have in the module fields which is about 90% of the battle. You still must create "Map" in Worldship no matter what module you use. This will create file made for "keyed" import method for WorldShip. e.g. enter order#, field populate, weigh your box, enter weight, hit process, label prints File name: orders.txt Template for Header Row: nameups^&Company^&Street^&Country^&Zip^&City^&State^&ordnum^&Email^&snop tion^&sntype snoption = Y [you must use Y literally for WS] sntype = e-mail [you must spell e-mail just like that or it will not work in WS] Those 2 are for "ship notification" and "ship notification type" Template for Order row: %ship_fname% %ship_lname%^&%ship_comp%^&%ship_addr%^&%ship_cntry%^&%ship_zip%^&%ship_ city%^&%ship_state%^&%orderid%^&%ship_email%^&Y^&e-mail ^& = tab character [ed: use the ^& characters in the templates. They will be replaced with the tab character when the export occurs] Now I thought I'd keep this a secret but to prevent undue pain and suffering: The export file for ups CANNOT have a field named "order" - "ordnum" will work. If you do call a field "order" for like the order number you'll get some stupid MS Windows OBDC error. Don't bother trying to fixit as UPS tech guy said it was an issue with their app and windows. Don't let low level tech at UPS tell you it cannot use tabs. They always try to use CSV comma file and that will screw you with mMerchant since users will enter commas into the bill/ship fields. let me know if you need further help using this. We go cross platform from Mac to Windows with this thing too for all the Mac offices out there. I can brief that workflow if needed - not a big deal really. Here is a sample of final file output as I use it. nameups|Company|Street|Country|Zip|City|State|ordnum|Email|snoption|snty pe Barrett Butler|TestCompany|123 Test Drive, Suite 123|US|48169|Testville|TN|3432|creativepapers@mac.com|Y|e-mail I used pipes in this text since my dang email app wouldn' let me paste it with tabs to suit me.
Mike here are a few things I discovered while trying to use this module for UPS Worldship: 1. The header field names can not contain spaces 2. If you are exporting data from the Order row and the Item row, put all tokens in the item row, to avoid the results data appearing on two lines. Worldship can not handle the results data listed on two separate lines, therefore using the Item row will eliminate this. 3. Tell customers to obtain a copy of Worldship because they list what the minimum required fields are to import data. Regards, T. Taylor Rising Star Ideas, LLC 9400 Snowden River Parkway Suite 230 Columbia, MD 21045 410-381-0810 x823 voice/fax We reach for the STARS!!! www.RisingStarIdeas.com
Installation
| This module installs as a store utility module (and not as an Export module as you might expect). | |
| To install the main module: | |
| 1. | As with any module, there are two ways to upload the file to your server, through the Merchant mall's "add module" feature which lets you upload the file, or by putting hte file on the server yourself via ftp. If you want to ftp the module file (BROK_GENEXPORT.mv) to your server, do so now. For convenience, place it into the Merchant2/modules/util/ directory. Note that your Merchant scripts might NOT be installed in a directory called Merchant2/. Although most setups use this directory. If your's uses a different directory, make sure you put the module there |
| 2. | Enter into admin and expand >Modules in the left frame. |
| 3. | Click on the link to "Add Module" |
| 4. | In the right frame, you'll see a text entry field with an "upload module" button next to it. If you ftped the BROK_GENEXPORT.mv file to your server, enter the path to that file into the text field (usually modules/util/BROK_GENEXPORT.mv). Click on the "add" button. If you did not ftp the file to the server, click on the 'upload' icon next to the text entry field. This will pop up a small window. Enter the path to the file on your local computer or click on the "browse" button to browse your hard drive to find it. After you have the path in the text entry field click on the "upload" key. When you're back to the right frame, click on the "Add" button. After a short delay, you should see a notification that the module was installed and you will see it at the bottom of the list of installed modules in the left frame. |
| 5. | The module is now installed into your "mall". And being an export module, it is automatically available in your store. |
| 6. | Click on the >Utilities link under your store in admin. This will bring up a window in the right frame listing all of the store utility modules you have installed. Check the box next to the Generic Orders Export in the list and click on "update". You'll now have a new tab, "Generic Order Export". |