Magento
Recommended Magento Versions: The module is known to work with Magento V1.3 – 1.6.x. (Last updated and reviewed November 30th, 2011). We have tested the current Shipwire module with Magento Commercial, Professional, Enterprise and Magento Go (instructions). Please contact Customer Care if you find any incompatibilities between Shipwire module and your version of Magento.
IMPORTANT: On 12/16/2010 we released a patch to the real time rating module that you can get by visiting Magento Connect (see links below). Merchants using Magento with Shipwire should be cautious when upgrading their Magento cart to newer versions of Magento. Be sure to back up your current installation and your database before a version upgrade and confirm the upgrade works with Shipwire after the upgrade.
This page includes 4 main topics:
I. Setup Magento Order Fulfillment
II. Setup Magento Real-Time Shipping Rates Module
III. Tips to test your Magento module
Shipwire has developed two connections to Magento that are now available.
- Magento Order Fulfillment Sell Tool. This is found within your Shipwire account. It installs in a couple clicks and walks you through a wizard that connects your Shipwire account directly to your Magento Store. Through this API connection your Shipwire account will receive orders directly from your Magento store to be picked, packed and shipped. Once shipped your Magento store will get new inventory numbers and parcel carrier tracking numbers so you and your buyers can track the shipment. Read on for instructions on this module.
- Magento Real-Time Shipping Rates. Download this script module from Magento Connect here. Follow the instructions in the download and your Magento store checkout will be able to pull shipping rates for all our shipping carriers for display to buyers.
I. Setup – Magento Order Fulfillment Connection
Installation instruction for Shipwire Sell Tool:
1. Create a Web service user in your Magento Admin, If you already have a Web Service User established in your Magento account you can skip this part.
1.1 Go to System > Web Services > Users in your Magento Admin.
1.2 Click Add New User button on the top and create new Web Service User as below
User Name: User Name to be used for API login (eg: shipwire_api_user)
First Name: First name of user
Last Name: Last name of user
Email: Email address for user
Api Key: API key to be used for API login (eg: shipwire)
This Account is: Active
Magento Add User
1.3 Go to System > Web Services > Roles, and click Add New Role to set Role Name and Role Resources as below
Role Info > Role Name: Role Name for this service integration (eg. Shipwire integration role)
Role Resources > Resource Access: All
1.4 Go back to System > Web Services > Users to map User to Role created, Select user(eg. shipwire_api_user) you just created and click User Role at left menu, check radio button for the role you created and click Save User button
2. Install the Magento Sell tool to your Shipwire account.
2.1 Login to your Shipwire Account
2.2 Add Magento to your sell tool and select Magento from Sell tool menu on left
2.2 In Setup Connection tab enter values as below
Magento API User: Enter your Magento API User Name (eg. shipwire_api_user)
Magento API Key: Enter your Magento API Key you created (eg. shipwire)
Magento Store URL: Your Magento store URL (eg. www.mymagentostore.com)
Shipwire Magento Sell Tool Screen
2.3 Enable all features you want and click Save button
2.4 In Control Panel tab, Enter initial order import date (use YYYY-MM-DD HH:MM:SS format or enter 0 if you want to import from now).
Control Panel Tab in Shipwire Magento Sell Tool
2.5 Click Start import orders button
2.6 Shipwire will now hourly poll your Magento orders and Tracking number and inventory will be updated after your order is fulfilled.
Testing Your Magento Store Order Fulfillment Connection:
1.IMPORTANT: Before you test Shipwire order fulfillment/tracking update/inventory update integration, you need to make sure all SKU ID’s in your Magento shopping cart match the SKU ID’s in your Shipwire account. (Shipwire will hold orders with unrecognized skus). If you want to test with only a test SKU, just ensure that ID is a match.
2. After you set up the Shipwire Sell tool, places an order from Magento store front.
Create order for Test SKU in Magento Store
3. Change the order status to Paid by creating invoice for the order in Magento Admin.
Mark invoice paid
4. Within an hour Shipwire will pick up the order from your Magento store.
Test order from Magento in your Shipwire Account
5. After your order is fulfilled Shipwire will update with any available carrier tracking number as well as updated inventory counts.
Get carrier tracking numbers in your Magento Store
SKU inventory count updated in real-time
(Please Note: You will not need to create a Shipment for your sales order. Shipwire will create one for you through the Magento API at the same time that we update tracking info.)
II. Magento Real-Time Shipping Rates Module
Installation instructions for Magento Shipping Rates provided by Shipwire. This module puts Shipwire shipping rates directly into your Magento checkout.
1. Go to Magento Connect to get the Extension key. Go to Shipping rates for Magento.
Get Shipwire Shipping-Rate Extension Key from Magento Connect
2. Select Extension Key, magento-community/Mage_Shipwire
3. Login to your Magento Cart as admin, go to System > Magento Connect > Magento Connect Manager
4. Login one more time for Magento Connect Manager, go to Settings tab and choose Preferred State: to Stable
5. Click back to Extensions tab, Enter Magento-Community/Mage_Shipwire to Paste extension key to install field, click Install button to start install the Extension
Extensions Tab: Enter magento-community/Mage_Shipwire and click “install”
6. After Install, click Return to Admin on the top. In the Admin page click System > Configuration
7. On the left, select Sales > Shipping Methods, Select Shipwire Rating Service from the Shipping Methods
(Note: If you do not see the Shipwire Rating Service in the Shipping Method list, please delete you Magento cache files(they are located at magento/var/cache, delete all folders under the folder), and refresh the screen).
8. Set up Shipwire Rating Service as below
Enabled: Yes
Title: Enter title that shows in checkout process (eg, Shipwire Shipping Service)
Shipwire Email: your Shipwire account email address
Shipwire Password: your Shipwire account password
Available Shipping Services: Select all services you want to offer to customer
Model: shipwire_shipping/carrier_ShippingMethod
Setting Up Shipwire Shipping Rates as a Shipping Method in Magento
Testing and Use of Shipwire real-time shipping rates:
1. Very important: Before you use the Shipwire real-time shipping rating service, you need to make sure all the SKUs in your Magento shopping cart are in sync with your Shipwire account and your SKU dimensions and weights in Shipwire are a match to the physical product. (Shipwire will not quote for skus missing in Shipwire. Shipwire rate quotes are not available for items not in the Shipwire system at this time).
2. Place an order through the store front end, you will see Shipwire Quotes
Shipwire Shipping Rates Display in Magento Cart Checkout
III. Tips to test your Magento Module
If you are having difficulty seeing your Magento orders on Shipwire the following tips may help.
1 – Test the Magento SOAP API – Shipwire uses the Magento SOAP API to communicate with your cart for Order Fulfillment, Inventory and Shipping Status and Tracking. It is essential that the Magento API work perfectly. A common problem is that the SOAP API is not enabled or properly configured. A simple test to see if SOAP is enabled is to query the SOAP API handler. To do this just enter the following URL in your web browser:
https://<your_url>/index.php/api/soap/?wsdl
Substitute <your_url > with your Store URL. You should receive back a bunch of XML from your cart indicating it working.
2 — Make sure you have the PHP SOAP extention enabled on your web server — The Apache PHP server has SOAP extensions that are necessary for proper operation. To test this you can run this simple script from a PHP file on your web server:
<?php
phpinfo();
?>
This shows your PHP server environment and what modules are installed. If Soap is installed you should see:
Note the SOAP section
If the SOAP extension does not show up then you can run this simple scrip from a CMD line prompt to enable SOAP:
yum install php-soap
service httpd restart
Finally you can edit the php.ini file directly to enable the service and restart your server manually.
3 — Make sure the API User and Key in Magento exactly match Shipwire — If these do not match exactly then there will be authentication error when Shipwire polls Magento to download orders. See Section 1 — step 1.4 to configure this.
4 — It still doesn’t work — now what? If after these steps you still do not see Magento orders in your Shipwire account you may need to contact support. It is possible there are internal issues with your Magento versions handling of SOAP requests. We can look at our server logs to help resolve this. We do know that some Magento versions are not stable and their SOAP implementation will not work without suitable patching. At this time we know for certain that Magento V 1.3.2.4 works well.
IV. Magento Cart FAQs
Q — After I place an order on Magento how long does it take before the order appears on my Shipwire account?
A — We poll your Magento cart once an hour for new orders. It can take up to one hour for your order to show up.
Q — The Real Time Shipping module doesn’t work sometimes. What is wrong?
A — The Real Time Shipping module uses the Shipwire Rating API directly to get rating requests. Carefully review the Shipping Module instructions. Also be sure your Shipwire account email address and password exactly match your Shipwire account.
Another issue is trying to rate shipments with SKU’s that Shipwire does not have defined or has never had inventory. This is because we can not determine the weight or dimensions of what is being shipped in order to properly quote shipping rates. A good rule of thumb is if you can see the SKU in the Manage Inventory view then it can be rated for shipment.
Q — I added a new SKU to my Shipwire account. How to I get my inventory to update in my Magento Cart?
A — Shipwire pushed inventory updates only when inventory changes. For a new SKU we push the initial inventory update when your receiving is first uploads. If at the time of this update you do not have the SKU defined in Magento then the update won’t have any effect. You should always make sure your new SKU is present in Magento before your receiving is first uploaded so it can immediately record you inventory.
Q – I just upgraded to Magento V 1.4.1.x and my integration no longer works. How can I fix this? (Sept 23/2010)
A – There is an issue with the SOAP API implementation within Magento version 1.4.x that causes an error to be thrown when our servers call your Magento cart via the API. Shipwire developers have identified this as a issue within the cart and not within Shipwire code. Furthermore this issue has been identified by a number of other Magento integration partners as well. The link below has more information regarding this:
There have some efforts to work around this and to patch the newest version. You can find out more about that here:
Please note that as of this time there is not a patch available that fixed this issue. There is word that V1.4.2 does address this issue however it is still in beta test more. As we find out more information about this we will post it here.
At this time Shipwire urges it’s uses to delay any upgrade to Magento V1.4.x until this issue has been addressed.
Q — What about adding extensions to Magento – will that affect my Shipwire integration?
A — Most Magento add-ons will work perfectly with the Shipwire Integration. However that is not always the case. One add-on in particular that is a problem is a module that allows you to delete orders from your Magento database. This module does not properly delete your orders and leaved the database in state that causes the API to fail. We strongly recommend that you use extreem caution with any module that modifies your Magento order data. Before any installation be sure to take a snap-shot of your data in case you need to revert to an earlier version.