Data Types and Object Structure in the REST API Catalog

Type

Descriptions and Values

catalog_catalog.id

Integer identifier of the trade catalog (e.g., 1). You can obtain the identifiers of trade catalogs using the catalog.catalog.list method

catalog_document.id

Integer identifier of the inventory document, for example 1. You can obtain the identifiers of documents using the catalog.document.list method

catalog_document_element.id

Integer identifier of the product in the inventory document, for example 1. You can obtain the identifiers of products in documents using the catalog.document.element.list method

catalog_documentcontractor.id

Integer identifier of the supplier binding to the inventory document, for example 1. You can obtain the identifiers of bindings using the catalog.documentcontractor.list method

catalog_product.id

Integer identifier of the product (e.g., 1). You can obtain the identifiers of products using the catalog.product.list method

catalog_product_property.id

Integer identifier of the product property or variation (e.g., 1). You can obtain the identifiers of properties using the catalog.productProperty.list method

catalog_product_sku.id

Integer identifier of the parent product (e.g., 1). You can obtain the identifiers of parent products using the catalog.product.sku.list method

catalog_product_offer.id

Integer identifier of the product variation (e.g., 1). You can obtain the identifiers of product variations using the catalog.product.offer.list method

catalog_product_service.id

Integer identifier of the service (e.g., 1). You can obtain the identifiers of services using the catalog.product.service.list method

catalog_product_image.id

Integer identifier of the product image (e.g., 1). You can obtain the identifiers of product images using the catalog.productImage.list method

catalog_store.id

Integer identifier of the warehouse (e.g., 1). You can obtain the identifiers of warehouses using the catalog.store.list method

catalog_measure.id

Integer identifier of the unit of measurement (e.g., 1). You can obtain the identifiers of units of measurement using the catalog.measure.list method

catalog_ratio.id

Integer identifier of the unit of measurement ratio (e.g., 1). You can obtain the identifiers of unit ratios using the catalog.ratio.list method

catalog_price.id

Integer identifier of the price, for example 1. You can obtain the identifiers of prices using the catalog.price.list method

catalog_price_type.id

Integer identifier of the price type (e.g., 1). You can obtain the identifiers of price types using the catalog.priceType.list method

catalog_price_type_lang.id

Integer identifier of the translation of price type names (e.g., 1). You can obtain the identifiers of translations using the catalog.priceTypeLang.list method

catalog_language.lid

String identifier of the language, consisting of two characters (e.g., de). You can obtain the identifiers of languages using the catalog.priceTypeLang.getLanguages method

catalog_rounding_rule.id

Integer identifier of the price rounding rule (e.g., 1). You can obtain the identifiers of price rounding rules using the catalog.roundingRule.list method

catalog_extra.id

Integer identifier of the markup (e.g., 1). You can obtain the identifiers of markups using the catalog.extra.list method

catalog_section.id

Integer identifier of the catalog section (e.g., 1). You can obtain the identifiers of catalog sections using the catalog.section.list method

catalog_storeproduct.id

Integer identifier of the record of product stock in the warehouse, for example 1. You can obtain the identifiers using the catalog.storeproduct.list method

catalog_vat.id

Integer identifier of the VAT rate (e.g., 1). You can obtain the identifiers of VAT rates using the catalog.vat.list method

Value
type

Description

id
integer

Identifier of the trade catalog

iblockId
integer

Identifier of the information block of the trade catalog

iblockTypeId
string

Type of the information block of the trade catalog. For CRM trade catalogs, it has a constant value of CRM_PRODUCT_CATALOG

lid
string

Site identifier. Has a constant value of s1

name
string

Name of the trade catalog

productIblockId
integer

Identifier of the parent information block of the trade catalog. Filled only for trade catalogs of variations.

To obtain existing identifiers of information blocks, you need to use catalog.catalog.list

skuPropertyId
integer

Identifier of the property that stores the identifier of the parent product. Filled only for trade catalogs of variations.

