Magento – Magento 2 Product Custom Attribute in API rest

apicustom-attributesextension-attributesmagento-2.0rest

I added a product custom attribute (type text) through the admin interface.

Now I'm trying to save a product through the api rest but if I include the new attribute in the data passed I get this error:

Property "NeedsSync" does not have corresponding setter in class "Magento\Catalog\Api\Data\ProductInterface"

I've read about extension attributes but I'm not sure if that's the way to do this in particular case.

I've tried to add as extension attribute by adding a etc/extension_attributes.xml with this content:

<extension_attributes for="Magento\Catalog\Api\Data\ProductInterface">
    <attribute code="needs_sync" type="string">
    </attribute>
</extension_attributes>

I've also read about the way of definig database table and join in the extension_attribute.xml for this attribute but I'm not sure this is the correct way, as this is a eav attribute for product entity so it is not a new table…

Best Answer

I figured it by myself... extension attributes are for more complex info.

For this particular case where it is a "simple" custom attribute (of type string), the way for updating via API is just to pass it inside of custom attributes array:

    $headers = array(
        'Content-Type: application/json',
        'Authorization: Bearer ' . $token
    );
    $data = array(
        'product' => array(
            'custom_attributes' => array(
                '0' => array(
                    'attribute_code' => 'needs_sync',
                    'value' => '0'
                )
            )
        )
    );
    $data = json_encode($data);
    $requestUrl = $this->_baseUrl . '/index.php/rest/V1/products/' . $sku;
    $ch = curl_init($requestUrl);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    $result = curl_exec($ch);

Related Solutions

Magento – Magento2 : Filtering product list by extension attribute

this method you used was fine as below:

$filter=$this->filterBuilder
        ->setField('extensionattribute1')
        ->setValue('20')
        ->create();

the change that I found to make the filter working was to add a filterProcessor so that you can declare the extension attribute filter as a custom filter

in the di.xml, declaring a virtual type does exactly this:

<virtualType name="Magento\Eav\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor" type="Magento\Framework\Api\SearchCriteria\CollectionProcessor\FilterProcessor">
            <arguments>
                <argument name="customFilters" xsi:type="array">
                    <item name="training_extensionattributes_values" xsi:type="object">Mbs\ProductExtensionAttributes\Model\Api\SearchCriteria\CollectionProcessor\FilterProcessor\TrainingExtensionattributesValuesFilter</item>
                </argument>
            </arguments>
    </virtualType>

finally the filter code below does the filter for my situation.

class TrainingExtensionattributesValuesFilter implements \Magento\Framework\Api\SearchCriteria\CollectionProcessor\FilterProcessor\CustomFilterInterface
{
    /**
     * @inheritDoc
     */
    public function apply(Filter $filter, AbstractDb $collection)
    {
        $collection->getSelect()->where('extension_attribute_training_extensionattributes_values.extension_value1 like ?', $filter->getValue() . '%');
        return true;
    }
}

Magento 2.3.2 – Fix Extension Attribute Error in ProductExtension

I guess I just found the answer. You just have to iterate the core product collection and set the data in your custom interface.

Non-working old code/buggy code :

public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)
    {
       $collection = $this->productCollectionFactory->create();
      /*Join custom data with main/core product collection. */
       $collection = $this->joinExtraTablesForCustomData($collection);
       $searchResult->setSearchCriteria($searchCriteria);
       $searchResult->setItems($collection->getItems());
       $searchResult->setTotalCount($collection->getSize());
       return $searchResult;
    }

The problem in above code is $collection->getItems() will have an array objects of type \Magento\Catalog\Api\Data\ProductInterface. So we have to explicitly change the type to Custom Interface as mentioned below.

This works perfectly fine.

public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)
{
   $collection = $this->productCollectionFactory->create();
  /*Join custom data with main/core product collection. */
   $collection = $this->joinExtraTablesForCustomData($collection);
   foreach ($collection as $item)
   {
       $customProduct = $this->customProductInterfaceFactory->create();
       $customProduct->setData($item->getData());
       $customProducts[] = $customProduct;
   }
   $searchResult->setSearchCriteria($searchCriteria);
   $searchResult->setItems($customProducts);
   $searchResult->setTotalCount($collection->getSize());
   return $searchResult;
}

Best Answer

Related Solutions

Magento – Magento2 : Filtering product list by extension attribute

Magento 2.3.2 – Fix Extension Attribute Error in ProductExtension

Related Topic