Documentation

crm.item.productrow.get

crm.item.productrow.get({id: number})

Passes information about product SKUs with ID.

Parameters

Parameter Description Available from version
id Product SKU ID

Response:

{
	"productRow": {
		"id": 1263,
		"ownerId": 707,
		"ownerType": "Q",
		"productId": 2,
		"productName": "Product SKU name",
		"price": 611,
		"priceAccount": 611,
		"priceExclusive": 611,
		"priceNetto": 678.89,
		"priceBrutto": 678.89,
		"quantity": 1,
		"discountTypeId": 2,
		"discountRate": 10,
		"discountSum": 67.89,
		"taxRate": 0,
		"taxIncluded": "N",
		"customized": "Y",
		"measureCode": 796,
		"measureName": "pcs",
		"sort": 0
	}
}

Response values:

  • ownerId - CRM item ID to which product SKU is bound (for example, quote ID)
  • ownerType - symbolic code for CRM entity with bound product SKU. You can find out which specific code corresponds to an entity type using the class methods \CCrmOwnerTypeAbbr.
  • productId - product SKU ID from catalog.
  • productName - product SKU name. By default, matches with product SKU from catalog, but may be updated.
  • price - price per product SKU, including discounts and taxes.
  • priceAccount - price per product SKU, including discounts and taxes, converted into report currency.
  • priceExclusive - price per product SKU, including discounts, but excluding taxes.
  • priceNetto - price per product SKU, excluding discounts and taxes.
  • priceBrutto - price per product SKU, including taxes, excluding discounts.
  • quantity - number of product SKU items.
  • discountTypeId - discount type. Can be 1 for a discount in absolute value and 2 for discount in percentage. Equal to 2 by default.
  • discountRate - discount percentage per product SKU.
  • discountSum - discount absolute value per product SKU.
  • taxRate - tax percentage per product SKU.
  • measureCode - measurement unit code for product SKU. Can be configured in the section Units of measurement inside CRM settings.
  • measureName - reference designation for product SKU unit of measurement. Can be configured in the section Units of measurement inside CRM settings.

  • Note: Starting from CRM module version 21.1800.0 you can change units of measurements for SKUs via REST methods of crm.item.productrow.* family, by passing only measureCode. Completes the measureName automatically.


  • sort - sorting factor.
© «Bitrix24», 2001-2022
Up