Magento – Optional parameter in Magento 2 REST API

apimagento2

I have a API route like,

<route url="/V1/product/:productId" method="GET">
    <service class="Vendor\Sample\Api\SampleInterface" method="sample"/>
    <resources>
        <resource ref="anonymous"/>
    </resources>
</route>

As you can see this route has a required parameter productId. Is it possible to add a optional parameter to this route?

Something like,

<route url="/V1/product/:productId/:optionalParam" method="GET">

Thanks in advance!!

Best Answer

I may be wrong but I don't think you can declare a specific parameter as optional from within the xml file, though you can declare your routes in such a way that the parameter becomes optional.
For example if you changed your xml to:

<route url="/V1/product/:productId" method="GET">
    <service class="Vendor\Sample\Api\SampleInterface" method="sample"/>
    <resources>
        <resource ref="anonymous"/>
    </resources>
</route>
<route url="/V1/product/:productId/:optionalParam" method="GET">
    <service class="Vendor\Sample\Api\SampleInterface" method="sample"/>
    <resources>
        <resource ref="anonymous"/>
    </resources>
</route>

So long as the underlying method supports it being optional, something like:

public function sample($productId, $optionalParam = null)

This allows the code defined in that method to treat $optionalParam as optional.

Related Solutions

Magento 2 Custom WebAPI Attribute – Explanation Guide

Route url specify the url of your call in your case its V1/product so after your store url you need to hit this url. If suppose we are doing sum of two prodcts and my webapi.xml is as below,

<?xml version="1.0"?>
<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">

    <route url="/V1/calculator/add/:num1/:num2" method="GET">
        <service class="Test\Calculator\Api\CalculatorInterface" method="add"/>
        <resources>
            <resource ref="anonymous"/>
        </resources>
    </route>
</routes>

I will hit url,http://10.16.16.190/magentoce27/index.php/rest/V1/calculator/add/1/2

where route url matches url and paramerters as above,

Now, service class defines API Interface for the purpose of method declaration for example,

<?php

namespace Test\Calculator\Api;

interface CalculatorInterface
{
    /**
     * Add two numbers.
     *
     * @param int $num1
     * @param int $num2
     * @return int
     */
    public function add($num1, $num2);
}

?>

If you get a token with a customer username/password, you can only access API methods with <resource ref="self"></resource> or <resource ref="anonymous"></resource>. The <resource ref="anonymous"></resource> methods can be called without any authorization.

Magento – Magento 2.1.1 Rest API Update price only

You can use the following rest PUT call:

/rest/V1/products/{SKU}

Passing the following json:

{
"product": {
  "price": 9.63,
  "extension_attributes": {
    "stock_item": {
      "qty": 63
    }
  }
 }
}

So you can update price and stock quantity with one single call. You can remove the extension_attributes value, if you only want to update the price.

EDIT

You will need a quotation mark for your price, like this below. I don't quite understand why because the price should be a double variable in the database.

{ 
    "product":{ 
        "price":"9.63",
        "extension_attributes":{ 
            "stock_item":{ 
                "qty":63
            }
        }
    }
}

Best Answer

Related Solutions

Magento 2 Custom WebAPI Attribute – Explanation Guide

Magento – Magento 2.1.1 Rest API Update price only

Related Topic