Типы данных и структура объектов в REST API Каталога

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Типы данных Каталога описывают идентификаторы и структуры объектов в параметрах и ответах методов catalog.*. По справочнику можно определить назначение объекта, связь с торговым каталогом и формат его полей. Базовые типы integer, string, object и другие перечислены в статье Типы данных в REST API.

Как выбрать объект

Объект

Когда использовать

Методы

catalog_product

Для простого товара без вариаций, который можно продавать как отдельную позицию

catalog.product.*

catalog_product_sku

Для головного товара, который объединяет вариации и хранит общую информацию о них

catalog.product.sku.*

catalog_product_offer

Для вариации головного товара, например определенного цвета или размера

catalog.product.offer.*

catalog_product_service

Для услуги, у которой нет материального остатка

catalog.product.service.*

catalog_catalog

Для определения информационных блоков товаров и вариаций и связи между ними

catalog.catalog.*

catalog_price

Для цены товара, вариации или услуги

catalog.price.*

catalog_storeproduct

Для остатка товара или вариации на конкретном складе

catalog.storeproduct.*

Полный список типов и структур приведен ниже. Если метод возвращает тип вида catalog_product.id, значение содержит идентификатор соответствующего объекта, а не весь объект.

Связь товара и вариации

Поле type определяет роль товарного объекта. Оно доступно только для чтения:

  • 1 — простой товар
  • 3 — головной товар с вариациями
  • 4 — вариация
  • 5 — вариация без головного товара
  • 6 — головной товар без вариаций
  • 7 — услуга

Поле iblockId указывает, в каком информационном блоке находится объект. Головной товар хранится в информационном блоке товаров, а вариация — в отдельном информационном блоке вариаций. У объекта catalog_catalog для информационного блока вариаций поле productIblockId содержит идентификатор информационного блока товаров, а skuPropertyId — идентификатор свойства связи с головным товаром.

Конкретная вариация связана с головным товаром через поле parentId объекта catalog_product_offer. Например, для вариации с parentId: 200 головным будет товар catalog_product_sku с id: 200.

Чтобы определить объекты и их связь:

  1. Получите информационные блоки методом catalog.catalog.list
  2. Выберите объект по значению type
  3. Для вариации сопоставьте parentId с id головного товара
  4. Перейдите к таблице объекта и проверьте формат нужного поля

Типы данных

Тип

Описания и значения

catalog_catalog.id

Целочисленный идентификатор торгового каталога (например, 1). Получить идентификаторы торговых каталогов можно с помощью метода catalog.catalog.list

catalog_document.id

Целочисленный идентификатор документа складского учета, например 1. Получить идентификаторы документов можно с помощью метода catalog.document.list

catalog_document_element.id

Целочисленный идентификатор товара документа складского учета, например 1. Получить идентификаторы товаров в документах можно с помощью метода catalog.document.element.list

catalog_documentcontractor.id

Целочисленный идентификатор привязки поставщика к документу складского учета, например 1. Получить идентификаторы привязок можно с помощью метода catalog.documentcontractor.list

catalog_product.id

Целочисленный идентификатор товара (например, 1). Получить идентификаторы товаров можно с помощью метода catalog.product.list

catalog_product_property.id

Целочисленный идентификатор свойства товара или вариации (например, 1). Получить идентификаторы свойств можно с помощью метода catalog.productProperty.list

catalog_product_sku.id

Целочисленный идентификатор головного товара (например, 1). Получить идентификаторы головных товаров можно с помощью метода catalog.product.sku.list

catalog_product_offer.id

Целочисленный идентификатор вариации товара (например, 1). Получить идентификаторы вариаций товаров можно с помощью метода catalog.product.offer.list

catalog_product_service.id

Целочисленный идентификатор услуги (например, 1). Получить идентификаторы услуг можно с помощью метода catalog.product.service.list

catalog_product_image.id

Целочисленный идентификатор изображения товара (например, 1). Получить идентификаторы изображений товаров можно с помощью метода catalog.productImage.list

catalog_store.id

Целочисленный идентификатор склада (например, 1). Получить идентификаторы складов можно с помощью метода catalog.store.list

catalog_measure.id

Целочисленный идентификатор единицы измерения (например, 1). Получить идентификаторы единиц измерения можно с помощью метода catalog.measure.list

catalog_ratio.id

Целочисленный идентификатор коэффициента единицы измерения (например, 1). Получить идентификаторы коэффициентов единиц измерения можно с помощью метода catalog.ratio.list

catalog_price.id

Целочисленный идентификатор цены, например 1. Получить идентификаторы цен можно с помощью метода catalog.price.list

catalog_price_type.id

Целочисленный идентификатор типа цены (например, 1). Получить идентификаторы типов цены можно с помощью метода catalog.priceType.list

catalog_price_type_lang.id