To obtain existing identifiers of properties, you need to use catalog.productProperty.list

subscription
string

Is content sold? Possible values:

• Y — yes
• N — no

This parameter is used only in the on-premise version

vatId
catalog_vat.id

Identifier of VAT.

To obtain existing identifiers of VAT, you need to use catalog.vat.list

Name
type

Description

id
integer

Identifier of the inventory document

docType
string

Type of document. Available types can be obtained using the catalog.enum.getStoreDocumentTypes method

docNumber
string

Internal document number. If not provided, it is generated automatically

title
string

Title of the document

siteId
string

Site code to which the document relates. Default is s1

responsibleId
integer

Identifier of the responsible person

createdBy
integer

Identifier of the user who created the document

modifiedBy
integer

Identifier of the user who modified the document

status
string

Document status:

• N — draft,
• Y — approved,
• C — canceled.

The value is automatically changed when the document is approved or canceled

statusBy
integer

User who changed the document status

dateStatus
datetime

Date of status change

dateCreate
datetime

Date of document creation

dateModify
datetime

Date of last modification of the document

dateDocument
datetime

Date of document approval

currency
string

Currency of the document

total
double

Total amount for the products in the document. The value is calculated automatically after approval but can be set manually

commentary
string

Commentary for the document

Name
type

Description

documentId
catalog_document.id

Identifier of the inventory document

documentType
string

Type of inventory document

fieldN
mixed

Value of the custom field of the document, where N — identifier of the custom field, for example field7097

Value
type

Description

id
integer

Identifier of the product in the inventory document

docId
catalog_document.id

Identifier of the inventory document

elementId
catalog_product.id

Identifier of the catalog product

storeFrom
catalog_store.id

Identifier of the source warehouse. Used for documents where write-off is required

storeTo
catalog_store.id

Identifier of the recipient warehouse. Used for incoming and transfer documents

amount
double

Quantity of the product

purchasingPrice
double

Purchasing price

Value
type

Description

id
integer

Identifier of the supplier binding to the inventory document

documentId
catalog_document.id

Identifier of the inventory document to which the supplier is bound

entityTypeId
integer

Identifier of the CRM object type:
3 — contact
4 — company

entityId
integer

Identifier of the supplier: contact or company

Value
type

Description

id
integer

Identifier of the product

iblockId
catalog_catalog.id

Identifier of the information block of the trade catalog.

To obtain existing identifiers of information blocks, you need to use catalog.catalog.list

name
string

Name of the product

active
string

Activity indicator. Possible values:

• Y — yes
• N — no

available
string

Availability for purchase. Read-only. Possible values:

• Y — yes
• N — no

code
string

Symbolic code

xmlId
string

External code

barcodeMulti
string

Unique barcodes for each instance. Possible values:

• Y — yes
• N — no

bundle
string

Availability of a set. Possible values:

• Y — yes
• N — no

canBuyZero
string

Is purchase of the product allowed when it is out of stock? Possible values:

• Y — yes
• N — no

createdBy
user.id

Created by

modifiedBy
user.id

Modified by

dateActiveFrom
datetime

Date of activity start

dateActiveTo
datetime

Date of activity end

dateCreate
datetime

Date of creation

timestampX
datetime

Date of modification. Read-only

iblockSectionId
catalog_section.id

Identifier of the information block section

measure
catalog_measure.id

Unit of measurement

previewText
string

Description for the announcement

detailText
string

Detailed description

previewPicture
object

Picture for the announcement. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

detailPicture
object

Detailed picture. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

previewTextType
string

Type of description for the announcement. Possible values:

• text — text
• html — HTML

detailTextType
string

Type of detailed description. Possible values:

• text — text
• html — HTML

sort
integer

Sorting

subscribe
string

Permission to subscribe to the product. Possible values:

• Y — yes
• N — no
• D — default

vatId
catalog_vat.id

Identifier of VAT

vatIncluded
string

Is VAT included in the price? Possible values:

• Y — yes
• N — no

height
float

