Documentation for Shipping Restrictions

Simplifying Shipping Control in Magento 2

• Instant rule creation: Set up location-based shipping rules in a few clicks

from the admin panel.

• Unlimited restrictions: Combine any number of rules to support even the

most complex logistics scenarios.

• Precision targeting: Allow or block methods by country, state/region, city,

ZIP/postcode range, or even keywords in the street address.

• Manage requests easily: Apply rules to specific products, categories,

customer groups, or store views for maximum flexibility.

• Define shipping Areas with precision: Create custom Shipping Areas by grouping countries, states, cities, zip ranges, and street keywords—then apply restrictions based on these areas.

There are two ways of installing extension in magento2.

1. Using COMMAND LINE.
   
2. Manually Install extension.
   

Option 1: Magento 2 install extension using COMMAND LINE (Recommended)

Follow below steps to install extension from the command line.

Step 1: Download the extension and unzip it.

Step 2: Upload it to code directory in your magento installation’s app directory If code directory does not exists then create.

Step 3: Disable the cache under System → Cache Management.

Step 4: Enter the following at the command line:

           Php bin/magento setup:upgrade
           Php bin/magento setup:static-content:deploy

Step 5: Once you complete above steps log out and log in back to the admin panel and switch to Stores → Configuration → Mageants → Shipping Restriction, the module will be displayed in the admin panel.

Option 2: Magento 2 install extension manually

Step 1: Download the extension and unzip it.

Step 2: Upload it to code directory in your magento installation’s app directory If code directory does not exists then create.

Step 3: Disable the cache under System → Cache Management Edit app/etc/config.php file and add one line code: ‘Mageants_ShippingRestriction’ ⇒ 1

Step 4: Disable the cache under System → Cache Management

Step 5: Once you complete above steps log out and log in back to the admin panel and switch to Stores → Configuration → Mageants → Shipping Restriction, the module will be displayed in the admin panel.

After installing the Shipping Restriction extension, log into your admin panel to configure it’s setting.

You can access the extension setting as shown in this screenshot below.

To configure the extension , go to: store > configuration > Mageants > Shipping Restriction.

Enable Module: Enable/Disable the Shipping Restriction Functionality.

Shipping Area Grid: List all the Shipping areas created.

Shipping Area Form: Create Shipping Area from here the form contains Below fields.

• Shipping area name → Name of the shipping area
• Status → Enable/Disable the shipping area
• Description → Provide description related to area.

• For Countries → Select Include/Exclude Countries.
• Countries → Select Country/Countries to apply the restriction
• For States/Regions → Select Include/Exclude Regions.
• States/Regions → Select or specify Regions here.
• For Cities → Select Include/Exclude Cities.
• Cities → Specify City here.

• For Zip/Postal codes → Select Include/Exclude Zip/Postal code.
• Zip/Postal codes → Provide zip range or mass insert Zipcodes comma separated.
• For Address Shipping Line → Select Contain/Does not contains.
• Address Line → Specify Street line to match.

Shipping Restriction Rule Grid: Displays all the Shipping Restriction rules Created.

Shipping Restriction Rule Form:

• Shipping Restriction Rule Name → Specify Restriction Rule name.
• Enable Rule → Enable/Disable rule.
• Shipping Method → Select Shipping method to apply restriction from active shipping methods.
• From and To date → Select a date Range for apply the Restrictions.

• Show Restriction Message → Yes/no For Displaying Restriction Message
• Restriction Message → Message specified here will be displayed as error message.
  • If Show Restriction Message is set to no shipping method will be hidden and no error message is displayed.
  • If Show Restriction Message is set to yes then Shipping method will display with error message.
• Apply in admin → Yes/no When selected Yes the rule will also apply for admin order create.

Select Storeview and customer Groups → Apply Restriction to specific store view and selected customer groups.

Condition Tree → Sets the requirement that must be met for the rule to apply. If no condition Is given, The rule will apply to all products.

• Select customer(s) from grid to apply shipping restrictions for them on frontend
• The condition may include Product Subselection, Condition Combination, Cart Attributes, Customer Attributes, Shipping Areas, Additional Attributes.
• With this option, you can limit shipping based on things like the product, its category, customer details, or custom groups.
• We’ve also added a new condition that lets you use the billing address conditions under Additional Attributes.

Shipping restriction is Restricted on the Admin order Create When Admin configuration is enabled in the rule

Shipping Restriction is applied on the Cart page in frontend.

Shipping Restriction Rule is Applied on Checkout page.