{"id":299717,"date":"2021-08-06T08:21:58","date_gmt":"2021-08-06T08:21:58","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=299717"},"modified":"2024-02-22T09:44:02","modified_gmt":"2024-02-22T09:44:02","slug":"restrict-custom-shipping-methods-magento2","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/","title":{"rendered":"Restrict custom shipping methods in Magento 2"},"content":{"rendered":"\n<p>Many times we want to restrict some shipping methods according to some conditions. So if you are looking for the same, we have a solution for you.<\/p>\n\n\n\n<p>We have to create an after plugin for collectRates. So here is our di.xml code. If you are not aware with shipping method development then please visit &#8211; <a href=\"https:\/\/webkul.com\/blog\/create-custom-shipping-method-in-magento2\/\" target=\"_blank\" rel=\"noreferrer noopener\">how to create Magento 2 shipping method<\/a><\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\">&lt;type name=&quot;Magento\\Shipping\\Model\\Shipping&quot;&gt;\n        &lt;plugin name=&quot;Webkul_ShippingRestrict::rate&quot; type=&quot;Webkul\\CustomRestriction\\Plugin\\Model\\Shipping&quot;\/&gt;\n    &lt;\/type&gt;<\/pre>\n\n\n\n<p> Now, we will create plugin on the defined path i.e, Webkul\\CustomRestriction\\Plugin\\Model with name Shipping.php<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\">&lt;?php\n\nnamespace Webkul\\CustomRestriction\\Plugin\\Model;\n\nclass Shipping\n{\n    \/**\n     * @var \\Magento\\Quote\\Model\\Quote\\Address\\RateResult\\ErrorFactory\n     *\/\n    private $rateErrorFactory;\n\n    \/**\n     * @var \\Magento\\Quote\\Model\\Quote\\Address\\RateRequest|null\n     *\/\n    private $request = null;\n\n    \/**\n     * construct\n     *\n     * @param \\Magento\\Quote\\Model\\Quote\\Address\\RateResult\\ErrorFactory $rateErrorFactory\n     * @param \\Webkul\\ShippingRestrictions\\Model\\RestrictionRule $restrictionRule\n     * @param \\Webkul\\ShippingRestrictions\\Helper\\Data $helper\n     *\/\n    public function __construct(\n        \\Magento\\Quote\\Model\\Quote\\Address\\RateResult\\ErrorFactory $rateErrorFactory\n    ) {\n        $this-&gt;rateErrorFactory = $rateErrorFactory;\n    }\n\n    \/**\n     * before plugin\n     *\n     * @param \\Magento\\Shipping\\Model\\Shipping $subject\n     * @param \\Magento\\Quote\\Model\\Quote\\Address\\RateRequest $request\n     * @return void\n     *\/\n    public function beforeCollectRates(\n        \\Magento\\Shipping\\Model\\Shipping $subject,\n        \\Magento\\Quote\\Model\\Quote\\Address\\RateRequest $request\n    ) {\n        $this-&gt;request = $request;\n    }\n\n    \/**\n     * after plugin\n     *\n     * @param \\Magento\\Shipping\\Model\\Shipping $subject\n     * @param \\Magento\\Shipping\\Model\\Rate\\Result] $result\n     * @return void\n     *\/\n    public function afterCollectRates(\\Magento\\Shipping\\Model\\Shipping $subject, $result)\n    {\n        $result = $subject-&gt;getResult();\n        $rates = $result-&gt;getAllRates();\n        $result-&gt;reset();\n        foreach ($rates as $rate) {\n            $restrict = false;\n            if ($rate-&gt;getCarrier() == &#039;custom_shipping&#039;) {\n                $restrict = true;\n                $this-&gt;setError($result, $rate);\n            }\n            if (!$restrict) {\n                $result-&gt;append($rate);\n            }\n\n        }\n\n        return $subject;\n    }\n\n    \/**\n     * set error message\n     * @param \\Magento\\Shipping\\Model\\Rate\\Result $result\n     * @param \\Magento\\Quote\\Model\\Quote\\Address\\RateResult\\Method $rate\n     *\n     * @return bool\n     *\/\n    private function setError($result, $rate)\n    {\n        $errorMessage = __(&#039;Sorry, shipping method is restricted&#039;);\n\n        if ($rate !== null &amp;&amp; $errorMessage) {\n            $error = $this-&gt;rateErrorFactory-&gt;create();\n            $error-&gt;setCarrier($rate-&gt;getCarrier());\n            $error-&gt;setCarrierTitle($rate-&gt;getCarrierTitle().&#039; (&#039;.$rate-&gt;getMethodTitle().&#039;)&#039;);\n            $error-&gt;setErrorMessage($errorMessage);\n\n            $result-&gt;append($error);\n        }\n    }\n}<\/pre>\n\n\n\n<p>That&#8217;s all we have to do. <\/p>\n\n\n\n<p>Thank you<\/p>\n\n\n\n<p>Happy Coding \ud83d\ude42<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Many times we want to restrict some shipping methods according to some conditions. So if you are looking for the same, we have a solution for you. We have to create an after plugin for collectRates. So here is our di.xml code. If you are not aware with shipping method development then please visit &#8211; <a href=\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\">[&#8230;]<\/a><\/p>\n","protected":false},"author":376,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[302],"tags":[2070],"class_list":["post-299717","post","type-post","status-publish","format-standard","hentry","category-magento2","tag-magento2"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Restrict custom shipping methods in Magento 2 Webkul Blog<\/title>\n<meta name=\"description\" content=\"restrict custom shipping programmatically. How to restrict custom shipping methods programmatically. So if you are looking for the same...\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Restrict custom shipping methods in Magento 2 Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"restrict custom shipping programmatically. How to restrict custom shipping methods programmatically. So if you are looking for the same...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\" \/>\n<meta property=\"og:site_name\" content=\"Webkul Blog\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/webkul\/\" \/>\n<meta property=\"article:published_time\" content=\"2021-08-06T08:21:58+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-02-22T09:44:02+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-og.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"630\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Deepak Tiwari\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@webkul\" \/>\n<meta name=\"twitter:site\" content=\"@webkul\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Deepak Tiwari\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\"},\"author\":{\"name\":\"Deepak Tiwari\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/f1f005cfc0c9af7f93910041dce67985\"},\"headline\":\"Restrict custom shipping methods in Magento 2\",\"datePublished\":\"2021-08-06T08:21:58+00:00\",\"dateModified\":\"2024-02-22T09:44:02+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\"},\"wordCount\":97,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"keywords\":[\"Magento2\"],\"articleSection\":[\"Magento2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\",\"url\":\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\",\"name\":\"Restrict custom shipping methods in Magento 2 Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"datePublished\":\"2021-08-06T08:21:58+00:00\",\"dateModified\":\"2024-02-22T09:44:02+00:00\",\"description\":\"restrict custom shipping programmatically. How to restrict custom shipping methods programmatically. So if you are looking for the same...\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Restrict custom shipping methods in Magento 2\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/webkul.com\/blog\/#website\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"name\":\"Webkul Blog\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/webkul.com\/blog\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/webkul.com\/blog\/#organization\",\"name\":\"WebKul Software Private Limited\",\"url\":\"https:\/\/webkul.com\/blog\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"contentUrl\":\"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png\",\"width\":380,\"height\":380,\"caption\":\"WebKul Software Private Limited\"},\"image\":{\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/webkul\/\",\"https:\/\/x.com\/webkul\",\"https:\/\/www.instagram.com\/webkul\/\",\"https:\/\/www.linkedin.com\/company\/webkul\",\"https:\/\/www.youtube.com\/user\/webkul\/\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/f1f005cfc0c9af7f93910041dce67985\",\"name\":\"Deepak Tiwari\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/d6f4542bf07455806d05215f870ee8d6ab4bfbdcd1446d3a3143de3b6b0680ba?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/d6f4542bf07455806d05215f870ee8d6ab4bfbdcd1446d3a3143de3b6b0680ba?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Deepak Tiwari\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/deepak-tiwari301\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Restrict custom shipping methods in Magento 2 Webkul Blog","description":"restrict custom shipping programmatically. How to restrict custom shipping methods programmatically. So if you are looking for the same...","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/","og_locale":"en_US","og_type":"article","og_title":"Restrict custom shipping methods in Magento 2 Webkul Blog","og_description":"restrict custom shipping programmatically. How to restrict custom shipping methods programmatically. So if you are looking for the same...","og_url":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2021-08-06T08:21:58+00:00","article_modified_time":"2024-02-22T09:44:02+00:00","og_image":[{"width":1200,"height":630,"url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-og.png","type":"image\/png"}],"author":"Deepak Tiwari","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Deepak Tiwari","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/"},"author":{"name":"Deepak Tiwari","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/f1f005cfc0c9af7f93910041dce67985"},"headline":"Restrict custom shipping methods in Magento 2","datePublished":"2021-08-06T08:21:58+00:00","dateModified":"2024-02-22T09:44:02+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/"},"wordCount":97,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"keywords":["Magento2"],"articleSection":["Magento2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/","url":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/","name":"Restrict custom shipping methods in Magento 2 Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"datePublished":"2021-08-06T08:21:58+00:00","dateModified":"2024-02-22T09:44:02+00:00","description":"restrict custom shipping programmatically. How to restrict custom shipping methods programmatically. So if you are looking for the same...","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/restrict-custom-shipping-methods-magento2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Restrict custom shipping methods in Magento 2"}]},{"@type":"WebSite","@id":"https:\/\/webkul.com\/blog\/#website","url":"https:\/\/webkul.com\/blog\/","name":"Webkul Blog","description":"","publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/webkul.com\/blog\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/webkul.com\/blog\/#organization","name":"WebKul Software Private Limited","url":"https:\/\/webkul.com\/blog\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/","url":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","contentUrl":"https:\/\/cdnblog.webkul.com\/blog\/wp-content\/uploads\/2021\/08\/webkul-logo-accent-sq.png","width":380,"height":380,"caption":"WebKul Software Private Limited"},"image":{"@id":"https:\/\/webkul.com\/blog\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/webkul\/","https:\/\/x.com\/webkul","https:\/\/www.instagram.com\/webkul\/","https:\/\/www.linkedin.com\/company\/webkul","https:\/\/www.youtube.com\/user\/webkul\/"]},{"@type":"Person","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/f1f005cfc0c9af7f93910041dce67985","name":"Deepak Tiwari","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/d6f4542bf07455806d05215f870ee8d6ab4bfbdcd1446d3a3143de3b6b0680ba?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/d6f4542bf07455806d05215f870ee8d6ab4bfbdcd1446d3a3143de3b6b0680ba?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Deepak Tiwari"},"url":"https:\/\/webkul.com\/blog\/author\/deepak-tiwari301\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/299717","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/users\/376"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=299717"}],"version-history":[{"count":6,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/299717\/revisions"}],"predecessor-version":[{"id":367209,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/299717\/revisions\/367209"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=299717"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=299717"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=299717"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}