Height of the product

length
float

Length of the product

weight
float

Weight of the product

width
float

Width of the product

quantityTrace
string

Quantity accounting mode. Possible values:

• Y — enabled
• N — disabled
• D — default

type
integer

Type of product. Read-only. Possible values:

• 1 — simple product

purchasingCurrency
string

Currency of the purchasing price.

The list of currencies can be obtained using the crm.currency.list method.

Not editable when inventory accounting is enabled

purchasingPrice
float

Purchasing price.

Not editable when inventory accounting is enabled

quantity
float

Quantity.

Not editable when inventory accounting is enabled

quantityReserved
float

Reserved quantity.

Not editable when inventory accounting is enabled

recurSchemeLength
integer

Length of the payment period.

Used only in the on-premise version for content sales

recurSchemeType
string

Unit of time for the payment period. Possible values:

• H — hour
• D — day
• W — week
• M — month
• Q — quarter
• S — half-year
• Y — year

Used only in the on-premise version for content sales

trialPriceId
integer

Product for trial payment.

Used only in the on-premise version for content sales

withoutOrder
string

Renewal without placing an order. Possible values:

• Y — yes
• N — no

Used only in the on-premise version for content sales

propertyN
object\|array

Value of the property of the main product, where N — identifier of the property. There can be multiple properties.

The value is specified in the format {valueId: valueId, value: value} or in the format [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], if the property is multiple. Here valueId — identifier of the property value, and value — value of the property.

If valueId is not specified, the existing value will be removed from the database and replaced with the new one specified in value. If the property is multiple, all existing values of the property for which valueId was not specified will be removed.

valueId of all properties of the product can be obtained using the catalog.product.get and catalog.product.list methods

Value
type

Description

id
integer

Identifier of the property

timestampX
datetime

Date and time of property modification

iblockId
catalog_catalog.id

Identifier of the trade catalog

name
string

Name of the property

active
char

Activity indicator. Possible values:

• Y — yes
• N — no

sort
integer

Sorting index

code
string

Symbolic code of the property

defaultValue
text

Default value of the property

propertyType
string

Basic type of the property. Allowed values:

• N — number
• S — string
• L — list
• F — file
• E — binding to elements
• G — binding to sections

userType
string

User type of the property. The value corresponds to the specified propertyType.

Examples of values:

• DateTime — date and time
• Money — monetary value with currency
• SKU — binding to product variations
• directory — binding to directory
• employee — binding to employee
• UserID — binding to user
• EList — selection of an element from a list
• EAutocomplete — binding to elements with auto-search
• SectionAuto — binding to sections with auto-search
• HTML — value in HTML format
• map_google — coordinates and address on Google map
• DiskFile — binding to a file from Bitrix24.Drive
• ECrm — binding to CRM elements
• BoolEnum — checkbox based on a list

rowCount
integer

Number of rows in the input field

colCount
integer

Number of columns in the input field

listType
char

Appearance of the list

multiple
char

Indicator of multiplicity. Possible values:

• Y — yes
• N — no

xmlId
string

External identifier of the property

fileType
string

Allowed extensions for the file type property

multipleCnt
integer

Number of input fields for multiple values

linkIblockId
catalog_catalog.id

Identifier of the linked information block.

Available identifiers can be obtained using the catalog.catalog.list method

withDescription
char

Indicator of storing the description of the value

searchable
char

Indicator of participation in search. Possible values:

• Y — yes
• N — no

filtrable
char

Indicator of participation in filtering

isRequired
char

Indicator of mandatory status. Possible values:

• Y — yes
• N — no

hint
string

Hint for the field

userTypeSettings
object

Object with settings for the user type

Value
type

Description

id
integer

Identifier of the value of the list property

propertyId
catalog_product_property.id

Identifier of the product property or variation

value
string

Value of the list element

xmlId
string

External identifier of the value of the list

def
char

Indicator of the default value. Possible values:

• Y — default
• N — not default

sort
integer

Sorting index

