Documentation

Catalog entity fields

Iblocks, binded to Catalog module

Field Description Type Required Default Comments
IBLOCK_ID Iblock code (ID) Int yes - unique field, attempt to add more than one record with identical IBLOCK_ID will database error.
YANDEX_EXPORT Flag (Y/N) for export to Yandex.Products using agent Char(1) no N
SUBSCRIPTION Flag (Y/N) for content sales Char(1) no N
VAT_ID VAT code (ID) Int no 0
PRODUCT_IBLOCK_ID For SKU iblock contain product iblock code (ID) Int no 0 Can be set only with SKU_PROPERTY_ID
SKU_PROPERTY_ID For SKU iblock contains ID property for binding SKU to products Int no 0 Property must satisfy the following requirements: single, type - Binding to products (SKU), bound to PRODUCT_IBLOCK_ID. Can be specified only jointly with PRODUCT_IBLOCK_ID.


Product parameters

Field Description Type Required Default Comments
ID Product code (ID). int yes - Matches iblock element ID from commercial catalog. Deleting iblock entry also deletes product parameters entry.
QUANTITY Product quantity at warehouse double yes - Fields stores product quantity at warehouse. Together with QUANTITY_TRACE field allows maintaining quantity account of for permitting/denying purchase.
QUANTITY_TRACE Flag "Reduce quantity upon order" (Y/N) char(1) yes N If the field contains Y, the field QUANTITY is reduced equal to product quantity in the order during checkout.
AVAILABLE [link=12049898]Product availability for purchase[/link] char(1) no N Updated automatically.
TYPE Product type char(1) no - Default values depend on catalog type.
QUANTITY_RESERVED Reserved quantity double no 0 Default values depend on catalog type.
BUNDLE Available bundle attribute char(1) no - Updated automatically.
WEIGHT Product item weight double yes 0
TIMESTAMP_X Date and time for record/entry datetime yes current
PRICE_TYPE Price type char(1) yes S Use for organizing subscriptions. Values variants:
  • S - single payment,
  • R - recurring payments,
  • T - trial subscription
RECUR_SCHEME_TYPE Subscription period type char(1) yes M Value variants:
  • "H" - hour,
  • "D" - day,
  • "W" - week,
  • "M" - month,
  • "Q" - quarter,
  • "S" - semester,
  • "Y" - year
RECUR_SCHEME_LENGTH Subscription period length int no - Subscription period duration. Unit of duration is specified in RECUR_SCHEME_TYPE
TRIAL_PRICE_ID Product code (ID), with trial price int no - Used for trial products
WITHOUT_ORDER Flag "Renewal without ordering" (Y/N) char(1) yes N Used for subscription
VAT_ID VAT ID, associated with product int no 0
VAT_INCLUDED Flag "VAT included" (Y/N) char(1) no Y


Price type

Field Description Type Required Default Comments
ID Price type (ID) int yes -
NAME Internal (language independent) price type name char(100) yes - Name, independent from site language (control panel)
BASE Flag "base price type" (Y/N) char(1) yes N Only a single price type can have "Y" value. Base type is required for surcharge feature use.
SORT Sort index in the price type list int yes 100


Price type language parameters

Field Description Type Required Default Comments
ID Table entry code (ID) int yes -
CATALOG_GROUP_ID Price type code (ID) int yes
LID Language code char(3) yes
NAME Langauge-dependent name char(100) no


Access to price types

Field Description Type Required Default Comments
ID Entry (ID) inside table int yes
CATALOG_GROUP_ID Price type code (ID) int yes
GROUP_ID Site user group code (ID) int yes Group of users with permission to purchase or view prices of specified type. Level of permissions (view/purchase) is defined by the field BUY.
BUY Flag "purchase/view" (Y/N) char(1) yes Y


Prices

Field Description Type Required Default Comments
ID Price (ID) int yes
PRODUCT_ID Product or SKU ID (iblock element ID) int yes
EXTRA_ID Surcharge type (ID) int no
CATALOG_GROUP_ID Price type (ID) int yes
PRICE Price amount decimal(18,2) yes
CURRENCY Price currency code char(3) yes
TIMESTAMP_X Entry update time datetime yes current
QUANTITY_FROM Minimal amount of product with applied price int no
QUANTITY_TO Maximum amount of product with applied price int no


Surcharges

Field Description Type Required Default Comments
ID Surcharge (ID) int yes
NAME Surcharge name char(50) yes
PERCENTAGE Amount of surcharge in percentage decimal(18,2) yes


Discounts (deprecated)

Field Description Type Required Default Comments
ID Discount (ID) int yes
SITE_ID Site with associated discount char(2) yes
ACTIVE Discount active status (Y/N) char(1) yes Y
ACTIVE_FROM Date with discount start date datetime no
ACTIVE_TO Date with discount end date datetime no
RENEWAL Flag "Renewal dscount" (Y/N) char(1) yes N
NAME Discount name char(255) yes
COUPON char(20) yes
SORT int yes 100
VALUE_TYPE char(1) yes P Values:
  • P - in percentage,
  • F - fixed amount
  • S - fixed price
VALUE decimal(18,4) yes 0
CURRENCY char(3) yes
TIMESTAMP_X datetime yes current
NOTES char(255) no


Discount coupons

Field Description Type Required Default Comments
ID Coupon (ID) Int yes - unique field, attempt to add more than single entry with the same ID results in database error
DISCOUNT_ID Discount (ID) Int yes -
ACTIVE Flag (Y/N) for active discount Char(1) yes Y If discount is active, it can be used when purchasing the product. Single use coupon becomes inactive after use
COUPON Generated sequence of symbols comprising a coupon Char(32) yes
DATE_APPLY Date and time, when coupon was used DateTime no Automatically is set after applying a single use coupon
ONE_TIME Flag (Y/N) for single use coupon Char(1) yes Y Single use coupon can used only once
DESCRIPTION Text comment Text no


© «Bitrix24», 2001-2024
Up