Целочисленный идентификатор перевода названий типов цен (например, 1). Получить идентификаторы переводов можно с помощью метода catalog.priceTypeLang.list

catalog_language.lid

Строковый идентификатор языка, состоящий из двух символов (например, ru). Получить идентификаторы языков можно с помощью метода catalog.priceTypeLang.getLanguages

catalog_rounding_rule.id

Целочисленный идентификатор правила округления цен (например, 1). Получить идентификаторы правил округления цен можно с помощью метода catalog.roundingRule.list

catalog_extra.id

Целочисленный идентификатор наценки (например, 1). Получить идентификаторы наценок можно с помощью метода catalog.extra.list

catalog_section.id

Целочисленный идентификатор раздела каталога (например, 1). Получить идентификаторы разделов каталога можно с помощью метода catalog.section.list

catalog_storeproduct.id

Целочисленный идентификатор записи остатков товара на складе, например 1. Получить идентификаторы можно с помощью метода catalog.storeproduct.list

catalog_vat.id

Целочисленный идентификатор ставки НДС (например, 1). Получить идентификаторы ставки НДС можно с помощью метода catalog.vat.list

Структура объектов

В примерах показаны поля, по которым можно определить тип объекта, его торговый каталог и связь вариации с головным товаром.

{
  "catalog_product": {
    "id": 101,
    "iblockId": 12,
    "name": "Кружка",
    "type": 1
  },
  "catalog_product_sku": {
    "id": 200,
    "iblockId": 12,
    "name": "Футболка",
    "type": 3
  },
  "catalog_product_offer": {
    "id": 201,
    "iblockId": 13,
    "name": "Футболка, размер M",
    "parentId": 200,
    "type": 4
  },
  "catalog_product_service": {
    "id": 301,
    "iblockId": 12,
    "name": "Доставка",
    "type": 7
  }
}

В примере catalog_product_sku с id: 200 — головной товар. Объект catalog_product_offer с parentId: 200 — его вариация в информационном блоке 13. Простой товар и услуга находятся в информационном блоке 12, но различаются значением type.

catalog_catalog

Значение
тип

Описание

id
integer

Идентификатор торгового каталога

iblockId
integer

Идентификатор информационного блока торгового каталога

iblockTypeId
string

Тип информационного блока торгового каталога. Для торговых каталогов CRM имеет постоянное значение CRM_PRODUCT_CATALOG

lid
string

Идентификатор сайта. Имеет постоянное значение s1

name
string

Название торгового каталога

productIblockId
integer

Идентификатор родительского информационного блока торгового каталога. Заполняется только для торгового каталога вариаций.

Для получения существующих идентификаторов информационных блоков необходимо использовать catalog.catalog.list

skuPropertyId
integer

Идентификатор свойства, в котором хранится идентификатор родительского товара. Заполняется только для торгового каталога вариаций.

Для получения существующих идентификаторов свойств необходимо использовать catalog.productProperty.list

subscription
string

Производится ли продажа контента. Возможные значения:

  • Y — да
  • N — нет

Параметр используется только в коробочной версии

vatId
catalog_vat.id

Идентификатор НДС.

Для получения существующих идентификаторов НДС необходимо использовать catalog.vat.list

yandexExport
string

Признак выгрузки товаров каталога в Яндекс Маркет. Возможные значения:

  • Y — выгружать
  • N — не выгружать

catalog_document

Значение
тип

Описание

id
integer

Идентификатор документа складского учета

docType
string

Тип документа. Доступные типы можно получить методом catalog.enum.getStoreDocumentTypes

docNumber
string

Номер документа. Если не передан — null, автоматически не создается

title
string

Название документа. Может быть null

siteId
string

Код сайта, к которому относится документ. По умолчанию — s1

responsibleId
integer

Идентификатор ответственного. Может быть null

createdBy
integer

Идентификатор пользователя, создавшего документ

modifiedBy
integer

Идентификатор пользователя, изменившего документ

status
string

Статус документа:

  • N — черновик, в том числе после отмены проведения
  • Y — проведен

Значение изменяется автоматически при проведении или отмене документа

statusBy
integer

Пользователь, изменивший статус документа. Может быть null

dateStatus
datetime

Дата изменения статуса

dateCreate
datetime

Дата создания документа

dateModify
datetime

Дата последнего изменения документа

dateDocument
datetime

Дата документа. Может быть null

currency
string

Код валюты. Не проверяется, после создания не меняется

total
double

Сумма документа. Автоматически не пересчитывается, в том числе при проведении. Может быть null

commentary
string

Комментарий к документу. Может быть null

catalog_userfield_document

Значение
тип

Описание

documentId
catalog_document.id

Идентификатор документа складского учета

documentType
string

Тип документа складского учета

fieldN
any