Value
type

Description

id
integer

Identifier of the property feature

propertyId
catalog_product_property.id

Identifier of the product property or variation

moduleId
string

Identifier of the module to which the property feature belongs

featureId
string

Code of the property feature

isEnabled
char

Indicator of the activity of the property feature. Possible values:

• Y — enabled
• N — disabled

Value
type

Description

iblockId
catalog_catalog.id

Identifier of the trade catalog

propertyId
catalog_product_property.id

Identifier of the product property or variation

sectionId
integer

Identifier of the catalog section.

For general section settings, the value 0 is returned

smartFilter
char

Show the property in the smart filter. Possible values:

• Y — yes
• N — no

displayType
char

Appearance of the property in the smart filter. Possible values:

• F — checkboxes
• K — radio buttons
• P — dropdown list

displayExpanded
char

Show the property expanded in the filter. Possible values:

• Y — yes
• N — no

filterHint
string

Hint in the smart filter for visitors

Value
type

Description

id
integer

Identifier of the parent product

iblockId
catalog_catalog.id

Identifier of the information block of the trade catalog.

To obtain existing identifiers of information blocks, you need to use catalog.catalog.list

name
string

Name of the parent product

active
string

Activity indicator. Possible values:

• Y — yes
• N — no

available
string

Availability for purchase. Read-only. Possible values:

• Y — yes
• N — no

code
string

Symbolic code

xmlId
string

External code

bundle
string

Availability of a set. Possible values:

• Y — yes
• N — no

canBuyZero
string

Is purchase of the parent product allowed when it is out of stock? Possible values:

• Y — yes
• N — no

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

createdBy
user.id

Created by

modifiedBy
user.id

Modified by

dateActiveFrom
datetime

Date of activity start

dateActiveTo
datetime

Date of activity end

dateCreate
datetime

Date of creation

timestampX
datetime

Date of modification. Read-only

iblockSectionId
catalog_section.id

Identifier of the information block section

measure
catalog_measure.id

Unit of measurement.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

previewText
string

Description for the announcement

detailText
string

Detailed description

previewPicture
object

Picture for the announcement. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

detailPicture
object

Detailed picture. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

previewTextType
string

Type of description for the announcement. Possible values:

• text — text
• html — HTML

detailTextType
string

Type of detailed description. Possible values:

• text — text
• html — HTML

sort
integer

Sorting

subscribe
string

Permission to subscribe to the parent product. Possible values:

• Y — yes
• N — no
• D — default

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

vatId
catalog_vat.id

Identifier of VAT.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

vatIncluded
string

Is VAT included in the price? Possible values:

• Y — yes
• N — no

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

height
float

Height of the parent product.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

length
float

Length of the parent product.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

weight
float

Weight of the parent product.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

width
float

Width of the parent product.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

type
integer

Type of product. Read-only. Possible values:

• 3 — parent product with variations
• 6 — parent product without variations

purchasingCurrency
string

Currency of the purchasing price.

The list of currencies can be obtained using the crm.currency.list method.

Not editable when inventory accounting is enabled.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

purchasingPrice
float

Purchasing price.

Not editable when inventory accounting is enabled.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

quantity
float

Quantity.

Not editable when inventory accounting is enabled.

For parent products, the ability to edit this field is available only in the on-premise version when the option "Show the Trade Catalog tab for products with trade offers" is enabled

propertyN
object\|array

Value of the property of the parent product, where N — identifier of the property. There can be multiple properties.

The value is specified in the format {valueId: valueId, value: value} or in the format [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], if the property is multiple. Here valueId — identifier of the property value, and value — value of the property.

If valueId is not specified, the existing value will be removed from the database and replaced with the new one specified in value. If the property is multiple, all existing values of the property for which valueId was not specified will be removed.

valueId of all properties of the parent product can be obtained using the catalog.product.sku.get and catalog.product.sku.list methods

Value
type

Description

id
integer

Identifier of the product variation

iblockId
catalog_catalog.id

