Inheritance diagram for Products:

Collaboration diagram for Products:

Public Member Functions
	__construct ()
	Constructor.

	get ($id, $includestockdata=0, $includesubproducts=false, $includeparentid=false, $includetrans=false)
	Get a product.

	getByRef ($ref, $includestockdata=0, $includesubproducts=false, $includeparentid=false, $includetrans=false)
	Get product by ref.

	getByRefExt ($ref_ext, $includestockdata=0, $includesubproducts=false, $includeparentid=false, $includetrans=false)
	Get product by ref_ext.

	getByBarcode ($barcode, $includestockdata=0, $includesubproducts=false, $includeparentid=false, $includetrans=false)
	Get product by barcode.

	index ($sortfield="t.ref", $sortorder='ASC', $limit=100, $page=0, $mode=0, $category=0, $sqlfilters='', $ids_only=false, $variant_filter=0, $pagination_data=false, $includestockdata=0, $properties='')
	List products.

	post ($request_data=null)
	Create a product.

	put ($id, $request_data=null)
	Update a product.

	delete ($id)
	Delete a product.

	getSubproducts ($id)
	Get the list of subproducts of a product.

	addSubproducts ($id, $subproduct_id, $qty, $incdec=1)
	Add a subproduct.

	delSubproducts ($id, $subproduct_id)
	Remove a subproduct.

	getCategories ($id, $sortfield="s.rowid", $sortorder='ASC', $limit=0, $page=0)
	Get categories for a product.

	getCustomerPricesPerSegment ($id)
	Get prices per segment for a product.

	getCustomerPricesPerCustomer ($id, $thirdparty_id='')
	Get prices per customer for a product.

	getCustomerPricesPerQuantity ($id)
	Get prices per quantity for a product.

	addPurchasePrice ($id, $qty, $buyprice, $price_base_type, $fourn_id, $availability, $ref_fourn, $tva_tx, $charges=0, $remise_percent=0, $remise=0, $newnpr=0, $delivery_time_days=0, $supplier_reputation='', $localtaxes_array=array(), $newdefaultvatcode='', $multicurrency_buyprice=0, $multicurrency_price_base_type='HT', $multicurrency_tx=1, $multicurrency_code='', $desc_fourn='', $barcode='', $fk_barcode_type=null)
	Add/Update purchase prices for a product.

	deletePurchasePrice ($id, $priceid)
	Delete a purchase price for a product.

	getSupplierProducts ($sortfield="t.ref", $sortorder='ASC', $limit=100, $page=0, $mode=0, $category=0, $supplier=0, $sqlfilters='')
	Get a list of all purchase prices of products.

	getPurchasePrices ($id, $ref='', $ref_ext='', $barcode='')
	Get purchase prices for a product.

	getAttributes ($sortfield="t.ref", $sortorder='ASC', $limit=100, $page=0, $sqlfilters='', $properties='')
	Get attributes.

	getAttributeById ($id)
	Get attribute by ID.

	getAttributesByRef ($ref)
	Get attributes by ref.

	getAttributesByRefExt ($ref_ext)
	Get attributes by ref_ext.

	addAttributes ($ref, $label, $ref_ext='')
	Add attributes.

	putAttributes ($id, $request_data=null)
	Update attributes by ID.

	deleteAttributes ($id)
	Delete attributes by ID.

	getAttributeValueById ($id)
	Get attribute value by ID.

	getAttributeValueByRef ($id, $ref)
	Get attribute value by ref.

	deleteAttributeValueByRef ($id, $ref)
	Delete attribute value by ref.

	getAttributeValues ($id)
	Get all values for an attribute ID.

	getAttributeValuesByRef ($ref)
	Get all values for an attribute ref.

	addAttributeValue ($id, $ref, $value)
	Add attribute value.

	putAttributeValue ($id, $request_data)
	Update attribute value.

	deleteAttributeValueById ($id)
	Delete attribute value by ID.

	getVariants ($id, $includestock=0)
	Get product variants.

	getVariantsByProdRef ($ref)
	Get product variants by Product ref.

	addVariant ($id, $weight_impact, $price_impact, $price_impact_is_percent, $features, $reference='', $ref_ext='')
	Add variant.

	addVariantByProductRef ($ref, $weight_impact, $price_impact, $price_impact_is_percent, $features)
	Add variant by product ref.

	putVariant ($id, $request_data=null)
	Update product variants.

	deleteVariant ($id)
	Delete product variants.

	getStock ($id, $selected_warehouse_id=null)
	Get stock data for a product.

	getContacts ($id, $type='')
	Get contacts of a given product.

	postContact ($id, $contactid, $type, $source="external", $notrigger=0)
	Add a contact type of given product.

	deleteContact ($id, $contactid, $type)
	Unlink a contact type of given product.