Значение пользовательского поля документа, где N — идентификатор пользовательского поля, например field7097. null, если не заполнено

catalog_document_element

Значение
тип

Описание

id
integer

Идентификатор товара документа складского учета

docId
catalog_document.id

Идентификатор документа складского учета

elementId
catalog_product.id

Идентификатор товара каталога. В REST 2 может быть null

storeFrom
catalog_store.id

Идентификатор склада-источника. Используется в документах перемещения и списания. В REST 2 может быть null

storeTo
catalog_store.id

Идентификатор склада-получателя. Используется в документах прихода, оприходования, перемещения и возврата. В REST 2 может быть null

amount
double

Количество товара. В REST 2 может быть null

purchasingPrice
double

Закупочная цена. В REST 2 может быть null

catalog_documentcontractor

Значение
тип

Описание

id
integer

Идентификатор привязки поставщика к документу складского учета

documentId
catalog_document.id

Идентификатор документа складского учета, к которому привязан поставщик

entityTypeId
integer

Идентификатор типа объекта CRM:

  • 3 — контакт
  • 4 — компания

entityId
integer

Идентификатор поставщика: контакта или компании

catalog_product

Значение
тип

Описание

id
integer

Идентификатор товара

iblockId
catalog_catalog.id

Идентификатор информационного блока торгового каталога.

Для получения существующих идентификаторов информационных блоков необходимо использовать catalog.catalog.list

name
string

Наименование товара

active
string

Признак активности. Возможные значения:

  • Y — да
  • N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

  • Y — да
  • N — нет

code
string

Символьный код

xmlId
string

Внешний код

barcodeMulti
string

Уникальные штрихкоды для каждого экземпляра. Возможные значения:

  • Y — да
  • N — нет

bundle
string

Наличие набора. Возможные значения:

  • Y — да
  • N — нет

canBuyZero
string

Разрешается ли покупка товара при его отсутствии. Возможные значения:

  • Y — да
  • N — нет
  • D — значение из настроек модуля Торговый каталог

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

Дата начала активности

dateActiveTo
datetime

Дата окончания активности

dateCreate
datetime

Дата создания

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

Идентификатор раздела информационного блока

iblockSection
catalog_section.id[]

Массив идентификаторов разделов, к которым привязан товар. Если товар не привязан к разделам — null

measure
catalog_measure.id

Единица измерения

previewText
string

Описание для анонса

detailText
string

Детальное описание

previewPicture
object

Картинка для анонса. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

detailPicture
object

Детальная картинка. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

previewTextType
string

Тип описания для анонса. Возможные значения:

  • text — текст
  • html — HTML

detailTextType
string

Тип детального описания. Возможные значения:

  • text — текст
  • html — HTML

sort
integer

Сортировка

subscribe
string

Разрешение подписки на товар. Возможные значения:

  • Y — да
  • N — нет
  • D — значение из настроек модуля Торговый каталог

vatId
catalog_vat.id

Идентификатор НДС

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

  • Y — да
  • N — нет

height
double

Высота товара

length
double

Длина товара

weight
double

Вес товара

width
double

Ширина товара

quantityTrace
string

Режим количественного учета. Возможные значения:

  • Y — включен
  • N — выключен
  • D — значение из настроек модуля Торговый каталог

type
integer

Тип товара. Только для чтения. Возможные значения:

  • 1 — простой товар

purchasingCurrency
string

Валюта закупочной цены.

Список валют можно получить методом crm.currency.list.

Не редактируется при включенном складском учете

Приходит, только если у пользователя есть право на просмотр закупочной цены

purchasingPrice
double

Закупочная цена.

Не редактируется при включенном складском учете

Приходит, только если у пользователя есть право на просмотр закупочной цены

quantity
double

Количество.

Не редактируется при включенном складском учете

quantityReserved
double

Зарезервированное количество.

Не редактируется при включенном складском учете

recurSchemeLength
integer

Длина периода оплаты.

Используется только в коробочной версии для продажи контента

recurSchemeType
string

Единица времени периода оплаты. Возможные значения:

  • H — час
  • D — день
  • W — неделя
  • M — месяц
  • Q — квартал
  • S — полугодие
  • Y — год

Используется только в коробочной версии для продажи контента

trialPriceId
integer

Товар для пробной оплаты.

Используется только в коробочной версии для продажи контента

withoutOrder
string

Продление без оформления заказа. Возможные значения:

  • Y — да
  • N — нет

Используется только в коробочной версии для продажи контента

propertyN
object|array

Значение свойства товара, где N — идентификатор свойства. Свойств может быть несколько.

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены. Исключение — свойства типа «файл»: их значения, не переданные в запросе, сохраняются, но valueId оставшихся значений после удаления меняются.

valueId всех свойств товара можно получить с помощью методов catalog.product.get и catalog.product.list

