Product Items

Description

The REST methods from the crm.item.productrow.* family allow you to work with product items linked to various CRM entities. These methods are universal and support any type of owner, except for old invoices:

  • leads
  • deals
  • contacts
  • companies
  • estimates
  • new invoices
  • SPAs

Access Permissions

When calling REST methods, the access permissions of the user making the call are taken into account. Product items are not a standalone CRM entity and are always linked to some CRM object that acts as their owner. Therefore, during all operations, the user's permissions to access and manage the owner object (estimate, SPA, etc.) are checked. For example, if a user does not have read access to a particular entity, they will not be able to read its product items.

Automatic Actions After Any Change

After any changes made to product items, all standard checks and procedures that occur when modifying a CRM object will be executed, including recalculating the total amount and triggering Automation rules after saving. This applies to all methods that create or modify product items: crm.item.productrow.add, crm.item.productrow.update, crm.item.productrow.set.

Overview of Methods

Scope: crm

Who can perform the methods: depending on the method

Method

Description

crm.item.productrow.add

Adds a product item

crm.item.productrow.update

Updates a product item

crm.item.productrow.get

Retrieves information about a product item by id

crm.item.productrow.set

Links a product item to a CRM object

crm.item.productrow.list

Retrieves a list of product items

crm.item.productrow.getAvailableForPayment

Retrieves a list of unpaid products

crm.item.productrow.delete

Deletes a product item

crm.item.productrow.fields

Retrieves a list of product item fields