Public Member Functions inherited from DolibarrApi
	__construct ($db, $cachedir='', $refreshCache=false)
	Constructor.

Protected Member Functions
	_cleanObjectDatas ($object)
	Clean sensitive object data @phpstan-template T.

Protected Member Functions inherited from DolibarrApi
	_checkValForAPI ($field, $value, $object)
	Check and convert a string depending on its type/name.

	_filterObjectProperties ($object, $properties)
	Filter properties that will be returned on object.

	_checkFilters ($sqlfilters, &$error='')
	Return if a $sqlfilters parameter is valid Function no more used.

Private Member Functions
	_validate ($data)
	Validate fields before create or update object.

	_fetch ($id, $ref='', $ref_ext='', $barcode='', $includestockdata=0, $includesubproducts=false, $includeparentid=false, $includeifobjectisused=false, $includetrans=false)
	Get properties of 1 product object.

Additional Inherited Members
Static Protected Member Functions inherited from DolibarrApi
static	_checkAccessToResource ($resource, $resource_id=0, $dbtablename='', $feature2='', $dbt_keyfield='fk_soc', $dbt_select='rowid')
	Check access by user to a given resource.

static	_forge_criteria_callback ($matches)
	Function to forge a SQL criteria from a Generic filter string.

Detailed Description

Definition at line 41 of file api_products.class.php.

Member Function Documentation

◆ _cleanObjectDatas()

Products::_cleanObjectDatas ( $object )

protected

Clean sensitive object data @phpstan-template T.

Parameters

Object $object Object to clean

Returns: Object Object with cleaned properties

@phpstan-param T $object @phpstan-return T

Reimplemented from DolibarrApi.

Definition at line 2322 of file api_products.class.php.

References $object.

Referenced by getAttributes(), getPurchasePrices(), getSupplierProducts(), and index().

◆ _fetch()

Products::_fetch	(	$id,
		$ref = '',
		$ref_ext = '',
		$barcode = '',
		$includestockdata = 0,
		$includesubproducts = false,
		$includeparentid = false,
		$includeifobjectisused = false,
		$includetrans = false )

private

Get properties of 1 product object.

Return an array with product information.

Parameters

int	$id	ID of product
string	$ref	Ref of element
string	$ref_ext	Ref ext of element
string	$barcode	Barcode of element
int	$includestockdata	Load also information about stock (slower)
bool	$includesubproducts	Load information about subproducts (if product is a virtual product)
bool	$includeparentid	Load also ID of parent product (if product is a variant of a parent product)
bool	$includeifobjectisused	Check if product object is used and set property 'is_object_used' with result.
bool	$includetrans	Load also the translations of product label and description

Returns: array|mixed Data without useless information

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 2422 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

Referenced by get(), getByBarcode(), getByRef(), and getByRefExt().

◆ _validate()

Products::_validate ( $data )

private

Validate fields before create or update object.

Parameters

?array<string,string> $data Data to validate

Returns: array<string,string>

Exceptions

RestException

Definition at line 2388 of file api_products.class.php.

Referenced by post().

◆ addAttributes()

Products::addAttributes	(	$ref,
		$label,
		$ref_ext = '' )

Add attributes.

Since: 11.0.0 Initial implementation

Parameters

string	$ref	Reference of Attribute
string	$label	Label of Attribute
string	$ref_ext	Reference of Attribute

Returns: int

Exceptions

RestException	500 System error
RestException	401

@url POST attributes

Definition at line 1400 of file api_products.class.php.

◆ addAttributeValue()

Products::addAttributeValue	(	$id,
		$ref,
		$value )

Add attribute value.

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Attribute
string	$ref	Reference of Attribute value
string	$value	Value of Attribute value

Returns: int

Exceptions

RestException	500 System error
RestException	401

@url POST attributes/{id}/values

Definition at line 1737 of file api_products.class.php.

References $id.

◆ addPurchasePrice()