catalog_product_property

Значение
тип

Описание

id
integer

Идентификатор свойства

timestampX
datetime

Дата и время изменения свойства

iblockId
catalog_catalog.id

Идентификатор торгового каталога

name
string

Название свойства

active
char

Признак активности. Возможные значения:

  • Y — да
  • N — нет

sort
integer

Индекс сортировки

code
string

Символьный код свойства

defaultValue
text

Значение свойства по умолчанию

propertyType
string

Базовый тип свойства. Допустимые значения:

  • N — число
  • S — строка
  • L — список
  • F — файл
  • E — привязка к элементам
  • G — привязка к разделам

userType
string

Пользовательский тип свойства. Значение соответствует указанному propertyType.

Основные значения и базовый тип propertyType, с которым они используются:

  • DateTime — дата и время, S
  • Money — денежное значение с валютой, S
  • SKU — привязка к вариациям товара, E
  • directory — привязка к справочнику, S
  • employee — привязка к сотруднику, S
  • UserID — привязка к пользователю, S
  • EList — выбор элемента из списка, E
  • EAutocomplete — привязка к элементам с автопоиском, E
  • SectionAuto — привязка к разделам с автопоиском, G
  • HTML — значение в формате HTML, S
  • map_google — координаты и адрес на карте Google, S
  • map_yandex — координаты и адрес на карте Яндекс, S
  • DiskFile — привязка к файлу из Битрикс24.Диск, S
  • ECrm — привязка к элементам CRM, S
  • BoolEnum — чекбокс на базе списка, L

rowCount
integer

Число строк поля ввода

colCount
integer

Число колонок поля ввода

listType
char

Внешний вид списка. Возможные значения:

  • L — выпадающий список
  • C — набор флажков

multiple
char

Признак множественности. Возможные значения:

  • Y — да
  • N — нет

xmlId
string

Внешний идентификатор свойства

fileType
string

Разрешенные расширения для свойства типа файл

multipleCnt
integer

Число полей ввода для множественных значений

linkIblockId
catalog_catalog.id

Идентификатор связанного инфоблока.

Доступные идентификаторы можно получить методом catalog.catalog.list

withDescription
char

Признак хранения описания значения. Возможные значения:

  • Y — да
  • N — нет

searchable
char

Признак участия в поиске. Возможные значения:

  • Y — да
  • N — нет

filtrable
char

Признак участия в фильтрации. Возможные значения:

  • Y — да
  • N — нет

isRequired
char

Признак обязательности. Возможные значения:

  • Y — да
  • N — нет

hint
string

Подсказка для поля

userTypeSettings
object

Объект с настройками пользовательского типа

catalog_product_property_enum

Значение
тип

Описание

id
integer

Идентификатор значения списочного свойства

propertyId
catalog_product_property.id

Идентификатор свойства товара или вариации

value
string

Значение элемента списка

xmlId
string

Внешний идентификатор значения списка

def
char

Признак значения по умолчанию. Возможные значения:

  • Y — по умолчанию
  • N — не по умолчанию

sort
integer

Индекс сортировки

catalog_product_property_features

Значение
тип

Описание

id
integer

Идентификатор параметра свойства

propertyId
catalog_product_property.id

Идентификатор свойства товара или вариации

moduleId
string

Идентификатор модуля, которому принадлежит параметр свойства

featureId
string

Код параметра свойства

isEnabled
char

Признак активности параметра свойства. Возможные значения:

  • Y — включен
  • N — выключен

catalog_product_property_section

Значение
тип

Описание

iblockId
catalog_catalog.id

Идентификатор торгового каталога. Приходит только в ответе метода catalog.productPropertySection.set

propertyId
catalog_product_property.id

Идентификатор свойства товара или вариации

sectionId
integer

Идентификатор раздела каталога.

Для общих настроек секций возвращается значение 0. Приходит только в ответе метода catalog.productPropertySection.set

smartFilter
char

Показывать ли свойство в умном фильтре. Возможные значения:

  • Y — да
  • N — нет
  • null — значение не задано. Если передать N в catalog.productPropertySection.set, сохранится null

displayType
char

Вид свойства в умном фильтре. Возможные значения:

  • F — флажки
  • K — радиокнопки
  • P — выпадающий список
  • G — флажки с картинками
  • H — флажки с названиями и картинками
  • R — выпадающий список с названиями и картинками
  • U — календарь
  • A — число от-до с ползунком
  • B — число от-до
  • null — вид не задан

displayExpanded
char

Показывать ли свойство развернутым в фильтре. Возможные значения:

  • Y — да
  • N — нет
  • null — значение не задано. Если передать N в catalog.productPropertySection.set, сохранится null

filterHint
string

Подсказка в умном фильтре для посетителей

catalog_product_sku

Значение
тип

Описание

