Magento – Magento 2 REST API get all enabled categories

magento2rest api

Wanted to use REST API to get all categories where is_active attribute is true.

Here is endpoint I am calling https://www.domain.com/rest/default/V1/categories

Which giving me all the categories is_active is true and false.

I tried to add filters but didnt work either.

https://www.domain.com/rest/default/V1/categories?searchCriteria[filterGroups][0][filters][0][field]=is_active&searchCriteria[filterGroups][0][filters][0][value]=true&searchCriteria[filterGroups][0][filters][0][conditionType]=eq

Could someone help how to apply filter on category to get only active categories?

Best Answer

Use the below code in Postman you will find all the categories

Endpoint: “http(s)://yourdomain.com/rest/ V1/categories/list”

Method: GET
Request: searchCriteria.
Header: Authorization : Bearer (Token)
Response: token(string)

Reference : This is a reference link for the code

Also, try replacing the " list " with the default category Id. Say Default Category Id is 2. Then the endpoint will be below

Endpoint: “http(s)://yourdomain.com/rest/V1/categories/2”

Try below:

Endpoint - http://yourdomain.com/index.php/rest/all/V1/categories

Note: Make sure you pass all keyword in Url and it will works

Related Solutions

Magento – Magento 2 REST API get all product details

Hello Please find the below screen shot for Your Requirement.

First You need to Override the Core files in Your module di.xml

To display those description, meta_description and meta_title.

Note:Copy whole default core file and add the below part in respective File code.

File Path:app/code/extension_Name/Module_name/Model/Product.php

/**
     * Get product name
     *
     * @return string
     * @codeCoverageIgnoreStart
     */
    public function getDescription()
    {
        return $this->_getData(self::DESCRIPTION);
    }

    /**
     * Get product name
     *
     * @return string
     * @codeCoverageIgnoreStart
     */
    public function getMetaDescription()
    {
        return $this->_getData(self::META_DESCRIPTION);
    }

    /**
     * Get product name
     *
     * @return string
     * @codeCoverageIgnoreStart
     */
    public function getMetaTitle()
    {
        return $this->_getData(self::META_TITLE);
    }

     /**
     * Set product description
     *
     * @param string $description
     * @return $this
     */
    public function setDescription($description)
    {
        return $this->setData(self::DESCRIPTION, $description);
    }

     /**
     * Set product meta_description
     *
     * @param string $meta_description
     * @return $this
     */
    public function setMetaDescription($meta_description)
    {
        return $this->setData(self::META_DESCRIPTION, $meta_description);
    }

     /**
     * Set product meta_title
     *
     * @param string $meta_title
     * @return $this
     */
    public function setMetaTitle($meta_title)
    {
        return $this->setData(self::META_TITLE, $meta_title);
    }

File Path:app/code/extension_Name/Module_name/Api/Data/ProductInterface.php

in the above File just place the below code as per requirement

 const DESCRIPTION = 'description';

    const META_DESCRIPTION = 'meta_description';

    const META_TITLE = 'meta_title';

   /**
     * Product description
     *
     * @return string|null
     */
    public function getDescription();

    /**
     * Set product description
     *
     * @param string $description
     * @return $this
     */
    public function setDescription($description);

    /**
     * Product description
     *
     * @return string|null
     */
    public function getMetaDescription();

    /**
     * Set product meta_description
     *
     * @param string $meta_description
     * @return $this
     */
    public function setMetaDescription($meta_description);

     /**
     * Product description
     *
     * @return string|null
     */
    public function getMetaTitle();

    /**
     * Set product meta_title
     *
     * @param string $meta_title
     * @return $this
     */
    public function setMetaTitle($meta_title);

Magento 2 REST API – Get All Orders

There a good tutorial about Magento 2 API Here

On the basis of above tutorial you can get all order by:

<?php
ini_set('error_reporting', E_ALL);
ini_set("display_errors", "1");

$userData = array("username" => "Admin_username", "password" => "Admin_password");
$ch = curl_init("http://127.0.0.1/mago/index.php/rest/V1/integration/admin/token");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($userData));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Content-Type: application/json", "Content-Lenght: " . strlen(json_encode($userData))));

echo $token = curl_exec($ch);

$ch = curl_init("http://127.0.0.1/mago/index.php/rest/V1/orders?searchCriteria=all");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array("Content-Type: application/json", "Authorization: Bearer " . json_decode($token)));

$result = curl_exec($ch);

var_dump($result);

Note: searchCriteria=all and searchCriteria=0 both are giving same results

Best Answer

Related Solutions

Magento – Magento 2 REST API get all product details

Magento 2 REST API – Get All Orders

Related Topic