ProductRepositoryInterface Interface Reference

Inheritance diagram for ProductRepositoryInterface:

Public Member Functions
	save (\Magento\Catalog\Api\Data\ProductInterface $product, $saveOptions=false)
	get ($sku, $editMode=false, $storeId=null, $forceReload=false)
	getById ($productId, $editMode=false, $storeId=null, $forceReload=false)
	delete (\Magento\Catalog\Api\Data\ProductInterface $product)
	deleteById ($sku)
	getList (\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria)

Detailed Description

@api

Since

100.0.2

Definition at line 14 of file ProductRepositoryInterface.php.

Member Function Documentation

delete()

delete

(

\Magento\Catalog\Api\Data\ProductInterface

$product

)

Delete product

Parameters

\Magento\Catalog\Api\Data\ProductInterface

$product

Returns

bool Will returned True if deleted

Exceptions

deleteById()

deleteById

(

$sku

)

Parameters

string

$sku

Returns

bool Will returned True if deleted

Exceptions

Implemented in ProductRepository.

get()

get	(		$sku,
			$editMode = false,
			$storeId = null,
			$forceReload = false
	)

Get info about product by product SKU

Parameters

string	$sku
bool	$editMode
int | null	$storeId
bool	$forceReload

Returns

\Magento\Catalog\Api\Data\ProductInterface

Exceptions

Implemented in ProductRepository.

getById()

getById	(		$productId,
			$editMode = false,
			$storeId = null,
			$forceReload = false
	)

Get info about product by product id

Parameters

int	$productId
bool	$editMode
int | null	$storeId
bool	$forceReload

Returns

\Magento\Catalog\Api\Data\ProductInterface

Exceptions

Implemented in ProductRepository.

getList()

getList

(

\Magento\Framework\Api\SearchCriteriaInterface

$searchCriteria

)

Get product list

Parameters

\Magento\Framework\Api\SearchCriteriaInterface

$searchCriteria

Returns

\Magento\Catalog\Api\Data\ProductSearchResultsInterface

save()

save	(	\Magento\Catalog\Api\Data\ProductInterface	$product,
			$saveOptions = false
	)

Create product

Parameters

\Magento\Catalog\Api\Data\ProductInterface	$product
bool	$saveOptions

Returns

\Magento\Catalog\Api\Data\ProductInterface

Exceptions

---

The documentation for this interface was generated from the following file:

• vendor/magento/module-catalog/Api/ProductRepositoryInterface.php