id
integer

Идентификатор головного товара

iblockId
catalog_catalog.id

Идентификатор информационного блока торгового каталога.

Для получения существующих идентификаторов информационных блоков необходимо использовать catalog.catalog.list

name
string

Наименование головного товара

active
string

Признак активности. Возможные значения:

  • Y — да
  • N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

  • Y — да
  • N — нет

code
string

Символьный код. Может быть null

xmlId
string

Внешний код. По умолчанию совпадает с id

bundle
string

Наличие набора. Возможные значения:

  • Y — да
  • N — нет

canBuyZero
string

Разрешается ли покупка головного товара при его отсутствии. Возможные значения:

  • Y — да
  • N — нет

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

Дата начала активности

dateActiveTo
datetime

Дата окончания активности

dateCreate
datetime

Дата создания

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

Идентификатор раздела информационного блока

iblockSection
catalog_section.id[]

Массив идентификаторов разделов, к которым привязан товар. Если товар не привязан к разделам — null

measure
catalog_measure.id

Единица измерения.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

previewText
string

Описание для анонса. Может быть null

detailText
string

Детальное описание. Может быть null

previewPicture
object

Картинка для анонса. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

В ответе приходит объект {id, url, urlMachine} или null, если картинки нет

detailPicture
object

Детальная картинка. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

В ответе приходит объект {id, url, urlMachine} или null, если картинки нет

previewTextType
string

Тип описания для анонса. Возможные значения:

  • text — текст
  • html — HTML

detailTextType
string

Тип детального описания. Возможные значения:

  • text — текст
  • html — HTML

sort
integer

Сортировка. Может быть null

subscribe
string

Разрешение подписки на головной товар. Возможные значения:

  • Y — да
  • N — нет
  • D — по умолчанию

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

vatId
catalog_vat.id

Идентификатор НДС.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

  • Y — да
  • N — нет

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

height
double

Высота головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

length
double

Длина головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

weight
double

Вес головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

width
double

Ширина головного товара.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

type
integer

Тип товара. Только для чтения. Возможные значения:

  • 3 — головной товар с вариациями
  • 6 — головной товар без вариаций

purchasingCurrency
string

Валюта закупочной цены.

Список валют можно получить методом crm.currency.list.

Не редактируется при включенном складском учете.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

purchasingPrice
double

Закупочная цена.

Не редактируется при включенном складском учете.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

quantity
double

Количество.

Не редактируется при включенном складском учете.

Для головных товаров возможность редактирования данного поля доступна только в коробочной версии при включенной опции «Показывать вкладку Торговый каталог для товаров, имеющих торговые предложения»

propertyN
object|array

Значение свойства головного товара, где N — идентификатор свойства. Свойств может быть несколько.

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены. Исключение — свойства типа «файл»: их значения, не переданные в запросе, сохраняются, но valueId оставшихся значений после удаления меняются.

valueId всех свойств головного товара можно получить с помощью методов catalog.product.sku.get и catalog.product.sku.list.

В ответе приходит объект {value, valueId}, массив таких объектов для множественного свойства или null, если значение не задано

catalog_product_offer

Значение
тип

Описание

id
integer

Идентификатор вариации товара

parentId
catalog_product_sku.id

Идентификатор головного товара.

Получить идентификаторы головных товаров можно методом catalog.product.sku.list.

В ответе приходит объект {value, valueId} или null у вариации без головного товара

iblockId
catalog_catalog.id

Идентификатор информационного блока торгового каталога.

Для получения существующих идентификаторов информационных блоков необходимо использовать catalog.catalog.list

name
string

Наименование вариации товара

active
string

Признак активности. Возможные значения:

  • Y — да
  • N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

  • Y — да
  • N — нет

code
string

Символьный код

xmlId
string

Внешний код. По умолчанию совпадает с id

barcodeMulti
string

Уникальные штрихкоды для каждого экземпляра. Возможные значения:

  • Y — да
  • N — нет

bundle
string

Наличие набора. Возможные значения:

  • Y — да
  • N — нет

canBuyZero
string

Разрешается ли покупка вариации товара при ее отсутствии. Возможные значения:

  • Y — да
  • N — нет

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

Дата начала активности

dateActiveTo
datetime

Дата окончания активности

dateCreate
datetime

Дата создания

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

Идентификатор раздела информационного блока

measure
catalog_measure.id

Единица измерения

previewText
string

Описание для анонса

detailText
string

Детальное описание

previewPicture
object

Картинка для анонса. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

В ответе приходит объект {id, url, urlMachine} или null, если картинки нет

detailPicture
object

Детальная картинка. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

В ответе приходит объект {id, url, urlMachine} или null, если картинки нет

previewTextType
string

Тип описания для анонса. Возможные значения:

  • text — текст
  • html — HTML

