1. MARKETPLACE SET UP - Easyship Configuration

1. MARKETPLACE SET UP - Easyship Configuration

Easyship is a global shipping integrator that connects your store to multiple couriers in over 26 countries. Omnyfy's Easyship Module allows flexibility for customers to choose the courier applicable to them (based on live rates and delivery times), and also allows Vendors to enable a flat rate or their store - wherein a customer will pay a fixed cost for shipping, and the vendor can select which courier they would like to ship their product with, all in the backend of the Omnyfy platform.

Prior to configuring Easyship on the Omnyfy platform, please ensure you have created an account with Easyship here - simply choose 'Sign Up' at the top.

Marketplace Configuration

In order to use this shipping method the Marketplace must be using "Per Vendor" configuration for shipping, please see our shipping calculation guide for how to set this.

You will also need to set up your Marketplace Commercials Management (MCM) to use "Enable Ship By Type" to Yes - this is to properly calculate the shipping cost to be paid to the vendors.

Go to Stores > Configuration > Omnyfy > Marketplace Commercial Management > Enable Ship By Type > Yes

NOTE: You must do this before an order is placed to prevent any incorrect calculations on the MCM Dashboard.



Module Configuration

Login to the Omnyfy Marketplace Backend, on the Admin sidebar, go to:

Stores -> Configuration -> Sales -> Shipping Methods -> Easyship

Here you will find the overall module configuration:

  • Enabled: This controls whether the module is enabled or disabled, set to Yes to enable it
  • Platform Name: The Sales Platform name sent to Easyship, and also the default name of the shipping method when Flat Rate is set.
  • Taxes/Duties Paid By: Determines who will be paying the taxes/duties on the Shipment cost. If not sent the Easyship default is Sender.
  • Shipment Includes Insurance: Determines whether Shipments will include and insurance fee
  • Allow Courier Fallback: This determines whether another courier can be chosen from the one chosen by the Customer when the Vendor or Marketplace Owner actually books the shipment if the courier chosen by the Customer is no longer available. If this is set to Yes then the shipping cost may change between the Customer ordering and the Vendor or Marketplace Owner booking the shipment.
  • Buy Label Synchronously: Allows you to buy the label at the same time as booking the shipment. Always set this to Yes.
  • Buy Label File Format (only available if "Buy Label Synchronously" is set to Yes): The file format of the Label returned from Easyship
  • Label Size (only available if "Buy Label Synchronously" is set to Yes): Dimensions of the Label returned from Easyship (each courier might have their own integration specific size, which may override your selection).
  • Commercial Invoice (only available if "Buy Label Synchronously" is set to Yes): Dimensions of the Commercial Invoice returned from Easyship
  • Packing Slip (only available if "Buy Label Synchronously" is set to Yes): Dimensions of the Commercial Invoice returned from Easyship
  • Instructions for Webhook: These are configuration instructions that appear under the "Webhook Secret Key". Since it requires a little explanation for what to do with this field, we've made a configuration to allow Marketplace Owners to edit the language of the instructions, tailored to the site.


You can copy the content from here:
<p><span><strong>NOTE:</strong> Before you can enter the webhook details you need to enter <span>all the required fields here </span>and save to generate the Account ID.</span><span class="c-mrkdwn__br" data-stringify-type="paragraph-break"></span><span>You will need then to create a webhook in Easyship, following these instructions:</span><br /><a class="c-link" href="https://support.easyship.com/hc/en-us/articles/360039354771-Create-and-Edit-Webhooks" target="_blank" rel="noopener noreferrer" data-stringify-link="https://support.easyship.com/hc/en-us/articles/360039354771-Create-and-Edit-Webhooks" data-sk="tooltip_parent">https://support.easyship.com/hc/en-us/articles/360039354771-Create-and-Edit-Webhooks</a></p>
<p>The<span> endpoint you save in your Easyship account will be </span><strong>https://demo.omnyfy.com/easyship/webhook/shipment/account/{account_id},</strong><span> replacing {account_id} with the number generated in the Account ID field</span>.</p>
<p><span class="c-mrkdwn__br" data-stringify-type="paragraph-break"></span>When creating your webhook, please also ensure you have checked the following boxes:</p>
<ul>
<li>shipment.canceled</li>
<li>shipment.label.created</li>
<li>shipment.label.failed</li>
<li>shipment.tracking.status.changed</li>
</ul>
Replace the 2 references of https://demo.omnyfy.com in this text with your own domain.
  • Sync Shipping Category from API (Must have a valid Easyship account set up first before you can action this - see next step): This will automatically pull in all of the shipping categories that Easyship requires for products to be shipped.


Once the Easyship settings have been configured, you can now set up your first Easyship Account. Save the configuration:



Generally, you would set up an account for the Marketplace Owner so that you can import the Shipping Categories, so for now save it. Once saved, ensure you clear your cache and reindex, in order to see Easyship Accounts and Easyship Booking Management in the Sales Menu.



Next, you can set up an Easyship Account in Omnyfy, and link it to your Easyship Dashboard.

    • Related Articles

    • 2. SET UP - Creating an Easyship Account in Omnyfy

      In order to link your Omnyfy store to your account in the Easyship application, you will need to set up an Easyship Account inside the Omnyfy back end. Before starting, you will need to ensure you have an Easyship Account, please ensure you have ...

    • 3. SET UP - Linking a Vendor Source/Location to an Easyship Account

      Once you have completed setting up your Easyship account on Omnyfy (see guide here), you will need to link it to a Source (only for Omnyfy v4) or Location (only for Omnyfy v2) in order to start using it. If you already have a source or location ...

    • 4. SET UP - Adding dimensions to your products for Easyship

      The Omnyfy Easyship Integration allows the marketplace to automatically calculate the shipping rates for the available couriers, based on the physical dimensions, weight and shipping category of the products. When adding/editing your products, there ...

    • 5. SHIPPING YOUR ORDER - Preparing to ship an order with Easyship

      You've received an order notification, and prepared all of the products to ship. You now need to prepare the shipment in the Omnyfy platform. Before you do, ensure that you have enough credits in your Easyship Account before you buy your label with ...

    • Marketplace Shipping Calculation Management

      When setting up your Marketplace, you need to determine how shipping will be handled and charged to the customer, whether the customer will be charged for each Vendor they are ordering from or if they will be just charged once per order. This will ...