Magento – Magento 2 Rest Api get Products List including qty field

magento-2.1productsqtyrest api

I am trying to make an api call to get a list of products. I am using searchCriteria to filter the products collection. The following information of the product is needed:

–sku, name, id, price, status, visibility, type_id, qty, image-url, small-image-url

The following call gives all information, excluding qty:

http://127.0.0.1/rest/V1/products/?searchCriteria[filter_groups][0][filters][0][field]=price&searchCriteria[filter_groups][0][filters][0][value]=25&searchCriteria[filter_groups][0][filters][0][condition_type]=from&searchCriteria[filter_groups][0][filters][1][field]=price&searchCriteria[filter_groups][0][filters][1][value]=500&searchCriteria[filter_groups][0][filters][1][condition_type]=to&searchCriteria[pageSize]=2&searchCriteria[currentPage]=1

{
"items": [
    {
        "id": 1,
        "sku": "Test",
        "name": "Test 100x100",
        "attribute_set_id": 4,
        "price": 200,
        "status": 1,
        "visibility": 4,
        "type_id": "simple",
        "created_at": "2017-08-23 17:48:05",
        "updated_at": "2017-08-23 17:48:05",
        "weight": 1,
        "extension_attributes": [],
        "product_links": [],
        "tier_prices": [],
        "custom_attributes": [
            {
                "attribute_code": "meta_title",
                "value": "Test"
            },
            {
                "attribute_code": "meta_keyword",
                "value": "Test"
            },
            {
                "attribute_code": "meta_description",
                "value": "Test "
            },
            {
                "attribute_code": "image",
                "value": "/c/a/cat1.png"
            },
            {
                "attribute_code": "small_image",
                "value": "/c/a/cat1.png"
            },
            {
                "attribute_code": "thumbnail",
                "value": "/c/a/cat1.png"
            },
            {
                "attribute_code": "options_container",
                "value": "container2"
            },
            {
                "attribute_code": "required_options",
                "value": "0"
            },
            {
                "attribute_code": "has_options",
                "value": "0"
            },
            {
                "attribute_code": "url_key",
                "value": "test"
            },
            {
                "attribute_code": "swatch_image",
                "value": "/c/a/cat1.png"
            },
            {
                "attribute_code": "tax_class_id",
                "value": "2"
            },
            {
                "attribute_code": "gift_message_available",
                "value": "2"
            },
            {
                "attribute_code": "laenge_intern",
                "value": "100.0000"
            },
            {
                "attribute_code": "breite_intern",
                "value": "100.0000"
            },
            {
                "attribute_code": "sw_featured",
                "value": "0"
            }
        ]
    },
    {
        "id": 2,
        "sku": "Test-1",
        "name": "Test 100x110",
        "attribute_set_id": 4,
        "price": 200,
        "status": 1,
        "visibility": 4,
        "type_id": "simple",
        "created_at": "2017-08-29 20:20:54",
        "updated_at": "2017-08-29 20:20:54",
        "weight": 1,
        "extension_attributes": [],
        "product_links": [],
        "tier_prices": [],
        "custom_attributes": [
            {
                "attribute_code": "meta_title",
                "value": "Test"
            },
            {
                "attribute_code": "meta_keyword",
                "value": "Test"
            },
            {
                "attribute_code": "meta_description",
                "value": "Test "
            },
            {
                "attribute_code": "image",
                "value": "/c/a/cat1_1.png"
            },
            {
                "attribute_code": "small_image",
                "value": "/c/a/cat1_1.png"
            },
            {
                "attribute_code": "thumbnail",
                "value": "/c/a/cat1_1.png"
            },
            {
                "attribute_code": "options_container",
                "value": "container2"
            },
            {
                "attribute_code": "required_options",
                "value": "0"
            },
            {
                "attribute_code": "has_options",
                "value": "0"
            },
            {
                "attribute_code": "url_key",
                "value": "test-1"
            },
            {
                "attribute_code": "swatch_image",
                "value": "/c/a/cat1_1.png"
            },
            {
                "attribute_code": "tax_class_id",
                "value": "2"
            },
            {
                "attribute_code": "gift_message_available",
                "value": "2"
            },
            {
                "attribute_code": "laenge_intern",
                "value": "100.0000"
            },
            {
                "attribute_code": "breite_intern",
                "value": "110.0000"
            },
            {
                "attribute_code": "sw_featured",
                "value": "0"
            }
        ]
    }
],
"search_criteria": {
    "filter_groups": [
        {
            "filters": [
                {
                    "field": "price",
                    "value": "25",
                    "condition_type": "from"
                },
                {
                    "field": "price",
                    "value": "500",
                    "condition_type": "to"
                }
            ]
        }
    ],
    "page_size": 2,
    "current_page": 1
},
"total_count": 6
}

