catalog.product.offer.getFieldsByFilter

Scope: catalog Permissions: all

Description, parameters, example

catalog.product.offer.getFieldsByFilter(filter)

Method returns SKU fields by filter.

Parameters

Parameter	Type	Description
[ICO_NEW]parentId[/ICO_NEW]	integer	product ID.
filter	object	The following required fields are passed: iblockId - iblock ID; productType - product type; iblockSectionId - section ID; name - name.

Examples

BX24.callMethod(
    'catalog.product.offer.getFieldsByFilter', 
	{
        filter: {
			  iblockId: 16,
			  productType: 3
        }
    },
    function(result) {
        if (result.error())
            console.error(result.error().ex);
        else
            console.log(result.data());
    });

Returned fields

Field	Description	Type	Note
active	Active	char
available	Availability	char	Read only
bundle	Bundle	char
canBuyZero	Option: Make out-of-stock items available for purchase	char
code	Symbolic code	string
createdBy	Created by (id)	integer
dateActiveFrom	Active from	datetime
dateActiveTo	Active till	datetime
dateCreate	Date created	datetime
detailPicture	Detailed image	file
detailText	Detailed description	string
detailTextType	Detailed description type	string
height	Height	double
iblockId	Information block ID	integer	Required field.
iblockSectionId	Iblock section ID	integer	Required field.
id	Product ID	integer	Read only.
length	Length	double
measure	Unit of measurement	integer
modifiedBy	Modified by	integer
name	Name	string	Required field.
negativeAmountTrace	Enable negative product quantity	char	Read only.
previewPicture	Preview image	file
previewText	Preview description	string
previewTextType	Short description type	string
priceType	Price type	char
propertyN	Product property	array	Depends on property type. Array includes value (property description depending on the type) and valueId (property ID).
purchasingCurrency	Currency	string
purchasingPrice	Price	string
quantity	Available quantity	double
quantityReserved	Reserved quantity	double
quantityTrace	Enable stock control	char
sort	Sorting	integer
subscribe	Product subscription	char
timestampX	Modified on	datetime
vatId	VAT ID	integer
vatIncluded	Tax included	char
weight	Weight	double
width	Width	double
xmlId	External code	string