Products::addPurchasePrice	(	$id,
		$qty,
		$buyprice,
		$price_base_type,
		$fourn_id,
		$availability,
		$ref_fourn,
		$tva_tx,
		$charges = 0,
		$remise_percent = 0,
		$remise = 0,
		$newnpr = 0,
		$delivery_time_days = 0,
		$supplier_reputation = '',
		$localtaxes_array = array(),
		$newdefaultvatcode = '',
		$multicurrency_buyprice = 0,
		$multicurrency_price_base_type = 'HT',
		$multicurrency_tx = 1,
		$multicurrency_code = '',
		$desc_fourn = '',
		$barcode = '',
		$fk_barcode_type = null )

Add/Update purchase prices for a product.

Since: 12.0.0 Initial implementation

Parameters

int	$id	ID of Product
float	$qty	Min quantity for which price is valid
float	$buyprice	Purchase price for the quantity min
string	$price_base_type	HT or TTC
int	$fourn_id	Supplier ID
int	$availability	Product availability
string	$ref_fourn	Supplier ref
float	$tva_tx	New VAT Rate (For example 8.5. Should not be a string)
float	$charges	costs affering to product
float	$remise_percent	Discount regarding qty (percent)
float	$remise	Discount regarding qty (amount)
int	$newnpr	Set NPR or not
int	$delivery_time_days	Delay in days for delivery (max). May be '' if not defined.
string	$supplier_reputation	Reputation with this product to the defined supplier (empty, FAVORITE, NOTTHGOOD, DONOTORDER)
array	$localtaxes_array	Array with localtaxes info array('0'=>type1,'1'=>rate1,'2'=>type2,'3'=>rate2) (loaded by getLocalTaxesFromRate(vatrate, 0, ...) function). @phan-param array{0:string,1:string,2:string,3:string}\|array{} $localtaxes_array @phpstan-param array{0:string,1:string,2:string,3:string}\|array{} $localtaxes_array
string	$newdefaultvatcode	Default vat code
float	$multicurrency_buyprice	Purchase price for the quantity min in currency
string	$multicurrency_price_base_type	HT or TTC in currency
float	$multicurrency_tx	Rate currency
string	$multicurrency_code	Currency code
string	$desc_fourn	Custom description for product_fourn_price
string	$barcode	Barcode
int	$fk_barcode_type	Barcode type

Returns: int

Exceptions

RestException	500 System error
RestException	404
RestException	403

@url POST {id}/purchase_prices

Definition at line 909 of file api_products.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and sanitizeVal().

◆ addSubproducts()

Products::addSubproducts	(	$id,
		$subproduct_id,
		$qty,
		$incdec = 1 )

Add a subproduct.

Link a product/service to a parent product/service

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of parent product/service
int	$subproduct_id	ID of child product/service
float	$qty	Quantity
int	$incdec	1=Increase/decrease stock of child when parent stock increases/decreases

Returns: int

Exceptions

RestException
RestException	401
RestException	404

@url POST {id}/subproducts/add

Definition at line 647 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ addVariant()

Products::addVariant	(	$id,
		$weight_impact,
		$price_impact,
		$price_impact_is_percent,
		$features,
		$reference = '',
		$ref_ext = '' )

Add variant.

"features" is a list of attributes pairs id_attribute=>id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...)

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Product
float	$weight_impact	Weight impact of variant
float	$price_impact	Price impact of variant
bool	$price_impact_is_percent	Price impact in percent (true or false)
array	$features	List of attributes pairs id_attribute->id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...) @phan-param array<string,string> $features @phpstan-param array<string,string> $features
string	$reference	Customized reference of variant
string	$ref_ext	External reference of variant

Returns: int

Exceptions

RestException	500 System error
RestException	401
RestException	404

@url POST {id}/variants

Definition at line 1946 of file api_products.class.php.

References $id, and price2num().

◆ addVariantByProductRef()

Products::addVariantByProductRef	(	$ref,
		$weight_impact,
		$price_impact,
		$price_impact_is_percent,
		$features )

Add variant by product ref.

"features" is a list of attributes pairs id_attribute=>id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...)

Since: 11.0.0 Initial implementation

Parameters

string	$ref	Ref of Product
float	$weight_impact	Weight impact of variant
float	$price_impact	Price impact of variant
bool	$price_impact_is_percent	Price impact in percent (true or false)
array	$features	List of attributes pairs id_attribute->id_value. Example: array(id_color=>id_Blue, id_size=>id_small, id_option=>id_val_a, ...) @phan-param array<string,string> $features @phpstan-param array<string,string> $features

