Get Started with Magento 2 distance-based shipping extension

Get the Shipping Costs Based on Distance extension running in your Magento 2 store. This guide covers the essential steps to start calculating shipping costs based on the distance between your store and customers.

Prerequisites

Before you begin, ensure you have:

• Distance Based Shipping extension installed
• Admin access to your Magento store
• A Google Maps API key with Distance Matrix API enabled

Step 1: Get Google Maps API Key

1. Go to Google Cloud Console
2. Create a new project or select existing
3. Enable the Distance Matrix API
4. Create an API key under Credentials
5. Copy the API key

See the Google API Setup guide for detailed instructions.

Step 2: Enable the Module

1. Go to Magmodules → Shipping Costs Based on Distance
2. Under General:
   • Set Enabled to Yes
   • Paste your API Key
   • Enter your Store Address (full address including country)
3. Click Test Credentials to verify the API connection
4. Click Save Config

Step 3: Configure the Shipping Method

1. Under Shipping Method → Name and Position:

   • Set Enabled to Yes
   • Enter a Title (e.g., "Local Delivery")
   • Enter a Method Name (e.g., "Distance-based shipping")
   • Set Sort Order for checkout display position

2. Under Calculation and Pricing:

   • Select Metric (Kilometers or Miles)
   • Configure Round Distance option
   • Configure Round Total Price option

Step 4: Set Up Pricing Table

Create your distance-based pricing in the Shipping Price table:

Example calculation for 30 km:

• Falls in 25-50 km range
• Fixed: €15.00
• Per km: 30 × €0.75 = €22.50
• Total: €37.50

Step 5: Test the Setup

1. Go to your storefront
2. Add a product to cart
3. Go to checkout
4. Enter a shipping address
5. Verify the distance-based shipping option appears with calculated price

Optional: Configure Limits

Set up limits to control when the shipping method is available:

Free Shipping:

• Enable free shipping above a certain order amount

Maximum Distance:

• Limit delivery to a maximum radius from your store

Country Restrictions:

• Limit to specific countries

What Happens During Checkout

1. Customer enters shipping address
2. Extension sends address to Google Maps API
3. Google returns distance between store and customer
4. Extension matches distance to pricing table
5. Shipping cost is displayed to customer

Next Steps

• Configure free shipping thresholds
• Set up maximum distance limits
• Add product eligibility conditions
• Enable product page shipping estimation

Need More Help?

Documentation:

• All Help Articles - Complete documentation overview

Support:

• Contact Support - Get help from our team