Identifier of the information block of the trade catalog.

To obtain existing identifiers of information blocks, you need to use catalog.catalog.list

name
string

Name of the product variation

active
string

Activity indicator. Possible values:

• Y — yes
• N — no

available
string

Availability for purchase. Read-only. Possible values:

• Y — yes
• N — no

code
string

Symbolic code

xmlId
string

External code

barcodeMulti
string

Unique barcodes for each instance. Possible values:

• Y — yes
• N — no

bundle
string

Availability of a set. Possible values:

• Y — yes
• N — no

canBuyZero
string

Is purchase of the product variation allowed when it is out of stock? Possible values:

• Y — yes
• N — no

createdBy
user.id

Created by

modifiedBy
user.id

Modified by

dateActiveFrom
datetime

Date of activity start

dateActiveTo
datetime

Date of activity end

dateCreate
datetime

Date of creation

timestampX
datetime

Date of modification. Read-only

iblockSectionId
catalog_section.id

Identifier of the information block section

measure
catalog_measure.id

Unit of measurement

previewText
string

Description for the announcement

detailText
string

Detailed description

previewPicture
object

Picture for the announcement. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

detailPicture
object

Detailed picture. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

previewTextType
string

Type of description for the announcement. Possible values:

• text — text
• html — HTML

detailTextType
string

Type of detailed description. Possible values:

• text — text
• html — HTML

sort
integer

Sorting

subscribe
string

Permission to subscribe to the product variation. Possible values:

• Y — yes
• N — no
• D — default

vatId
catalog_vat.id

Identifier of VAT

vatIncluded
string

Is VAT included in the price? Possible values:

• Y — yes
• N — no

height
float

Height of the product

length
float

Length of the product

weight
float

Weight of the product

width
float

Width of the product

quantityTrace
string

Quantity accounting mode. Possible values:

• Y — enabled
• N — disabled
• D — default

type
integer

Type of product. Read-only. Possible values:

• 4 — variation
• 5 — variation without product

purchasingCurrency
string

Currency of the purchasing price.

The list of currencies can be obtained using the crm.currency.list method.

Not editable when inventory accounting is enabled

purchasingPrice
float

Purchasing price.

Not editable when inventory accounting is enabled

quantity
float

Quantity.

Not editable when inventory accounting is enabled

quantityReserved
float

Reserved quantity.

Not editable when inventory accounting is enabled

recurSchemeLength
integer

Length of the payment period.

Used only in the on-premise version for content sales

recurSchemeType
string

Unit of time for the payment period. Possible values:

• H — hour
• D — day
• W — week
• M — month
• Q — quarter
• S — half-year
• Y — year

Used only in the on-premise version for content sales

trialPriceId
integer

Product for trial payment.

Used only in the on-premise version for content sales

withoutOrder
string

Renewal without placing an order. Possible values:

• Y — yes
• N — no

Used only in the on-premise version for content sales

propertyN
object\|array

Value of the property of the product variation, where N — identifier of the property. There can be multiple properties.

The value is specified in the format {valueId: valueId, value: value} or in the format [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], if the property is multiple. Here valueId — identifier of the property value, and value — value of the property.

If valueId is not specified, the existing value will be removed from the database and replaced with the new one specified in value. If the property is multiple, all existing values of the property for which valueId was not specified will be removed.

valueId of all properties of the trade offer can be obtained using the catalog.product.offer.get and catalog.product.offer.list methods

Value
type

Description

id
integer

Identifier of the service

iblockId
catalog_catalog.id

Identifier of the information block of the trade catalog.

To obtain existing identifiers of information blocks, you need to use catalog.catalog.list

name
string

Name of the service

active
string

Activity indicator. Possible values:

• Y — yes
• N — no

available
string

Availability for purchase. Read-only. Possible values:

• Y — yes
• N — no

code
string

Symbolic code

xmlId
string

External code

bundle
string

Availability of a set. Possible values:

• Y — yes
• N — no

createdBy
user.id