Returns: int

Exceptions

RestException	500 System error
RestException	401
RestException	404

@url POST ref/{ref}/variants

Definition at line 2013 of file api_products.class.php.

References price2num().

◆ delete()

Products::delete ( $id )

Delete a product.

Since: 4.0.0 Initial implementation

Parameters

int $id Product ID

Returns: array @phan-return array{success:array{code:int,message:string}} @phpstan-return array{success:array{code:int,message:string}}

Exceptions

RestException

Definition at line 558 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ deleteAttributes()

Products::deleteAttributes ( $id )

Delete attributes by ID.

Since: 11.0.0 Initial implementation

Parameters

int $id ID of Attribute

Returns: int Result of deletion

Exceptions

RestException	500 System error
RestException	401

@url DELETE attributes/{id}

Definition at line 1490 of file api_products.class.php.

References $id.

◆ deleteAttributeValueById()

Products::deleteAttributeValueById ( $id )

Delete attribute value by ID.

Since: 11.0.0 Initial implementation

Parameters

int $id ID of Attribute value

Returns: int

Exceptions

RestException	500 System error
RestException	401

@url DELETE attributes/values/{id}

Definition at line 1828 of file api_products.class.php.

References $id.

◆ deleteAttributeValueByRef()

Products::deleteAttributeValueByRef	(		$id,
			$ref )

Delete attribute value by ref.

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Attribute
string	$ref	Ref of Attribute value

Returns: int

Exceptions

RestException 401

@url DELETE attributes/{id}/values/ref/{ref}

Definition at line 1611 of file api_products.class.php.

References $id, and getEntity().

◆ deleteContact()

Products::deleteContact	(	$id,
		$contactid,
		$type )

Unlink a contact type of given product.

Parameters

int	$id	Id of product to update
int	$contactid	Id of contact
string	$type	Type of the contact (BILLING, SHIPPING, CUSTOMER)

@url DELETE {id}/contact/{contactid}/{type}

Returns: array<string,array{code:int,message:string}>

Exceptions

RestException	401
RestException	404
RestException	500 System error

Definition at line 2276 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ deletePurchasePrice()

Products::deletePurchasePrice	(		$id,
			$priceid )

Delete a purchase price for a product.

Since: 11.0.0 Initial implementation

Parameters

int	$id	Product ID
int	$priceid	purchase price ID

@url DELETE {id}/purchase_prices/{priceid}

Returns: int

Exceptions

RestException	401
RestException	404

Definition at line 968 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ deleteVariant()

Products::deleteVariant ( $id )

Delete product variants.

Since: 11.0.0 Initial implementation

Parameters

int $id ID of Variant

Returns: int Result of deletion

Exceptions

RestException	500 System error
RestException	401

@url DELETE variants/{id}

Definition at line 2115 of file api_products.class.php.

References $id.

◆ delSubproducts()

Products::delSubproducts	(		$id,
			$subproduct_id )

Remove a subproduct.

Unlink a product/service from a parent product/service

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of parent product/service
int	$subproduct_id	ID of child product/service

Returns: int

Exceptions

RestException	401
RestException	404

@url DELETE {id}/subproducts/remove/{subproduct_id}

Definition at line 680 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ get()

Products::get	(	$id,
		$includestockdata = 0,
		$includesubproducts = false,
		$includeparentid = false,
		$includetrans = false )

Get a product.

Return an array with product information

Since: 4.0.0 Initial implementation

Parameters

int	$id	ID of product
int	$includestockdata	Load also information about stock (slower)
bool	$includesubproducts	Load information about subproducts
bool	$includeparentid	Load also ID of parent product (if product is a variant of a parent product)
bool	$includetrans	Load also the translations of product label and description

Returns: array|mixed Data without useless information

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 91 of file api_products.class.php.

References $id, and _fetch().

◆ getAttributeById()

Products::getAttributeById ( $id )

Get attribute by ID.

Since: 11.0.0 Initial implementation

Parameters

int $id ID of Attribute

Returns: Object Object with cleaned properties

Exceptions

RestException	401
RestException	404

@url GET attributes/{id}

Definition at line 1245 of file api_products.class.php.

References $id.

◆ getAttributes()

