Получить поля товара по фильтру catalog.product.getFieldsByFilter
Scope:
catalogКто может выполнять метод: администратор
Метод получает поля товара по фильтру.
Параметры
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter* |
Фильтр для получения всех полей товара |
Параметр filter
Обязательные параметры отмечены *
|
Название |
Описание |
|
iblockId* |
Идентификатор информационного блока. Для получения существующих идентификаторов информационных блоков необходимо использовать catalog.catalog.list |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":23}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.getFieldsByFilter
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":{"iblockId":23},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.getFieldsByFilter
try
{
const response = await $b24.callMethod(
'catalog.product.getFieldsByFilter',
{
filter: {
iblockId: 23,
}
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.product.getFieldsByFilter',
[
'filter' => [
'iblockId' => 23,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting product fields by filter: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.product.getFieldsByFilter',
{
filter: {
iblockId: 23,
}
},
function(result) {
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.getFieldsByFilter',
[
'filter' => [
'iblockId' => 23
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"product": {
"active": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Активность",
"type": "char"
},
"available": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "Доступность к покупке",
"type": "char"
},
"bundle": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "Наличие набора",
"type": "char"
},
"canBuyZero": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Разрешение покупки при отсутствии товара",
"type": "char"
},
"code": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Символьный код",
"type": "string"
},
"createdBy": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Кто создал",
"type": "integer"
},
"dateActiveFrom": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "DATE_ACTIVE_FROM",
"type": "datetime"
},
"dateActiveTo": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "DATE_ACTIVE_TO",
"type": "datetime"
},
"dateCreate": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Дата создания",
"type": "datetime"
},
"detailPicture": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Детальная картинка",
"type": "file"
},
"detailText": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Детальное описание",
"type": "string"
},
"detailTextType": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Тип детального описания",
"type": "string"
},
"height": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Высота",
"type": "double"
},
"iblockId": {
"isImmutable": true,
"isReadOnly": false,
"isRequired": true,
"name": "Идентификатор инфоблока",
"type": "integer"
},
"iblockSectionId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Основной раздел",
"type": "integer"
},
"id": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "Идентификатор",
"type": "integer"
},
"length": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Длина",
"type": "double"
},
"measure": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Единица измерения",
"type": "integer"
},
"modifiedBy": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Кто изменил",
"type": "integer"
},
"name": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": true,
"name": "Наименование",
"type": "string"
},
"negativeAmountTrace": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "NEGATIVE_AMOUNT_TRACE",
"type": "char"
},
"previewPicture": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Картинка анонса",
"type": "file"
},
"previewText": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Описание для анонса",
"type": "string"
},
"previewTextType": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Тип описания для анонса",
"type": "string"
},
"priceType": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Тип оплаты",
"type": "char"
},
"property258": {
"isDynamic": true,
"isImmutable": false,
"isMultiple": false,
"isReadOnly": false,
"isRequired": false,
"name": "Новая строка",
"propertyType": "S",
"type": "productproperty",
"userType": ""
},
"property259": {
"isDynamic": true,
"isImmutable": false,
"isMultiple": true,
"isReadOnly": false,
"isRequired": false,
"name": "Новая строка 2",
"propertyType": "S",
"type": "productproperty",
"userType": ""
},
"purchasingCurrency": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Валюта закупочной цены",
"type": "string"
},
"purchasingPrice": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Закупочная цена",
"type": "string"
},
"quantity": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Доступное количество",
"type": "double"
},
"quantityReserved": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Зарезервированное количество",
"type": "double"
},
"quantityTrace": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Режим количественного учета",
"type": "char"
},
"sort": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Индекс сортировки",
"type": "integer"
},
"subscribe": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Разрешение подписки на товар",
"type": "char"
},
"timestampX": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Дата изменения",
"type": "datetime"
},
"type": {
"isImmutable": false,
"isReadOnly": true,
"isRequired": false,
"name": "Тип товара",
"type": "integer"
},
"vatId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Идентификатор НДС",
"type": "integer"
},
"vatIncluded": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "НДС включен в цену",
"type": "char"
},
"weight": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Вес",
"type": "double"
},
"width": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Ширина",
"type": "double"
},
"xmlId": {
"isImmutable": false,
"isReadOnly": false,
"isRequired": false,
"name": "Внешний код",
"type": "string"
}
}
},
"time": {
"start": 1717598883.81413,
"finish": 1717598884.460406,
"duration": 0.6462759971618652,
"processing": 0.15173888206481934,
"date_start": "2024-06-05T17:48:03+03:00",
"date_finish": "2024-06-05T17:48:04+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
product |
Объект в формате |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access Denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения торгового каталога |
|
|
Не указан или пустой параметр filter |
|
|
Не указан идентификатор информационного блока |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить товар catalog.product.add
- Обновить товар catalog.product.update
- Получить товар по идентификатору catalog.product.get
- Получить список товаров по фильтру catalog.product.list
- Скачать файлы товара catalog.product.download
- Удалить товар catalog.product.delete