detailTextType
string

Тип детального описания. Возможные значения:

  • text — текст
  • html — HTML

sort
integer

Сортировка. По умолчанию 500

subscribe
string

Разрешение подписки на вариацию товара. Возможные значения:

  • Y — да
  • N — нет
  • D — по умолчанию

vatId
catalog_vat.id

Идентификатор НДС

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

  • Y — да
  • N — нет

height
double

Высота товара

length
double

Длина товара

weight
double

Вес товара

width
double

Ширина товара

quantityTrace
string

Режим количественного учета. Возможные значения:

  • Y — включен
  • N — выключен
  • D — по умолчанию

type
integer

Тип товара. Только для чтения. Возможные значения:

  • 4 — вариация
  • 5 — вариация без товара

purchasingCurrency
string

Валюта закупочной цены.

Список валют можно получить методом crm.currency.list.

Не редактируется при включенном складском учете

purchasingPrice
double

Закупочная цена. В ответе приходит строкой, например "100.00000000".

Не редактируется при включенном складском учете

quantity
double

Количество.

Не редактируется при включенном складском учете

quantityReserved
double

Зарезервированное количество.

Не редактируется при включенном складском учете

recurSchemeLength
integer

Длина периода оплаты.

Используется только в коробочной версии для продажи контента

recurSchemeType
string

Единица времени периода оплаты. Возможные значения:

  • H — час
  • D — день
  • W — неделя
  • M — месяц
  • Q — квартал
  • S — полугодие
  • Y — год

Используется только в коробочной версии для продажи контента

trialPriceId
integer

Товар для пробной оплаты.

Используется только в коробочной версии для продажи контента

withoutOrder
string

Продление без оформления заказа. Возможные значения:

  • Y — да
  • N — нет

Используется только в коробочной версии для продажи контента

propertyN
object|array

Значение свойства вариации товара, где N — идентификатор свойства. Свойств может быть несколько.

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены. Исключение — свойства типа «файл»: их значения, не переданные в запросе, сохраняются, но valueId оставшихся значений после удаления меняются.

valueId всех свойств вариации можно получить с помощью методов catalog.product.offer.get и catalog.product.offer.list.

В ответе приходит объект {value, valueId}, для списка — с полем valueEnum, массив таких объектов для множественного свойства или null

catalog_product_service

Значение
тип

Описание

id
integer

Идентификатор услуги

iblockId
catalog_catalog.id

Идентификатор информационного блока торгового каталога.

Для получения существующих идентификаторов информационных блоков необходимо использовать catalog.catalog.list

name
string

Наименование услуги

active
string

Признак активности. Возможные значения:

  • Y — да
  • N — нет

available
string

Доступность для покупки. Только для чтения. Возможные значения:

  • Y — да
  • N — нет

code
string

Символьный код

xmlId
string

Внешний код

bundle
string

Наличие набора. Возможные значения:

  • Y — да
  • N — нет

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateActiveFrom
datetime

Дата начала активности

dateActiveTo
datetime

Дата окончания активности

dateCreate
datetime

Дата создания. При передаче в add и update сохраняется неверно, например как 2001-11-30T00:00:00+03:00

timestampX
datetime

Дата изменения. Только для чтения

iblockSectionId
catalog_section.id

Идентификатор раздела информационного блока

iblockSection
catalog_section.id[]

Массив идентификаторов разделов, к которым привязана услуга. Если услуга не привязана к разделам — null

measure
catalog_measure.id

Единица измерения

previewText
string

Описание для анонса

detailText
string

Детальное описание

previewPicture
object

Картинка для анонса. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

detailPicture
object

Детальная картинка. Объект в формате {fileData: [value1, value2]}, где value1 — название файла картинки с расширением, value2 — картинка в формате base64.

Для удаления картинки используется объект в формате {remove: ‘Y’}

previewTextType
string

Тип описания для анонса. Возможные значения:

  • text — текст
  • html — HTML

detailTextType
string

Тип детального описания. Возможные значения:

  • text — текст
  • html — HTML

sort
integer

Сортировка

vatId
catalog_vat.id

Идентификатор НДС

vatIncluded
string

Включен ли НДС в цену. Возможные значения:

  • Y — да
  • N — нет

type
integer

Тип товара. Только для чтения. Возможные значения:

  • 7 — услуга

propertyN
object|array

Значение свойства услуги, где N — идентификатор свойства. Свойств может быть несколько.

Значение указывается в формате {valueId: valueId, value: value} либо в формате [{valueId: valueId1, value: value1}, ..., {valueId: valueIdN, value: valueN}], если свойство множественное. Здесь valueId — идентификатор значения свойства, а value — значение свойства.