Products::getAttributes	(	$sortfield = "t.ref",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$sqlfilters = '',
		$properties = '' )

Get attributes.

Since: 11.0.0 Initial implementation

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.ref:like:color)"
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Returns: array @phan-return ProductAttribute[] @phpstan-return ProductAttribute[]

Exceptions

RestException	401
RestException	404
RestException	503

@url GET attributes

Definition at line 1181 of file api_products.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), forgeSQLFromUniversalSearchCriteria(), and getEntity().

◆ getAttributesByRef()

Products::getAttributesByRef ( $ref )

Get attributes by ref.

Since: 11.0.0 Initial implementation

Parameters

string $ref Reference of Attribute

Returns: array @phan-return array{id:int,ref:string,ref_ext:string,label:string,rang:int,position:int,entity:string,is_used_by_products:int} @phpstan-return array{id:int,ref:string,ref_ext:string,label:string,rang:int,position:int,entity:string,is_used_by_products:int}

Exceptions

RestException	401
RestException	404

@url GET attributes/ref/{ref}

Definition at line 1292 of file api_products.class.php.

References getEntity().

◆ getAttributesByRefExt()

Products::getAttributesByRefExt ( $ref_ext )

Get attributes by ref_ext.

Since: 11.0.0 Initial implementation

Parameters

string $ref_ext External reference of Attribute

Returns: array @phan-return array{id:int,ref:string,ref_ext:string,label:string,rang:int,position:int,entity:string,is_used_by_products:int} @phpstan-return array{id:int,ref:string,ref_ext:string,label:string,rang:int,position:int,entity:string,is_used_by_products:int}

Exceptions

RestException	500 System error
RestException	401

@url GET attributes/ref_ext/{ref_ext}

Definition at line 1346 of file api_products.class.php.

References getEntity().

◆ getAttributeValueById()

Products::getAttributeValueById ( $id )

Get attribute value by ID.

Since: 11.0.0 Initial implementation

Parameters

int $id ID of Attribute value

Returns: array @phan-return array{id:int,fk_product_attribute:int,ref:string,value:string} @phpstan-return array{id:int,fk_product_attribute:int,ref:string,value:string}

Exceptions

RestException	500 System error
RestException	401

@url GET attributes/values/{id}

Definition at line 1522 of file api_products.class.php.

References $id, and getEntity().

◆ getAttributeValueByRef()

Products::getAttributeValueByRef	(		$id,
			$ref )

Get attribute value by ref.

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Attribute value
string	$ref	Ref of Attribute value

Returns: array @phan-return array{id:int,fk_product_attribute:int,ref:string,value:string} @phpstan-return array{id:int,fk_product_attribute:int,ref:string,value:string}

Exceptions

RestException	500 System error
RestException	401

@url GET attributes/{id}/values/ref/{ref}

Definition at line 1567 of file api_products.class.php.

References $id, and getEntity().

◆ getAttributeValues()

Products::getAttributeValues ( $id )

Get all values for an attribute ID.

Since: 11.0.0 Initial implementation

Parameters

int $id ID of an Attribute

Returns: array @phan-return ProductAttributeValue[] @phpstan-return ProductAttributeValue[]

Exceptions

RestException	401
RestException	500 System error

@url GET attributes/{id}/values

Definition at line 1658 of file api_products.class.php.

References $id.

◆ getAttributeValuesByRef()

Products::getAttributeValuesByRef ( $ref )

Get all values for an attribute ref.

Since: 11.0.0 Initial implementation

Parameters

string $ref Ref of an Attribute

Returns: array @phan-return ProductAttributeValue[] @phpstan-return ProductAttributeValue[]

Exceptions

RestException 401

@url GET attributes/ref/{ref}/values

Definition at line 1693 of file api_products.class.php.

◆ getByBarcode()

Products::getByBarcode	(	$barcode,
		$includestockdata = 0,
		$includesubproducts = false,
		$includeparentid = false,
		$includetrans = false )

Get product by barcode.

Return an array with product information

Since: 11.0.0 Initial implementation

Parameters

string	$barcode	Barcode of element
int	$includestockdata	Load also information about stock (slower)
bool	$includesubproducts	Load information about subproducts
bool	$includeparentid	Load also ID of parent product (if product is a variant of a parent product)
bool	$includetrans	Load also the translations of product label and description

Returns: array|mixed Data without useless information

@url GET barcode/{barcode}

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 169 of file api_products.class.php.