Created by

modifiedBy
user.id

Modified by

dateActiveFrom
datetime

Date of activity start

dateActiveTo
datetime

Date of activity end

dateCreate
datetime

Date of creation

timestampX
datetime

Date of modification. Read-only

iblockSectionId
catalog_section.id

Identifier of the information block section

measure
catalog_measure.id

Unit of measurement

previewText
string

Description for the announcement

detailText
string

Detailed description

previewPicture
object

Picture for the announcement. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

detailPicture
object

Detailed picture. Object in the format {fileData: [value1, value2]}, where value1 — name of the picture file with extension, value2 — picture in base64 format.

To delete the picture, use the object in the format {remove: ‘Y’}

previewTextType
string

Type of description for the announcement. Possible values:

• text — text
• html — HTML

detailTextType
string

Type of detailed description. Possible values:

• text — text
• html — HTML

sort
integer

Sorting

vatId
catalog_vat.id

Identifier of VAT

vatIncluded
string

Is VAT included in the price? Possible values:

• Y — yes
• N — no

type
integer

Type of product. Read-only. Possible values:

• 7 — service

propertyN
object\|array

Value of the property of the service, where N — identifier of the property. There can be multiple properties.

The value is specified in the format {valueId: valueId, value: value} or in the format [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], if the property is multiple. Here valueId — identifier of the property value, and value — value of the property.

If valueId is not specified, the existing value will be removed from the database and replaced with the new one specified in value. If the property is multiple, all existing values of the property for which valueId was not specified will be removed.

valueId of all properties of the service can be obtained using the catalog.product.service.get and catalog.product.service.list methods

Value
type

Description

id
integer

Identifier of the image

name
string

Name of the image

productId
integer

Identifier of the product

type
string

Type of image:

• DETAIL_PICTURE — detailed picture, field available in the old product card
• PREVIEW_PICTURE — picture for the announcement, field available in the old product card
• MORE_PHOTO — picture

createTime
datetime

Date of image creation

downloadUrl
string

Download link, signed with the current access token

detailUrl
string

Link to the image

Name
type

Description

id
integer

Identifier of the warehouse

address
string

Address of the warehouse

title
string

Name of the warehouse

active
string

Activity. Possible values:

• Y — yes
• N — no

description
string

Description

gpsN
double

GPS latitude

gpsS
double

GPS longitude

imageId
object

Image. Object in the format {fileData: [value1, value2]}, where:

• value1 – name of the picture file with extension
• value2 – picture in base64 format

To delete the picture, use the object in the format {remove: ‘Y’}

dateModify
datetime

Date of modification

dateCreate
datetime

Date of creation

userId
user.id

Created by

modifiedBy
user.id

Modified by

phone
string

Phone

schedule
string

Working hours

xmlId
string

External code.

Can be used to synchronize the current warehouse with a similar position in an external system

sort
integer

Sorting

email
string

E-mail

issuingCenter
string

Is it a pickup point? Possible values:

• Y – yes
• N – no

code
string

Symbolic code

Value
type

Description

id
integer

Identifier of the unit of measurement

code
integer

Code of the unit of measurement

isDefault
string

Is the current unit of measurement used as the default unit for new products? Possible values:

• Y — yes
• N — no

Only one unit of measurement from the entire directory can take the value Y

measureTitle
string

Title of the unit of measurement

symbol
string

Conditional designation

symbolIntl
string

International conditional designation

symbolLetterIntl
string

International code letter designation

Value
type

Description

id
integer

Identifier of the unit of measurement ratio

productId
integer

Identifier of the product

ratio
double

Ratio of the unit of measurement

isDefault
string

Is this unit of measurement ratio the default ratio? Possible values:

• Y — yes
• N — no

Value
type

Description

id
integer

Identifier of the price

productId
catalog_product.id

Identifier of the product

catalogGroupId
catalog_price_type.id

Identifier of the price type

price
double

Value of the price

priceScale
double

Value of the base price