Если не указать valueId, то существующее значение будет удалено из базы данных и заменено на новое, указанное в value. Если свойство множественное, то все существующие значения свойства, для которых не был указан valueId, будут удалены. Исключение — свойства типа «файл»: их значения, не переданные в запросе, сохраняются, но valueId оставшихся значений после удаления меняются.

valueId всех свойств услуги можно получить с помощью методов catalog.product.service.get и catalog.product.service.list.

Значение одиночного свойства в ответе — объект {"value": ..., "valueId": ...}, множественного — массив таких объектов, незаполненного — null

catalog_product_image

Значение
тип

Описание

id
integer

Идентификатор изображения

name
string

Наименование изображения

productId
integer

Идентификатор товара

type
string

Тип изображения:

  • DETAIL_PICTURE — детальная картинка, поле доступно в старой карточке товара
  • PREVIEW_PICTURE — картинка для анонса, поле доступно в старой карточке товара
  • MORE_PHOTO — дополнительное изображение

createTime
datetime

Дата создания изображения

downloadUrl
string

Ссылка для скачивания, подписанная токеном запроса. Если запрос выполнен через вебхук, из ссылки можно восстановить код вебхука, поэтому не передавайте ее третьим лицам и не публикуйте.

В REST 3.0 значение совпадает с detailUrl — это ссылка на изображение в CDN

detailUrl
string

Ссылка на изображение

catalog_store

Значение
тип

Описание

id
integer

Идентификатор склада

address
string

Адрес склада

title
string

Название склада

active
string

Активность. Возможные значения:

  • Y — да
  • N — нет

description
string

Описание

gpsN
double

GPS-широта

gpsS
double

GPS-долгота

imageId
object

Изображение склада. В ответе — объект {"id": <id файла>, "url": "<ссылка на изображение>"} или null. Через REST задать или удалить изображение нельзя

dateModify
datetime

Дата изменения. Заполняется автоматически

dateCreate
datetime

Дата создания. Заполняется автоматически

userId
user.id

Кем создан. Заполняется автоматически. У системных складов — null

modifiedBy
user.id

Кем изменен. Заполняется автоматически

phone
string

Телефон

schedule
string

График работы

xmlId
string

Внешний код.

Можно использовать для синхронизации текущего склада с аналогичной позицией во внешней системе

sort
integer

Сортировка

email
string

E-mail

issuingCenter
string

Является ли пунктом выдачи. Возможные значения:

  • Y — да
  • N — нет

code
string

Символьный код

catalog_measure

Значение
тип

Описание

id
integer

Идентификатор единицы измерения

code
integer

Код единицы измерения

isDefault
string

Используется ли текущая единица измерения в качестве единицы измерения по умолчанию для новых товаров. Возможные значения:

  • Y — да
  • N — нет

Только одна единица измерения из всего справочника может принимать значение Y

measureTitle
string

Название единицы измерения.

У стандартных единиц, которые Битрикс24 создает при подключении каталога, поле пустое: REST 2 возвращает null, REST 3.0 — пустую строку. Интерфейс в этом случае показывает название из встроенного справочника единиц по коду code, а если его нет — значение symbolIntl

symbol
string

Условное обозначение. У стандартных единиц поле пустое, как и measureTitle

symbolIntl
string

Международное условное обозначение

symbolLetterIntl
string

Международное кодовое буквенное обозначение

catalog_ratio

Значение
тип

Описание

id
integer

Идентификатор коэффициента единицы измерения

productId
integer

Идентификатор товара

ratio
double

Коэффициент единицы измерения

isDefault
string

Является ли данный коэффициент единицы измерения коэффициентом по умолчанию. Возможные значения:

  • Y — да
  • N — нет

catalog_price

Значение
тип

Описание

id
integer

Идентификатор цены

productId
catalog_product.id

Идентификатор товара

catalogGroupId
catalog_price_type.id

Идентификатор типа цены

price
double

Значение цены

priceScale
double

Цена, пересчитанная в базовую валюту по текущему курсу. Поле только для чтения

currency
string

Валюта цены

quantityFrom
double

Минимальное количество для применения цены. Устаревший параметр

quantityTo
double

Максимальное количество для применения цены. Устаревший параметр

extraId
catalog_extra.id

Идентификатор наценки. Устаревший параметр

timestampX
datetime

Дата изменения

catalog_price_type

Значение
тип

Описание

id
integer

Идентификатор типа цены

name
string

Код типа цены

base
string

Является ли тип цены базовым. Возможные значения:

  • Y — да
  • N — нет

Базовым может быть только один тип цены. Значение Y у другого типа снимает признак с прежнего базового типа

sort
integer

Сортировка. Значение, которое не является числом, сохраняется как 100

xmlId
string

Внешний код.

Можно использовать для синхронизации текущего типа цены с аналогичной позицией во внешней системе

timestampX
datetime

Дата изменения

createdBy
user.id

Кем создан