References _fetch().

◆ getByRef()

Products::getByRef	(	$ref,
		$includestockdata = 0,
		$includesubproducts = false,
		$includeparentid = false,
		$includetrans = false )

Get product by ref.

Return an array with product information

Since: 11.0.0 Initial implementation

Parameters

string	$ref	Ref of element
int	$includestockdata	Load also information about stock (slower)
bool	$includesubproducts	Load information about subproducts
bool	$includeparentid	Load also ID of parent product (if product is a variant of a parent product)
bool	$includetrans	Load also the translations of product label and description

Returns: array|mixed Data without useless information

@url GET ref/{ref}

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 117 of file api_products.class.php.

References _fetch().

◆ getByRefExt()

Products::getByRefExt	(	$ref_ext,
		$includestockdata = 0,
		$includesubproducts = false,
		$includeparentid = false,
		$includetrans = false )

Get product by ref_ext.

Return an array with product information

Since: 11.0.0 Initial implementation

Parameters

string	$ref_ext	Ref_ext of element
int	$includestockdata	Load also information about stock (slower)
bool	$includesubproducts	Load information about subproducts
bool	$includeparentid	Load also ID of parent product (if product is a variant of a parent product)
bool	$includetrans	Load also the translations of product label and description

Returns: array|mixed Data without useless information

@url GET ref_ext/{ref_ext}

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 143 of file api_products.class.php.

References _fetch().

◆ getCategories()

Products::getCategories	(	$id,
		$sortfield = "s.rowid",
		$sortorder = 'ASC',
		$limit = 0,
		$page = 0 )

Get categories for a product.

Since: 5.0.0 Initial implementation

Parameters

int	$id	ID of product
string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number

Returns: mixed

@url GET {id}/categories

Exceptions

RestException

Definition at line 715 of file api_products.class.php.

References $id.

◆ getContacts()

Products::getContacts	(		$id,
			$type = '' )

Get contacts of a given product.

Return an array with contact information

Parameters

int	$id	ID of product
string	$type	Type of the contact ('BILLING', 'SHIPPING', 'CUSTOMER', ...)

Returns: array|mixed Array of contacts

@url GET {id}/contacts

Exceptions

RestException

Definition at line 2189 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ getCustomerPricesPerCustomer()

Products::getCustomerPricesPerCustomer	(		$id,
			$thirdparty_id = '' )

Get prices per customer for a product.

Since: 7.0.0 Initial implementation

Parameters

int	$id	ID of product
string	$thirdparty_id	Thirdparty id to filter orders of (example '1') {@pattern /^[0-9,]*$/i}

Returns: mixed

@url GET {id}/selling_multiprices/per_customer

Exceptions

RestException

Definition at line 791 of file api_products.class.php.

References $id, and getDolGlobalString().

◆ getCustomerPricesPerQuantity()

Products::getCustomerPricesPerQuantity ( $id )

Get prices per quantity for a product.

Since: 7.0.0 Initial implementation

Parameters

int $id ID of product

Returns: mixed

@url GET {id}/selling_multiprices/per_quantity

Exceptions

RestException

Definition at line 844 of file api_products.class.php.

References $id, and getDolGlobalString().

◆ getCustomerPricesPerSegment()

Products::getCustomerPricesPerSegment ( $id )

Get prices per segment for a product.

Since: 7.0.0 Initial implementation

Parameters

int $id ID of product

Returns: mixed

@url GET {id}/selling_multiprices/per_segment

Exceptions

RestException

Definition at line 745 of file api_products.class.php.

References $id, and getDolGlobalString().

◆ getPurchasePrices()

Products::getPurchasePrices	(	$id,
		$ref = '',
		$ref_ext = '',
		$barcode = '' )

Get purchase prices for a product.

Return an array with product information. TODO implement getting a product by ref or by $ref_ext

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of product
string	$ref	Ref of element
string	$ref_ext	Ref ext of element
string	$barcode	Barcode of element

Returns: array Data without useless information @phan-return ProductFournisseur[] @phpstan-return ProductFournisseur[]

@url GET {id}/purchase_prices

Exceptions

RestException	401
RestException	403
RestException	404

Definition at line 1123 of file api_products.class.php.

References $id, DolibarrApi\_checkAccessToResource(), and _cleanObjectDatas().

◆ getStock()

Products::getStock	(		$id,
			$selected_warehouse_id = null )

