ProductTable

ProductTable class for handling table with catalog products.

Class methods

Method	Description	Available from version
calculateAvailable	Returns flag Y/N set for product purchase availability for passed product array.
clearProductCache	Resets internal cache on a hit.
getCurrentRatioWithMeasure	Returns code or rate for product units of measurement.
getDefaultAvailableSettings	Returns settings available by default.
getMap	Returns list of fields for catalog product table.
getPaymentPeriods	Returns list of payment periods.
getPaymentTypes	Returns list payment types.
getProductTypes	Returns list product types.
getTableName	Returns name for table with catalog products.
isExistProduct	Checks available data on product with `$product` ID.
loadDefaultProductSettings	Gets default product parameters from module settings.
prepareCanBuyZero	Gets the field value `CAN_BUY_ZERO` and if it equals `D`, returns `CAN_BUY_ZERO` field module's setting instead.
prepareQuantityTrace	Gets field value `QUANTITY_TRACE` and if it equals `D`, returns the `QUANTITY_TRACE` field's module setting instead of current value.
prepareSubscribe	Gets the field value `SUBSCRIBE` and if it equals `D`, returns the `SUBSCRIBE` field's module setting instead of current value.
validatePriceType	Returns validator for the field `PRICE_TYPE`.
validatePurchasingCurrency	Returns validator for the field `PURCHASING_CURRENCY`.
validateRecurSchemeType	Returns validator for the field `RECUR_SCHEME_TYPE`.
validateTmpId	Returns validator for the field `TMP_ID`.

Catalog product fields

Field	Description	Type	Required
ID	Product code (ID).	Int	Yes
QUANTITY	Number of warehouse products. Jointly with the field QUANTITY_TRACE allows co count the number of items for allow/deny purchase.	Double	Yes
QUANTITY_TRACE	Flag "Enable stock control" (Y/N/D) .	Char(1)	Yes
WEIGHT	Single item weight.	Double	Yes
TIMESTAMP_X	Date and time for entry update.	Datetime	Yes
PRICE_TYPE	Price type. Used for managing subscriptions. Value options: S - single payment, R - recurring payments, T - trial subscription	Char(1)	Yes
RECUR_SCHEME_LENGTH	Subscription period	Int	No
RECUR_SCHEME_TYPE	Subscription period type. Value options: "H" - hour, "D" - day, "W" - week, "M" - month, "Q" - quarter, "S" - semester, "Y" - year	Char(1)	Yes
TRIAL_PRICE_ID	Trial product code (ID).	Int	No
WITHOUT_ORDER	Flag "Renewal without ordering" (Y/N).	Char(1)	Yes
VAT_ID	Product-assigned VAT rate.	Int	No
VAT_INCLUDED	"VAT included" (Y/N).	Char(1)	No
CAN_BUY_ZERO	"Make out-of-stock items available for purchase" (Y/N/D).	Char(1)	Yes
TMP_ID	Temporary string identifier, used for service purposes.	Varchar(40)	No
PURCHASING_PRICE	Purchase price.	Decimal(18,2)	No
PURCHASING_CURRENCY	Purchase price currency.	Char(3)	No
BARCODE_MULTI	Flag defines if each product item has its own barcode (Y/N).	Char(1)	Yes
QUANTITY_RESERVED	Reserved quantity.	Double	No
SUBSCRIBE	Flag "Allow subscription for out-of-stock products" (Y/N/D).	Char(1)	No
WIDTH	Product width (in mm).	Double	No
LENGTH	Product length (in mm).	Double	No
HEIGHT	Product height (in mm).	Double	No
MEASURE	Unit of measurement ID.	Int	No
TYPE	Product type.	Int	No
AVAILABLE	Product availability flag (Y/N).	Char(1)	No
BUNDLE	Product bundle flag (Y/N).	Char(1)	No

Product types

Main	Description	Available from version
\Bitrix\Catalog\ProductTable::TYPE_PRODUCT	Standard product
\Bitrix\Catalog\ProductTable::TYPE_SET	Set
\Bitrix\Catalog\ProductTable::TYPE_SKU	Product with SKUs
\Bitrix\Catalog\ProductTable::TYPE_OFFER	SKU

Additional	Description	Available from version
\Bitrix\Catalog\ProductTable::TYPE_FREE_OFFER	SKU without product (not specified or deleted).
\Bitrix\Catalog\ProductTable::TYPE_EMPTY_SKU	Specific type. Indicates invalid product with SKUs.

Added into shopping cart	Description	Available from version
\Bitrix\Catalog\ProductTable::TYPE_PRODUCT	Standard product
\Bitrix\Catalog\ProductTable::TYPE_SET	Set
\Bitrix\Catalog\ProductTable::TYPE_OFFER	SKU	/td>