How to use ShippingEasy with Magento

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. Then find step-by-step integration guides below:

Magento 2.0 users should upgrade to version 2.1.3 or higher for best results with ShippingEasy.

ShippingEasy's integration supports Magento Community or Magento Enterprise, versions 1.8, 1.9, 2.1.x, and 2.2.x. For Magento 2 stores, version 2.1.3 and higher is recommended for proper handling of split order updates.

Click through the sections below to find more details on how Magento works with ShippingEasy.

Technical requirements

Magento requires an SSL certificate.

Does Magento require SOAP in order to integrate with ShippingEasy?

Magento v2.x stores do not require SOAP. However, stores using Magento version 1.x technology are required to use SOAP in order to integrate with ShippingEasy. SOAP stands for "simple object access protocol". ShippingEasy's software integration with Magento is designed to work with encoded SOAP messages.

To tell is SOAP has been loaded, type your URL with the extension /api/v2_soap/  (ex:http://mystore.com/api/v2_soap Learn more about SOAP.

If SOAP has been loaded, you should see an XML-document explaining more about the usage of SOAP.

Do I need to turn off WS-I to connect to Magento 2?

WS-I should not need to be turned off for Magento 2. WS-I compliance is a SOAP concept, and we do not use a SOAP API to connect up to Magento 2.

Syncing Orders

Once Magento is integrated with ShippingEasy, orders that have been placed in the last 14 days will begin to appear on the ORDERS page. The following are frequently asked questions about syncing orders from Magento to ShippingEasy.

How often are my orders synced from Magento to ShippingEasy?

By default, ShippingEasy will sync with your store hourly to pull in any new orders.

How do I get existing Magento orders synced to my new ShippingEasy account?

If you have orders older than 14 days old, you can create manual orders for these shipments. Learn how to add manual orders one-by-one or via a CSV file.

How are order status values mapped from Magento to ShippingEasy?
Magento Status ShippingEasy Status
Processing Awaiting Shipment
New Awaiting Fulfillment
On Hold (Holded) Awaiting Fulfillment
Pending Awaiting Payment
Payment Review Awaiting Payment

The following Magento statuses will clear orders present on the ORDERS page from ShippingEasy: Complete, Closed, Canceled.

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.

How is the requested service mapped from Magento?

ShippingEasy will pull the requested service data from the "shipping_method" field in Magento.

What happens if I click Sync on the ShippingEasy ORDERS page?

The Sync link prompts ShippingEasy to pull through orders in an approved status. If your store is set up for automatic order downloads, selecting the Sync link will download orders since the last time a sync completed.

A sync is run automatically each night and can be run manually using the Sync link.

If you have disabled the automatic order download, you must use Sync to download your orders. It can take 15-20 minutes for orders to populate after selecting Sync.

Are manual orders brought into ShippingEasy from Magento?

Yes. Orders entered into Magento manually with sync into ShippingEasy if they are in a status that you designate to sync.

Which order number is displayed in ShippingEasy?

Magento allows you to add plug-ins to your store to change the order number that is sent on your invoices and confirmation emails. However, these are not currently supported in ShippingEasy. ShippingEasy will display the original, unedited order number as assigned by Magento.

How do I prevent duplicate orders from being pulled in from Magento?

Magento users can manage multiple stores from one admin login. When they integrate multiple stores into ShippingEasy, there is a quirk where stores duplicate the order numbers, as though they are reading from the admin page twice.

To avoid this problem, only integrate one store, and use the different order prefixes to determine which site the order originated from. Or integrate each Magento website to your ShippingEasy account individually, and then use Shipping Rules to control which orders pull in from each store. Learn more about this quirk and these workarounds here.

Editing Orders and Shipments

ShippingEasy can recognize when certain changes have been made to an order in your store. For a complete overview, check out our FAQs on the topic. The following are frequently asked questions specific to Magento orders that are still on the ORDERS page.

If I update an order in Magento, will the order details update to ShippingEasy?

Yes, ShippingEasy can receive updates to order status, recipient address, customer comments or item price. Updates will only be received by ShippingEasy when more than an address change is made.

Item prices will only update when made to an order manually entered into Magento admin, but not when orders placed on the website are updated.

Will my Magento orders update when I change the recipient's address?

If you update the address on a Magento order, ShippingEasy can receive this updated information via the API. However, the Magento API does not recognize just an address edit as a change to an order. So, if you only change the address, the request to update the order in ShippingEasy will not be sent via our API.

Good news - we have a work around solution! If you also 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.

Orders will NOT update if:
  • The order is moved from the ORDERS page and later returned. Orders must remain on the ORDERS page to receive updates via the API during an automatic sync.
  • If you manually adjust an order in ShippingEasy (add a line item, remove a line item, edit address), we consider ShippingEasy to be the main source of information and will not check for updates within Magento on future store syncs.
Are billing addresses sent from Magento to ShippingEasy?

Yes, ShippingEasy can receive billing addresses for your Magento orders, and display those on your packing slips.

If a billing address is incomplete, ShippingEasy will replace it with the shipping address to ensure the shipping updates sent back to Magento do not fail.
If I cancel an order in Magento, will it automatically be cancelled in ShippingEasy?

Yes. If an order is cancelled in Magento, it automatically clears it from the ORDERS page in ShippingEasy.

Shipment Changes and Updates

ShippingEasy updates your store with order information throughout the entire shipping process.

What information is sent back from ShippingEasy to Magento?
  • 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.

Will the shipment information be sent back to Magento if my web site uses HTTP instead of HTTPS?

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

If I combine two orders in ShippingEasy, do both orders get updated in Magento?

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

If I split an order in ShippingEasy, will ShippingEasy update both tracking numbers to Magento?

Yes. For Magento version 2 stores, ShippingEasy recommends a minimum version of 2.1.3 to ensure that the order is not marked as "Complete" in the Magento store until all line items for the order are shipped.

Orders and Product Information

ShippingEasy displays your order and product information on the ORDERS page, where you can customize what information you see. Learn more about customizing your ORDERS page.

What product information from Magento is displayed in ShippingEasy?

The following product details are displayed in ShippingEasy:

  1. Name
  2. SKUs
  3. Product Options. Learn more about configuring ShippingEasy to display product options.

This information can be found by navigating to SETTINGS > Edit Store Settings link under the Magento store listing.

Are product weights displayed in ShippingEasy?

Yes. ShippingEasy will display the order weight that was assigned in store.

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.

For reference, these should return you 1-16 ounces:

Ounces (oz) Pounds (lb)
1 0.0625
2 0.125
3 0.1875
4 0.25
5 0.3125
6 0.375
7 0.4375
8 0.5
9 0.5625
10 0.625
11 0.6875
12 0.75
13 0.8125
14 0.875
15 0.9375
Are warehouse locations displayed in ShippingEasy?

No. Magento does not have a standard attribute defined for warehouse/bin location.

TIP: set up a Product Catalog in ShippingEasy to map warehouse locations to specific SKUs. Learn more about the Product Catalog.

Are comments sent from Magento to ShippingEasy?

Customer Comments:

Yes these can be sent to ShippingEasy, however this option is off by default. To sync your customer comments, navigate to your Magento store settings page and enable the sending of customer comments for Magento orders.

Merchant Internal Comments:

If using Magento v2.2, internal comments added by a merchant can be sent to ShippingEasy.

Are gift orders sent from Magento to ShippingEasy?

Yes.

How are "Bundled Products" displayed in ShippingEasy?

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.

Learn more about packing slips.

How are "Bundled Products" updated when only 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:

Email Notifications

Magento automatically sends shipment confirmation emails to your customer once their order has been shipped. Return label emails can be automatically sent to customers if they have included an email address with their order. Learn more about automatically sending prepaid return labels.

ShippingEasy does not support sending order confirmation emails to Magento 2.

Customer Marketing

ShippingEasy offers a Customer Marketing solution to help build and grow relationships with your customers. Customer Marketing can be added to your ShippingEasy subscription at any time. A Customer Marketing subscription is managed by selecting a tier which determines how many emails you can send each month. Learn more about email credits.

Troubleshooting tips

The following are common issues and resolutions that can occur with ShippingEasy’s Magento integration.

Why are my orders not downloading from Magento?

There are three likely reasons that your orders are not downloading:

Was this article helpful?
1 out of 1 found this helpful

Comments

Add a Comment

Please sign in to leave a comment.