Overview
- Import your orders into Starshipit, and allow tracking information to write-back when you print a label.
- This article outlines how to integrate your Magento platform with Starshipit.
- Learn how to disable email notifications in Magento 1.
Before you begin
You can have more than one Magento store integrated with Starshipit if the stores are under the same Magento account in the Admin panel. If they are in separate Magento accounts, you'll need to set it up as a child account.
1. Create a role and user in Magento 1
Set up an API access, and create a Webservice role and assign it to a Webservice role in Magento.
Create a new role
- Go to your Magento Admin Dashboard.
- From the System menu, select Web Services, then select SOAP/XML-RPC - Roles.
- From the roles page, click Add New Role.
- Enter a role name, and then click Role Resources.
- Set the Resource Access to ALL.
- In the top right-hand of the screen, click Save Role.
Assign your new role to a user
- Go to your Magento Admin Dashboard.
- From the System menu, select Web Services, then select SOAP/XML-RPC - User.
- From the users page, click Add new User.
- Enter the account information as required.
Note that the API Key will work as the password you enter in Starshipit. You can set this accordingly. - Set the account to Active.
- On the User Information panel, click User Role. Assign the user your previously created the role for.
2. Enter your Magento 1 details in Starshipit
After you have created the user and the role in Magento, you need to add the URL, username and the password in Starshipit. You can customise the status of orders to import, however the default status "processing" should be correct for most Magento stores.
- In Starshipit, navigate to Settings > Integrations.
- Click Add a new integration and select Magento.
- Enter the URL of your site e.g. http://www.mysite.com/api/xmlrpc or http://www.mysite.com/index.php/api/xmlrpc.
- Enter your Magento username and password. The password is the API Key that you created in Magento.
- Click Save, then test your connection using the Test to ensure it works button.
(Optional) Disable email notifications in Magento
- Log in to your Magento account.
- From the System menu, select Configuration.
- Under the Advanced tab, select the System menu item.
- Select Mail Sending Settings.
- Set Disable Email Communications to ‘Yes’.
Emails will no longer be sent through Magento.
Delivery instructions
The following fields are imported for Delivery Instructions:
- myOrderInfo.shipping_address.special_delivery_info
- myOrderInfo.special_delivery_info
- myOrderInfo.shipping_address.customer_comments
- myOrderInfo.customer_note
- myOrderInfo.onestepcheckout_customercomment
What's next?
- If you're having issues with the Magento 1 integration, see our guide to Troubleshoot Magento 1.