currency
string

Currency of the price

quantityFrom
double

Minimum quantity for applying the price. Deprecated parameter

quantityTo
double

Maximum quantity for applying the price. Deprecated parameter

extraId
catalog_extra.id

Identifier of the markup. Deprecated parameter

timestampX
datetime

Date of modification

Value
type

Description

id
integer

Identifier of the price type

name
string

Code of the price type

base
string

Is the price type basic? Possible values:

• Y — yes
• N — no

sort
integer

Sorting

xmlId
string

External code.

Can be used to synchronize the current price type with a similar position in an external system

timestampX
datetime

Date of modification

createdBy
user.id

Created by

modifiedBy
user.id

Modified by

dateCreate
datetime

Date of creation

Value
type

Description

id
integer

Identifier of the binding of the price type to the customer group

catalogGroupId
catalog_price_type.id

Identifier of the price type

groupId
integer

Identifier of the customer group

access
char

Type of access. Possible values:

• Y — right to purchase at this price type
• N — right to view this price type

Value
type

Description

id
integer | string

Identifier of the enumeration element

name
string

Name of the enumeration element

Value
type

Description

id
integer

Identifier of the translation of the price type name

catalogGroupId
catalog_price_type.id

Identifier of the price type

name
string

Translation of the price type name

lang
catalog_language.lid

Identifier of the language

Value
type

Description

lid
string

Identifier of the language

name
string

Name of the language

active
string

Activity indicator. Possible values:

• Y — yes
• N — no

Value
type

Description

id
integer

Identifier of the price rounding rule

catalogGroupId
catalog_price_type.id

Price type

price
double

Minimum price for rounding

roundType
integer

Type of rounding. Possible values:

• 1 — mathematical rounding
• 2 — rounding up (in favor of the store)
• 4 — rounding down (in favor of the customer)

roundPrecision
double

Rounding precision

createdBy
user.id

Created by

modifiedBy
user.id

Modified by

dateCreate
datetime

Date of creation

dateModify
datetime

Date of modification

Value
type

Description

id
integer

Identifier of the markup

name
string

Name of the markup

percentage
double

Amount of the markup

Value
type

Description

id
integer

Identifier of the catalog section

iblockId
catalog_catalog.id

Identifier of the information block.

To obtain existing identifiers, you need to use catalog.catalog.list

iblockSectionId
catalog_section.id

Identifier of the parent section.

To obtain existing identifiers, you need to use catalog.section.list.

By default, the top level is selected

name
string

Name of the catalog section

xmlId
string

External identifier.

Can be used to synchronize the current catalog section with a similar position in an external system

code
string

Code of the catalog section

sort
integer

Sorting

active
string

Indicator of the activity of the catalog section:

• Y — active
• N — inactive

description
string

Description

descriptionType
string

Type of description. Available types: text, html

Value
type

Description

id
integer

Identifier of the stock record

productId
catalog_product.id

Identifier of the product

storeId
catalog_store.id

Identifier of the warehouse

amount
double

Available quantity of the product

quantityReserved
double

Quantity of the product in reserve

Value
type

Description

id
integer

Identifier of the VAT rate

name
string

Name of the VAT rate

active
string

Indicator of the activity of the VAT rate. Possible values:

• Y — active
• N — inactive

rate
double

Amount of the VAT rate

sort
integer

Sorting

timestampX
datetime

Time of the last modification

Value
type

Description

isImmutable
boolean

Indicator of the ability to change the field value after creation.

If this indicator is set for the field, then when creating the object, you can specify the field value, but it cannot be changed during updates

isReadOnly
boolean

Indicator of "read-only".

If this indicator is set for the field, then in the operations of adding and updating the object, the field value does not need to be passed. The value is generated automatically and is intended for read-only

isRequired
boolean

Indicator of the mandatory field for add or update operations

type
string

Data type of the field values. Possible values:

• integer
• double
• string
• char
• list
• text
• file
• date
• datetime
• datatype
• productpropertysettings