{"id":165840,"date":"2019-03-08T05:31:14","date_gmt":"2019-03-08T05:31:14","guid":{"rendered":"https:\/\/webkul.com\/blog\/?p=165840"},"modified":"2025-12-18T08:58:09","modified_gmt":"2025-12-18T08:58:09","slug":"return-json-data-with-ajax-cal-in-magento-2","status":"publish","type":"post","link":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/","title":{"rendered":"Return JSON Data with AJAX call in Magento 2"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\">Introduction<\/h2>\n\n\n\n<p>AJAX plays an important role in Magento 2 when you want to update data on the page without a full reload.<\/p>\n\n\n\n<p>Its Common use cases include loading dynamic content, validating data, fetching customer-specific information, or building custom admin and frontend features.<\/p>\n\n\n\n<p>In Magento 2, returning <strong>JSON responses<\/strong> from an AJAX controller is the recommended and clean approach. This blog explains how to <strong>return JSON data from an AJAX call in Magento 2<\/strong> with a simple example.<\/p>\n\n\n\n<p>For that, we can use the Magento core class,<\/p>\n\n\n\n<pre class=\"wp-block-preformatted brush:php\">Magento\\Framework\\Controller\\ResultFactory<\/pre>\n\n\n\n<p class=\"brush:php\">which has a list of constants mapped to corresponding classes :<\/p>\n\n\n\n<pre class=\"wp-block-preformatted brush:php\">self::TYPE_JSON =&gt; 'Magento\\Framework\\Controller\\Result\\Json',\nself::TYPE_RAW =&gt; 'Magento\\Framework\\Controller\\Result\\Raw',\nself::TYPE_REDIRECT =&gt; 'Magento\\Framework\\Controller\\Result\\Redirect',\nself::TYPE_FORWARD =&gt; 'Magento\\Framework\\Controller\\Result\\Forward',\nself::TYPE_LAYOUT =&gt; 'Magento\\Framework\\View\\Result\\Layout',\nself::TYPE_PAGE =&gt; 'Magento\\Framework\\View\\Result\\Page'<\/pre>\n\n\n\n<p>Among these, we can use the constant to return JSON data :<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\" data-enlighter-theme=\"\" data-enlighter-highlight=\"\" data-enlighter-linenumbers=\"\" data-enlighter-lineoffset=\"\" data-enlighter-title=\"\" data-enlighter-group=\"\">const TYPE_JSON = 'json'<\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">Create an AJAX Controller<\/h2>\n\n\n\n<p>Magento 2 provides a dedicated JSON result type to return data in JSON format.<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\">&lt;?php\nnamespace Vendor\\Module\\Controller\\Index;\n\nuse Magento\\Framework\\App\\Action\\Action;\nuse Magento\\Framework\\App\\Action\\Context;\nuse Magento\\Framework\\Controller\\Result\\JsonFactory;\n\nclass Ajax extends Action\n{\n    protected $resultJsonFactory;\n\n    public function __construct(\n        Context $context,\n        JsonFactory $resultJsonFactory\n    ) {\n        parent::__construct($context);\n        $this-&gt;resultJsonFactory = $resultJsonFactory;\n    }\n\n    public function execute()\n    {\n        $result = $this-&gt;resultJsonFactory-&gt;create();\n\n        $data = &#091;\n            &#039;success&#039; =&gt; true,\n            &#039;message&#039; =&gt; &#039;JSON response returned successfully&#039;\n        ];\n\n        return $result-&gt;setData($data);\n    }\n}<\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">Call AJAX from Frontend (jQuery Example)<\/h2>\n\n\n\n<p>Magento 2 includes jQuery by default, so you can easily make an AJAX request.<\/p>\n\n\n\n<pre class=\"EnlighterJSRAW\">require(&#091;&#039;jquery&#039;], function ($) {\n    $.ajax({\n        url: &#039;\/module\/index\/ajax&#039;,\n        type: &#039;POST&#039;,\n        dataType: &#039;json&#039;,\n        success: function (response) {\n            console.log(response.message);\n        }\n    });\n});<\/pre>\n\n\n\n<h2 class=\"wp-block-heading\">JSON Response Output<\/h2>\n\n\n\n<p>The controller returns a JSON response like this:<\/p>\n\n\n\n<p>{<br>&#8220;success&#8221;: true,<br>&#8220;message&#8221;: &#8220;JSON response returned successfully&#8221;<br>}<\/p>\n\n\n\n<p>If you require technical support, feel free to email us at&nbsp;<a href=\"mailto:support@webkul.com\">support@webkul.com<\/a>.<\/p>\n\n\n\n<p>Additionally, explore a wide array of solutions to boost your store\u2019s capabilities by visiting the&nbsp;<a href=\"https:\/\/store.webkul.com\/Magento-2.html\">Adobe Commerce modules&nbsp;<\/a>section.<\/p>\n\n\n\n<p>For expert advice or to create tailored features,&nbsp;<a href=\"https:\/\/webkul.com\/hire-magento-developers\/\">hire Adobe Commerce Developers<\/a>&nbsp;for your project.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Introduction AJAX plays an important role in Magento 2 when you want to update data on the page without a full reload. Its Common use cases include loading dynamic content, validating data, fetching customer-specific information, or building custom admin and frontend features. In Magento 2, returning JSON responses from an AJAX controller is the recommended <a href=\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/\">[&#8230;]<\/a><\/p>\n","protected":false},"author":170,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[302],"tags":[250,8248,236,2070],"class_list":["post-165840","post","type-post","status-publish","format-standard","hentry","category-magento2","tag-ajax","tag-how-to-return-json-data-from-controller-while-calling-ajax-in-magento-2","tag-json","tag-magento2"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Return JSON Data with AJAX call in Magento 2 - Webkul Blog<\/title>\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\/return-json-data-with-ajax-cal-in-magento-2\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Return JSON Data with AJAX call in Magento 2 - Webkul Blog\" \/>\n<meta property=\"og:description\" content=\"Introduction AJAX plays an important role in Magento 2 when you want to update data on the page without a full reload. Its Common use cases include loading dynamic content, validating data, fetching customer-specific information, or building custom admin and frontend features. In Magento 2, returning JSON responses from an AJAX controller is the recommended [...]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/\" \/>\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=\"2019-03-08T05:31:14+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2025-12-18T08:58:09+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=\"Prabhat Rawat\" \/>\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=\"Prabhat Rawat\" \/>\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\/return-json-data-with-ajax-cal-in-magento-2\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/\"},\"author\":{\"name\":\"Prabhat Rawat\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/3d52d6c1ad8a809d2f7548e6a9c3358f\"},\"headline\":\"Return JSON Data with AJAX call in Magento 2\",\"datePublished\":\"2019-03-08T05:31:14+00:00\",\"dateModified\":\"2025-12-18T08:58:09+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/\"},\"wordCount\":220,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/webkul.com\/blog\/#organization\"},\"keywords\":[\"ajax\",\"How to Return JSON Data from Controller While calling AJAX in Magento 2\",\"json\",\"Magento2\"],\"articleSection\":[\"Magento2\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/\",\"url\":\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/\",\"name\":\"Return JSON Data with AJAX call in Magento 2 - Webkul Blog\",\"isPartOf\":{\"@id\":\"https:\/\/webkul.com\/blog\/#website\"},\"datePublished\":\"2019-03-08T05:31:14+00:00\",\"dateModified\":\"2025-12-18T08:58:09+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/webkul.com\/blog\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Return JSON Data with AJAX call 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\/3d52d6c1ad8a809d2f7548e6a9c3358f\",\"name\":\"Prabhat Rawat\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/616ec5deaf63b72b3003cf99e608ae354f4d373cee8d25b2d0bfa65cab270ad8?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\/616ec5deaf63b72b3003cf99e608ae354f4d373cee8d25b2d0bfa65cab270ad8?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g\",\"caption\":\"Prabhat Rawat\"},\"url\":\"https:\/\/webkul.com\/blog\/author\/prabhat-rawat763\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Return JSON Data with AJAX call in Magento 2 - Webkul Blog","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\/return-json-data-with-ajax-cal-in-magento-2\/","og_locale":"en_US","og_type":"article","og_title":"Return JSON Data with AJAX call in Magento 2 - Webkul Blog","og_description":"Introduction AJAX plays an important role in Magento 2 when you want to update data on the page without a full reload. Its Common use cases include loading dynamic content, validating data, fetching customer-specific information, or building custom admin and frontend features. In Magento 2, returning JSON responses from an AJAX controller is the recommended [...]","og_url":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/","og_site_name":"Webkul Blog","article_publisher":"https:\/\/www.facebook.com\/webkul\/","article_published_time":"2019-03-08T05:31:14+00:00","article_modified_time":"2025-12-18T08:58:09+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":"Prabhat Rawat","twitter_card":"summary_large_image","twitter_creator":"@webkul","twitter_site":"@webkul","twitter_misc":{"Written by":"Prabhat Rawat","Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/#article","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/"},"author":{"name":"Prabhat Rawat","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/3d52d6c1ad8a809d2f7548e6a9c3358f"},"headline":"Return JSON Data with AJAX call in Magento 2","datePublished":"2019-03-08T05:31:14+00:00","dateModified":"2025-12-18T08:58:09+00:00","mainEntityOfPage":{"@id":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/"},"wordCount":220,"commentCount":0,"publisher":{"@id":"https:\/\/webkul.com\/blog\/#organization"},"keywords":["ajax","How to Return JSON Data from Controller While calling AJAX in Magento 2","json","Magento2"],"articleSection":["Magento2"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/","url":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/","name":"Return JSON Data with AJAX call in Magento 2 - Webkul Blog","isPartOf":{"@id":"https:\/\/webkul.com\/blog\/#website"},"datePublished":"2019-03-08T05:31:14+00:00","dateModified":"2025-12-18T08:58:09+00:00","breadcrumb":{"@id":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/webkul.com\/blog\/return-json-data-with-ajax-cal-in-magento-2\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/webkul.com\/blog\/"},{"@type":"ListItem","position":2,"name":"Return JSON Data with AJAX call 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\/3d52d6c1ad8a809d2f7548e6a9c3358f","name":"Prabhat Rawat","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/webkul.com\/blog\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/616ec5deaf63b72b3003cf99e608ae354f4d373cee8d25b2d0bfa65cab270ad8?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\/616ec5deaf63b72b3003cf99e608ae354f4d373cee8d25b2d0bfa65cab270ad8?s=96&d=https%3A%2F%2Fcdnblog.webkul.com%2Fblog%2Fwp-content%2Fuploads%2F2019%2F10%2Fmike.png&r=g","caption":"Prabhat Rawat"},"url":"https:\/\/webkul.com\/blog\/author\/prabhat-rawat763\/"}]}},"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/165840","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\/170"}],"replies":[{"embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/comments?post=165840"}],"version-history":[{"count":13,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/165840\/revisions"}],"predecessor-version":[{"id":517956,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/posts\/165840\/revisions\/517956"}],"wp:attachment":[{"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/media?parent=165840"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/categories?post=165840"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/webkul.com\/blog\/wp-json\/wp\/v2\/tags?post=165840"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}