Get stock data for a product.

Optionally with $selected_warehouse_id parameter user can get stock of a specific warehouse

Since: 14.0.0 Initial implementation

Parameters

int	$id	ID of Product
int	$selected_warehouse_id	ID of warehouse

Returns: array|mixed Data without useless information

Exceptions

RestException	500 System error
RestException	403
RestException	404

@url GET {id}/stock

Definition at line 2147 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ getSubproducts()

Products::getSubproducts ( $id )

Get the list of subproducts of a product.

Since: 11.0.0 Initial implementation

Parameters

int $id ID of parent product/service

Returns: array @phan-return array<array{rowid:int,qty:float,fkproduct_type:int,label:string,incdec:int,ref:string,fk_association:int,rang:int}> @phpstan-return array<array{rowid:int,qty:float,fkproduct_type:int,label:string,incdec:int,ref:string,fk_association:int,rang:int}>

Exceptions

RestException
RestException	401
RestException	404

@url GET {id}/subproducts

Definition at line 607 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ getSupplierProducts()

Products::getSupplierProducts	(	$sortfield = "t.ref",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$mode = 0,
		$category = 0,
		$supplier = 0,
		$sqlfilters = '' )

Get a list of all purchase prices of products.

Since: 11.0.0 Initial implementation

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
int	$mode	Use this param to filter list (0 for all, 1 for only product, 2 for only service)
int	$category	Use this param to filter list by category of product
int	$supplier	Use this param to filter list by supplier
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.tobuy:=:0) and (t.tosell:=:1)"

Returns: array Array of product objects @phan-return array<ProductFournisseur[]|int> @phpstan-return array<ProductFournisseur[]|int>

@url GET purchase_prices

Exceptions

RestException

Definition at line 1011 of file api_products.class.php.

References _cleanObjectDatas(), forgeSQLFromUniversalSearchCriteria(), and getEntity().

◆ getVariants()

Products::getVariants	(		$id,
			$includestock = 0 )

Get product variants.

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Product
int	$includestock	Default value 0. If parameter is set to 1 the response will contain stock data of each variant

Returns: array @phan-return ProductCombination[] @phpstan-return ProductCombination[]

Exceptions

RestException	500 System error
RestException	401

@url GET {id}/variants

Definition at line 1859 of file api_products.class.php.

References $id.

◆ getVariantsByProdRef()

Products::getVariantsByProdRef ( $ref )

Get product variants by Product ref.

Since: 11.0.0 Initial implementation

Parameters

string $ref Ref of Product

Returns: array @phan-return ProductCombination[] @phpstan-return ProductCombination[]

Exceptions

RestException	500 System error
RestException	401

@url GET ref/{ref}/variants

Definition at line 1899 of file api_products.class.php.

◆ index()

Products::index	(	$sortfield = "t.ref",
		$sortorder = 'ASC',
		$limit = 100,
		$page = 0,
		$mode = 0,
		$category = 0,
		$sqlfilters = '',
		$ids_only = false,
		$variant_filter = 0,
		$pagination_data = false,
		$includestockdata = 0,
		$properties = '' )

List products.

Get a list of products

Since: 4.0.0 Initial implementation

Parameters

string	$sortfield	Sort field
string	$sortorder	Sort order
int	$limit	Limit for list
int	$page	Page number
int	$mode	Use this param to filter list (0 for all, 1 for only product, 2 for only service)
int	$category	Use this param to filter list by category
string	$sqlfilters	Other criteria to filter answers separated by a comma. Syntax example "(t.tobuy:=:0) and (t.tosell:=:1)"
bool	$ids_only	Return only IDs of product instead of all properties (faster, above all if list is long)
int	$variant_filter	Use this param to filter list (0 = all, 1=products without variants, 2=parent of variants, 3=variants only)
bool	$pagination_data	If this parameter is set to true the response will include pagination data. Default value is false. Page starts from 0
int	$includestockdata	Load also information about stock (slower)
string	$properties	Restrict the data returned to these properties. Ignored if empty. Comma separated list of properties names

Returns: array Array of product objects @phan-return Product[]|array{data:Product[],pagination:array{total:int,page:int,page_count:int,limit:int}} @phpstan-return Product[]|array{data:Product[],pagination:array{total:int,page:int,page_count:int,limit:int}}

Exceptions

RestException

Definition at line 199 of file api_products.class.php.

