Magento integrates directly with ShippingEasy. Magento is a platform for selling your products which makes it easy to receive orders and ship them to your customers. ShippingEasy will automatically send queries to read the orders from your Magento account and then load them into our application. Once shipped, shipment data will be sent back to your Magento store. To integrate your Magento store with ShippingEasy, determine which version of Magento your store runs on.

Magento Integration Requirements

Connection Requirements:

  • You must have a live Magento site.

  • Magento Community, Magento Go, or Magento Enterprise.

  • ShippingEasy's Magento integration requires that your Magento store be configured using the main domain, not a sub-domain.


If you are on a Magento Community edition, the speed of your order download into ShippingEasy is dependent on the download speed of the server you're hosting your Magento store on. You can easily check the speed of your server by accessing your website. If the page is slow to load, the server may need to be updated.

Magento (v1.x)

  • Version 1.8 or 1.9

  • Store URL

  • Magento Username

  • Magento API Token

  • SOAP installed (Simple Object Access Protocol) - To tell is SOAP has been loaded, type your URL with the extension /api/v2_soap/  (ex:  If SOAP has been loaded, you should see an XML document explaining more about the usage of SOAP.

Magento (v2.x)

  • Minimum version of 2.1.3 to ensure that order status updates work properly with split orders. We support up to Magento 2.3.2

  • Store URL

  • Magento Username

  • Magento Password

Connect a Magento (v1.x) Store to ShippingEasy

To connect the Magento v1.x store to ShippingEasy, you must take steps in both Magento and ShippingEasy.

Retrieve your credentials from Magento

  1. Open a new browser window and log into your Magento admin panel. Select and copy the URL that appears in the address bar when viewing the admin section of your site.


    Copy this address EXACTLY as it appears in the address bar because this allows us to properly access your store (including the /magento/index.php). We suggest you copy and paste this directly from the backend of your site. For example "http://yourstore/magento/index.php"v

  2. In ShippingEasy, paste the URL address from Magento into the Magento Store URL field.

  3. In Magento, go to System > Web Services.

  4. Choose SOAP/XML-RPC - Roles.



    If you don't see this option, but instead see simply "Roles," it's likely you have a MagentoGo store. Select "Roles" and continue with the steps below.

  5. Select Add New Role. Enter "shippingeasy" as the role name. Then select Save Role.

  6. On the left-hand navigation bar, select Role Resources.

  7. Set the Access to All next to Resource Access.

  8. Select to Save Role. Choose SOAP/XML-RPC - Users.

  9. Select Add New User. Enter "shippingeasy" as the User Name. Then, enter your name and email.

  10. Create your own API key (essentially, a password). Once complete, select Save User.


    Be sure to remember this API key as you will need it to enter back into ShippingEasy to complete the integration.

  11. From the left-hand navigation bar, select Role Users and choose the "shippingeasy" user you have just set up. Then select Save User.


Now connect your Magento1 to your ShippingEasy account

  1. Select Magento from the Platform drop-down.

  2. Paste your Magento Store URL that was saved earlier.

  3. In the User Name field, enter "shippingeasy".

  4. In the API Token field, enter the token you created for the "shippingeasy" user.

  5. Click Save.

That's it! Your store is connected to ShippingEasy!

Connect a Magento (v2.x) Store to ShippingEasy

How to connect your Magento (v2.x) to an existing ShippingEasy account

  1. Select Magento 2 from the Platform drop-down menu.

  2. Type your store's full web address in the Magento2 Store Url field.

  3. Enter your Magento admin username in the Magento2 Username field.

  4. Then enter your admin password into the Magento2 Password field.


    Admin Permissions

    The user must have administrative permissions to Sales, Products, Stores. If you would like to set up a separate user with these permissions, you can do so by going to Magento > System > User Roles > Create new role. Then going to Magento > System> All Users and creating a new user with the role permissions you just created.

  5. Click Save.

    The Save button is highlighted

That's it! Your store is connected to ShippingEasy!

Magento Order Data

Magento Standard Data Supported

ShippingEasy's Magento integration supports the following features and order data fields:

Supported Order Statuses

Magento order statuses map to ShippingEasy in the following way:

Magento Status

ShippingEasy Status


Awaiting Shipment


Awaiting Fulfillment


Awaiting Fulfillment


Awaiting Payment

Payment Review

Awaiting Payment

Custom 1, 2, 3

Not Supported

The statuses Closed, Cancelled, and Complete will not sync into ShippingEasy.

When bringing in an order, ShippingEasy will also check to confirm that the order contains a physical shipment. Order line items that contain virtual or downloadable product types are filtered out.

Magento Integration Notes

Duplicate Orders

Magento users can manage multiple Magento websites from one admin login. Customers with multiple websites managed through the same admin login should be aware that orders may be duplicated in ShippingEasy depending on how the websites are integrated into your account.

There are two easy solutions to avoid duplicate orders.

  1. Only integrate one store, and use the different order prefixes to determine which site the order originated from. The lead digit on the Order Number will help you to distinguish the orders from each site. You may have three websites on the same login. For example, if you have three websites on the same admin login, the Order Numbers from the first site will start with 1 (example: '10000000'), the Order Numbers from the second site will start with 2 (example: '200000000'), and the Order Numbers from the third site will start with 3 (example: '300000000').

  2. Integrate each website to your ShippingEasy account individually. Then, use {Shipping Rules} to control which orders pull in from each store. Specifically, use the order prefixes (like the examples "1", "2", and "3" above) to automatically clear the duplicate orders. This option allows you to set up different branding, logos, and packing slips for each store.

Order Updates

  • Magento 1.x: When ShippingEasy sends order updates, it marks orders as "Complete" and provides Magento with the ship date, carrier, and tracking number.

    Magento 1.x orders will need to have an invoice before they can be marked as "Complete". Without an invoice, ShippingEasy cannot mark orders as "Complete".

  • Magento 2.1.x: When ShippingEasy sends order updates, it provides Magento with the ship date, carrier, and tracking number.

    ShippingEasy marks orders as "Complete" when sending any shipment update for Magento versions 2.1.0 through 2.1.2. Therefore, a minimum version of 2.1.3 is recommended for users who may need to split an order to ensure that the order is not marked "Complete" in the Magento store until all line items for the order are shipped.


Carrier Information Exceptions

When shipping via Globegistics, APC, or RR Donnelley carriers, ShippingEasy will set the carrier name to “Other” in Magento.

  • HTTP and HTTPS: Some information may be read by Magento, but without an SSL certificate shipment information will not always be sent back to your store.

  • Combined Orders: Orders combined in ShippinEasy will not be combined in Magento; however, once postage is purchased both orders will be marked as shipped with the tracking number (if included).

  • Split Orders: Split orders will update both tracking numbers in Magento if you are using Magento v2.1.3. This ensures that the order is not marked as "Complete" in the Magento store until all line items for the order are shipped.

  • Address Changes: If you add a comment to the Magento order, within the Magento interface, at the time that you update the address, then the new address information will be sent to ShippingEasy. Otherwise, the address change will not be received via the API. Learn more about what updates will sync in ShippingEasy.

Product Updates:

  • Weights: Magento automatically stores weights as pounds (lbs). For example, if you list the weight as 3, it comes in as 3 lbs. However, if you listed the weight as 0.1875, this would come in as 3 oz.

Bundled Product Updates:

  • Bundled products are displayed as either a single line item or as multiple line items, depending on how you have bundled products configured in Magento. This format will carry over to packing slips created in ShippingEasy.

  • If one or some of the line items are shipped: In the "Items Ordered" view in Magento, the number of items orders is listed in the Qty column. When a line item is shipped, a note will be added to the Qty column with the number of items shipped.

    Example of a "Bundled Product" order from Magento as displayed in ShippingEasy:


    You will see on line two a "Gaming Computer" and all of the items listed are included (grouped) into the single item order.

    Example of how the "Bundled Product" order is updated in Magento when only one item is shipped:


Capture Payment on Magento Shipments

In Magento third-party payment processors like PayPal and provide an option to select when you capture payment on your orders. You can select to capture payment either:

  • On checkout.

  • After the order has been shipped.

Each payment processor uses a unique process for capturing payments:

  • PayPal: When you use PayPal your payment action can be set to "Authorize" or "Sale". If you select "Authorize" then the payment for your orders will not be processed until after they have been shipped.

  • When you use your payment action can be set to "Authorize" or "Authorize and Capture". If you select "Authorize" then Magento will only confirm the payment method is valid and the funds are available, it will not charge the payment on checkout.

By default, ShippingEasy will not capture payment on Magento orders. So, if you decide to only "Authorize" your payments on checkout, you have two options:

  • Manually capture payments.

  • Request that ShippingEasy prompt Magento to capture the funds for your orders on shipment creation.

In order for ShippingEasy to help with capturing payments, you will need to update your settings within ShippingEasy.


These steps apply to both Magento v1.x and Magento v2.x stores.

Capture a payment in Magento via ShippingEasy:


  2. Click Edit Store Settings for your Magento store.

  3. Click on the "Orders" tab and click the box next to the "Capture Payment when updating shipment details back to this store".

  4. Scroll to the bottom of the page and Save your changes.


Add a Comment

Article is closed for comments.