XPS
XPS Ship Dashboard
Contact Support

Magento Store Integration


Integrating your XPS Ship account with Magento allows your customers’ orders to be directly transferred from Magento to your profile, providing quick and easy shipping. Orders will be marked as “Shipped” on Magento and will send a tracking number once the shipping label has been generated.

Pre-Setup Preparation

The following process will show you how to obtain the necessary information needed to integrate Magento with your XPS account. You will need to have your company information and Magento credentials on hand.

Note: You must have version 1.9 or higher for this integration to work.

Creating a User

Log into your Magento Admin account. This can be done with most accounts by adding /admin/ to the end of your store URL.

mceclip0.png


Once logged in, go to System> Web Services> SOAP/XML-RPC-Users.

mceclip1.png


In the top right, select +Add New User.

mceclip3.png


Fill out the required information. The Username and API Key can be whatever you want them to be. Copy the User Name and API Key, as you will need to paste them into your Magento Integration settings for XPS in a later step.

mceclip5.png


When done adding the new user, click Save User.

mceclip6.png


Next, go to System> Web Services> SOAP/XML-RPC-Roles.

mceclip7.png


Select +Add New Role.

mceclip8.png


Enter a Role Name (it can be anything) and enter the current admin password.

mceclip10.png


On the left side, select Role Resources.

mceclip11.png


Next to Resource Access select All from the dropdown menu.

mceclip12.png


Then select Save Role in the top right.

mceclip13.png


Go back to Users.

mceclip2.png


Select the user you just created. Select User Role on the left side.

mceclip14.png

Select the role you’ve just previously created.

mceclip15.png


Then select Save User in the top right.

mceclip6.png


Add a Magento Integration in XPS

Open a new browser window and log in to your XPS Ship Account.

Click the Settings tab.

mceclip0.png

Under eCommerce select eCommerce Integrations.

mceclip1.png

Click Add eCommerce Integration.

mceclip0.png

Select Magento.

mceclip0.png


General Settings

  • Add an Integration Name, “Magento” will be the default, but it can be changed to anything you’d like.

  • Check the box if you want to have a confirmation email sent when orders are fulfilled.

  • By default, the Active box will be checked.

  • Check the box if you want to Skip address Pre-Verification on orders.

  • Check the box “Include Packing slips in confirmation email” if you’d like the packing slips included with the confirmation email once labels have been generated.

mceclip16.png


Magento Settings

  • Enter the Store URL

  • Enter the API User Name

  • Enter the API Key

  • Enter the type of Pending Order Statuses you wish to pull into your orders list in XPS Ship. Orders with the status of "processing" are the default.

  • If you want your order status to remain unchanged in Magento after booking, check the box “Don’t update Magento order after booking shipment”.

  • If you wish to retrieve unpaid orders as well, check the box “Retrieve orders regardless of payment status”.

  • Set the Max Order Age in Days (default is 30 days)

mceclip1.png


Additional settings are available related to the Sender Address and Return To Address. Edit if necessary to your integration.

mceclip0.png


When finished, click Save New Integration.

mceclip2.png


When the integration is saved, you see that the connection has been established at the top of the page.

Orders start syncing and appear in the shipping area, this may take a few minutes.


mceclip9.png


Available Features

XPS Ship’s integration to Magento supports the following as defined in the Integration Features Glossary.

mceclip1.png


Back to Top