References _cleanObjectDatas(), DolibarrApi\_filterObjectProperties(), forgeSQLFromUniversalSearchCriteria(), and getEntity().

◆ post()

Products::post ( $request_data = null )

Create a product.

Since: 4.0.0 Initial implementation

Parameters

array $request_data Request data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: int ID of product

Exceptions

RestException

Definition at line 331 of file api_products.class.php.

References DolibarrApi\_checkValForAPI(), _validate(), getDolGlobalString(), and sanitizeVal().

◆ postContact()

Products::postContact	(	$id,
		$contactid,
		$type,
		$source = "external",
		$notrigger = 0 )

Add a contact type of given product.

Parameters

int	$id	Id of product to update
int	$contactid	Id of contact to add
string	$type	Type of the contact (BILLING, SHIPPING, CUSTOMER)
string	$source	external=Contact extern (llx_socpeople), internal=Contact intern (llx_user)
int	$notrigger	Disable all triggers

Returns: array<string,array{code:int,message:string}>

@url POST {id}/contact/{contactid}/{type}

Exceptions

RestException	401
RestException	404

Definition at line 2228 of file api_products.class.php.

References $id, and DolibarrApi\_checkAccessToResource().

◆ put()

Products::put	(		$id,
			$request_data = null )

Update a product.

Price will be updated by this API only if option is set on "One price per product" or if PRODUIT_MULTIPRICES is set (1 price per segment) See other APIs for other price modes.

Since: 4.0.0 Initial implementation

Parameters

int	$id	Id of product to update
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Updated object

Exceptions

RestException	401
RestException	404

Definition at line 395 of file api_products.class.php.

References $id, DolibarrApi\_checkAccessToResource(), DolibarrApi\_checkValForAPI(), dol_clone(), getDolGlobalString(), and sanitizeVal().

◆ putAttributes()

Products::putAttributes	(		$id,
			$request_data = null )

Update attributes by ID.

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Attribute
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Object with cleaned properties

Exceptions

RestException
RestException	401
RestException	404

@url PUT attributes/{id}

Definition at line 1436 of file api_products.class.php.

References $id, and sanitizeVal().

◆ putAttributeValue()

Products::putAttributeValue	(		$id,
			$request_data )

Update attribute value.

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Attribute
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: Object Object with cleaned properties

Exceptions

RestException	401
RestException	500 System error

@url PUT attributes/values/{id}

Definition at line 1774 of file api_products.class.php.

References $id, and sanitizeVal().

◆ putVariant()

Products::putVariant	(		$id,
			$request_data = null )

Update product variants.

Since: 11.0.0 Initial implementation

Parameters

int	$id	ID of Variant
array	$request_data	Data @phan-param ?array<string,string> $request_data @phpstan-param ?array<string,string> $request_data

Returns: int

Exceptions

RestException	500 System error
RestException	401

@url PUT variants/{id}

Definition at line 2073 of file api_products.class.php.

References $id, and sanitizeVal().

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

dolibarr_23.0/htdocs/product/class/api_products.class.php

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _cleanObjectDatas()

◆ _fetch()

◆ _validate()

◆ addAttributes()

◆ addAttributeValue()

◆ addPurchasePrice()

◆ addSubproducts()

◆ addVariant()

◆ addVariantByProductRef()

◆ delete()

◆ deleteAttributes()

◆ deleteAttributeValueById()

◆ deleteAttributeValueByRef()

◆ deleteContact()

◆ deletePurchasePrice()

◆ deleteVariant()

◆ delSubproducts()

◆ get()

◆ getAttributeById()

◆ getAttributes()

◆ getAttributesByRef()

◆ getAttributesByRefExt()

◆ getAttributeValueById()

◆ getAttributeValueByRef()

◆ getAttributeValues()

◆ getAttributeValuesByRef()

◆ getByBarcode()

◆ getByRef()

◆ getByRefExt()

◆ getCategories()

◆ getContacts()

◆ getCustomerPricesPerCustomer()

◆ getCustomerPricesPerQuantity()

◆ getCustomerPricesPerSegment()

◆ getPurchasePrices()

◆ getStock()

◆ getSubproducts()

◆ getSupplierProducts()

◆ getVariants()

◆ getVariantsByProdRef()

◆ index()

◆ post()

◆ postContact()

◆ put()

◆ putAttributes()

◆ putAttributeValue()

◆ putVariant()