modifiedBy
user.id

Кем изменен

dateCreate
datetime

Дата создания

catalog_price_type_group

Значение
тип

Описание

id
integer

Идентификатор привязки типа цены к группе покупателей

catalogGroupId
catalog_price_type.id

Идентификатор типа цены

groupId
integer

Идентификатор группы покупателей

access
char

Тип доступа. Возможные значения:

  • Y — право на покупку по этому типу цены
  • N — право на просмотр этого типа цены

catalog_enum

Значение
тип

Описание

id
integer | string

Идентификатор элемента перечисления. Тип зависит от метода: у типов округления catalog.enum.getRoundTypes — число, у типов складских документов catalog.enum.getStoreDocumentTypes — строка

name
string

Название элемента перечисления

catalog_price_type_lang

Значение
тип

Описание

id
integer

Идентификатор перевода названия типа цены

catalogGroupId
catalog_price_type.id

Идентификатор типа цены

name
string

Перевод названия типа цены

lang
catalog_language.lid

Идентификатор языка

catalog_language

Значение
тип

Описание

lid
string

Идентификатор языка

name
string

Название языка

active
string

Признак активности. Возможные значения:

  • Y — да
  • N — нет

catalog_rounding_rule

Значение
тип

Описание

id
integer

Идентификатор правила округления цен

catalogGroupId
catalog_price_type.id

Тип цены

price
double

Минимальная цена для округления

roundType
integer

Тип округления. Возможные значения:

  • 1 — математическое округление
  • 2 — округление вверх (в пользу магазина)
  • 4 — округление вниз (в пользу клиента)

roundPrecision
double

Точность округления

createdBy
user.id

Кем создано

modifiedBy
user.id

Кем изменено

dateCreate
datetime

Дата создания

dateModify
datetime

Дата изменения

catalog_extra

Значение
тип

Описание

id
integer

Идентификатор наценки

name
string

Название наценки

percentage
double

Величина наценки в процентах

catalog_section

Значение
тип

Описание

id
integer

Идентификатор раздела каталога

iblockId
catalog_catalog.id

Идентификатор инфоблока.

Для получения существующих идентификаторов необходимо использовать catalog.catalog.list

iblockSectionId
catalog_section.id

Идентификатор родительского раздела.

Для получения существующих идентификаторов необходимо использовать catalog.section.list.

По умолчанию выбирается верхний уровень

name
string

Название раздела каталога

xmlId
string

Внешний идентификатор.

Можно использовать для синхронизации текущего раздела каталога с аналогичной позицией во внешней системе

code
string

Код раздела каталога

sort
integer

Сортировка

active
string

Индикатор активности раздела каталога:

  • Y — активен
  • N — неактивен

description
string

Описание

descriptionType
string

Тип описания. Доступные типы: text, html

catalog_storeproduct

Значение
тип

Описание

id
integer

Идентификатор записи остатка

productId
catalog_product.id

Идентификатор товара

storeId
catalog_store.id

Идентификатор склада

amount
double

Доступное количество товара. null, если не заполнено

quantityReserved
double

Количество товара в резерве. null, если не заполнено

catalog_vat

Значение
тип

Описание

id
integer

Идентификатор ставки НДС

name
string

Название ставки НДС

active
string

Индикатор активности ставки НДС. Возможные значения:

  • Y — активен
  • N — неактивен

rate
double

Величина ставки в процентах, например 22. У ставки без НДС значение null.

Верхняя граница значения не проверяется. Строка, которая не является числом, сохраняется как 0

sort
integer

Сортировка

timestampX
datetime

Время последнего изменения

Объекты, используемые в ответах

rest_field_description

Значение
тип

Описание

isImmutable
boolean

Индикатор возможности изменения значения поля после создания.

Если у поля выставлен данный индикатор, то при создании объекта можно указать значение поля, но изменить его при обновлении не получится

isReadOnly
boolean

Индикатор «только чтение».

Если у поля выставлен данный индикатор, то в операциях добавления и обновления объекта передавать значение поля не нужно. Значение формируется автоматически и предназначено только для чтения

isRequired
boolean

Индикатор обязательности поля для операций добавления или обновления

name
string

Название поля. Возвращается, если для поля доступно отображаемое название

type
string

Тип данных значений поля. Возможные значения:

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

isDynamic
boolean

Только для свойств каталога. true — поле является свойством каталога

isMultiple
boolean

Только для свойств каталога. true — свойство множественное

propertyType
string

Только для свойств каталога. Базовый тип свойства: S — строка, N — число, L — список, F — файл, E — привязка к элементам, G — привязка к разделам

userType
string

Только для свойств каталога. Пользовательский тип свойства, например directory или Date. Если тип не задан — null или пустая строка
Предыдущая
Обзор разделов
Следующая
Обзор методов