XPS

Magento 2 Integration


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

Initial Integration Setup in Magento 2

Log in to your Magento 2 admin panel. On the left-hand side, click on System > Extensions > Integrations.

mceclip0.png


Click Add New Integration in the top right.

mceclip1.png

Add Magento 2 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 2.

mceclip0.png


Copy the Callback URL and Identity link URL to be pasted into the corresponding blank fields on the Magento 2 Integration page.

mceclip2.png


Return to Magento 2. In the General section, paste the Callback URL and Identity link URL into the corresponding blank fields, as well as the Name, email, and Magento password. Click Save in the top right.

mceclip3.png


On the left-hand side under Basic Settings, select API.

mceclip4.png


Click the checkbox next to Orders (Sales > Operations > Orders), then click Save and you will be redirected to the Magento 2 Integrations grid.

mceclip5.png


Click Activate in the grid for the integration you just created.

mceclip6.png


Click Allow.

mceclip9.png


You will be redirected to XPS Ship to finalize the authentication process.

mceclip8.png


General Settings

  • Add an Integration Name, “Magento 2” 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.

mceclip2.png


Magento 2 Settings:

  • You do not need to enter or change anything in the Store URL, Admin Username, or Admin Password fields as this will automatically populate with your information after completing the initial integration steps.

  • If you have multiple stores, you can select the correct store from the dropdown.

  • Check the box for Load static assets from "pub" subdirectory if images aren't loading.

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

  • Check the box for Ignore Weight if you wish to manually enter in shipment weight.

  • Product Image Sync Interval We recommend leaving this field blank. By default, product images will sync automatically every 30 days. If you frequently update images in your Magento product catalog (which is uncommon), you may enter a custom sync interval in hours. Please note that more frequent syncing may slow down order syncing and loading times. If you have recently updated your product images and want to apply changes, select Sync Product Images Now to check for and sync any updates.


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

Text, letterDescription automatically generated


When finished, click Save New Integration.

mceclip1.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 2 supports the following as defined in the Integration Features Glossary.

mceclip0.png


Back to Top