In the Doc Site http://devdocs.magento.com/guides/v2.1/howdoi/webapi/filter-response.html they mention the 'fields' parameter to get the items qty. I tried the following call, but it still does not include qty into the response:

As expected it returns items with id, sku, name. But no qty.

How to get item qty in the response ?

Thanks

Best Answer

In my response I found qty in extension_attributes.

"extension_attributes": {
    "stock_item": {
        "item_id": 4876,
        "product_id": 4884,
        "stock_id": 1,
        "qty": 0,
        ...

If you use custom product type you need to add special config for product type (etc/product_types.xml).

isQty="true"

Example:

<type name="mySpecialType" label="MySpecialType Product" isQty="true" ...

Related Solutions

Magento – Magento 2 Rest Get Orders C#

I'm building the code like this:

    public class ApiClient
{

    public ApiClient(string magentoServer, string consumerKey, string consumerSecret, string accessToken, string accessTokenSeccret)
    {
        MagentoServer = magentoServer;
        ConsumerKey = consumerKey;
        ConsumerSecret = consumerSecret;
        AccessToken = accessToken;
        AccessTokenSecret = accessTokenSeccret;
    }

    #region Request

    public HttpWebRequest CreateAuthorizedRequest(string url, string requestMethod, string filter)
    {
        HttpWebRequest request = null;
        if (filter == null)
            request = (HttpWebRequest)WebRequest.Create(url);
        else
            request = (HttpWebRequest)WebRequest.Create(url + "?" + filter.ToString());

        OAuthBase oAuth = new OAuthBase();
        string nonce = oAuth.GenerateNonce();
        string timeStamp = oAuth.GenerateTimeStamp();
        string parameters;
        string normalizedUrl;
        string signature = oAuth.GenerateSignature(new Uri(url), ConsumerKey, ConsumerSecret,
        AccessToken, AccessTokenSecret, requestMethod, timeStamp, nonce, OAuthBase.SignatureTypes.HMACSHA1,
        out normalizedUrl, out parameters);

        StringBuilder sb = new StringBuilder("OAuth ");
        sb.AppendFormat("oauth_token=\"{0}\",", AccessToken);
        sb.AppendFormat("oauth_version=\"{0}\",", "1.0");
        sb.AppendFormat("oauth_signature_method=\"{0}\",", "HMAC-SHA1");
        sb.AppendFormat("oauth_nonce=\"{0}\",", nonce);
        sb.AppendFormat("oauth_timestamp=\"{0}\",", timeStamp);
        sb.AppendFormat("oauth_consumer_key=\"{0}\",", ConsumerKey);
        sb.AppendFormat("oauth_signature=\"{0}\"", signature);

        request.Headers[HttpRequestHeader.Authorization] = sb.ToString();
        request.Method = requestMethod;

        request.Accept = "application/json";
        request.ContentType = "application/json";
        request.KeepAlive = true;

        return request;
    }

    public string FetchRequest(HttpWebRequest request)
    {
        try
        {
            string responseText = string.Empty;
            HttpWebResponse response = (HttpWebResponse)request.GetResponse();
            if (response.StatusCode == HttpStatusCode.OK)
            {
                using (Stream responseStream = response.GetResponseStream())
                {
                    using (StreamReader responseReader = new StreamReader(responseStream))
                    {
                        responseText = responseReader.ReadToEnd();
                        return responseText;
                    }
                }
            }

            return responseText;
        }
        catch (WebException ex)
        {
            Console.WriteLine("Error: " + ex.Message);
            return null;
        }
    }






    public static string GetValues(string _call, string method)
    {
        ApiClient client = new ApiClient(MagentoServer, ConsumerKey, ConsumerSecret, AccessToken, AccessTokenSecret);
        string url = url_base + _call;
        string t = null;
        HttpWebRequest myReq = client.CreateAuthorizedRequest(url, method, null);
        t = client.FetchRequest(myReq);
        if (t != null)
            t = t.Replace("\\/", "/");
        return t;
    }

The call it's made like:

        public string url = "http://" + magentoServer;
        public string url_base = "/index.php/rest/V1/";


        string _call = "orders?";
        _call += "searchCriteria[currentPage]=1&";
        _call += "searchCriteria[pageSize]=1";
        string _resp = Magento2Form.GetValues(_call, "GET", null);

This single call only with pageSize and currentPage gives me the answer:

Error: The remote server returned an error: (401) Unauthorized.

Magento – How to get qty of a product using rest api

Try using /V1/stockItems/:productSku

For more details, you can go through https://devdocs.magento.com/guides/v2.0/rest/list.html#cataloginventory

Best Answer

Related Solutions

Magento – Magento 2 Rest Get Orders C#

Magento – How to get qty of a product using rest api

Related Topic