Получить список услуг catalog.product.service.list
Scope:
catalogКто может выполнять метод: администратор
Метод возвращает список услуг по фильтру.
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_product_service). Обязательные поля: |
|
filter |
Объект для фильтрации выбранных услуг в формате Возможные значения для Обязательные поля: Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных услуг в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Работа с ценой услуг
Чтобы получить цены услуг, используйте методы catalog.price.*.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","iblockId","name","active","available","bundle","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","iblockSectionId","modifiedBy","previewPicture","previewText","previewTextType","sort","timestampX","type","vatId","vatIncluded","xmlId","property94","property95"],"filter":{"iblockId":23,">id":10,"vatId":[1,2]},"order":{"id":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.service.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","iblockId","name","active","available","bundle","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","iblockSectionId","modifiedBy","previewPicture","previewText","previewTextType","sort","timestampX","type","vatId","vatIncluded","xmlId","property94","property95"],"filter":{"iblockId":23,">id":10,"vatId":[1,2]},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.service.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'catalog.product.service.list',
{
"select": [
"id",
"iblockId",
"name",
"active",
"available",
"bundle",
"code",
"createdBy",
"dateActiveFrom",
"dateActiveTo",
"dateCreate",
"detailPicture",
"detailText",
"detailTextType",
"iblockSectionId",
"modifiedBy",
"previewPicture",
"previewText",
"previewTextType",
"sort",
"timestampX",
"type",
"vatId",
"vatIncluded",
"xmlId",
"property94",
"property95",
],
"filter": {
"iblockId": 23,
">id": 10,
"vatId": [1, 2],
},
"order": {
"id": "desc",
}
},
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('catalog.product.service.list', {
"select": [
"id",
"iblockId",
"name",
"active",
"available",
"bundle",
"code",
"createdBy",
"dateActiveFrom",
"dateActiveTo",
"dateCreate",
"detailPicture",
"detailText",
"detailTextType",
"iblockSectionId",
"modifiedBy",
"previewPicture",
"previewText",
"previewTextType",
"sort",
"timestampX",
"type",
"vatId",
"vatIncluded",
"xmlId",
"property94",
"property95",
],
"filter": {
"iblockId": 23,
">id": 10,
"vatId": [1, 2],
},
"order": {
"id": "desc",
}
}, 'id');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('catalog.product.service.list', {
"select": [
"id",
"iblockId",
"name",
"active",
"available",
"bundle",
"code",
"createdBy",
"dateActiveFrom",
"dateActiveTo",
"dateCreate",
"detailPicture",
"detailText",
"detailTextType",
"iblockSectionId",
"modifiedBy",
"previewPicture",
"previewText",
"previewTextType",
"sort",
"timestampX",
"type",
"vatId",
"vatIncluded",
"xmlId",
"property94",
"property95",
],
"filter": {
"iblockId": 23,
">id": 10,
"vatId": [1, 2],
},
"order": {
"id": "desc",
}
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
try {
$response = $b24Service
->core
->call(
'catalog.product.service.list',
[
'select' => [
'id',
'iblockId',
'name',
'active',
'available',
'bundle',
'code',
'createdBy',
'dateActiveFrom',
'dateActiveTo',
'dateCreate',
'detailPicture',
'detailText',
'detailTextType',
'iblockSectionId',
'modifiedBy',
'previewPicture',
'previewText',
'previewTextType',
'sort',
'timestampX',
'type',
'vatId',
'vatIncluded',
'xmlId',
'property94',
'property95',
],
'filter' => [
'iblockId' => 23,
'>id' => 10,
'vatId' => [1, 2],
],
'order' => [
'id' => 'desc',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error fetching product list: ' . $e->getMessage();
}
BX24.callMethod(
"catalog.product.service.list", {
"select": [
"id",
"iblockId",
"name",
"active",
"available",
"bundle",
"code",
"createdBy",
"dateActiveFrom",
"dateActiveTo",
"dateCreate",
"detailPicture",
"detailText",
"detailTextType",
"iblockSectionId",
"modifiedBy",
"previewPicture",
"previewText",
"previewTextType",
"sort",
"timestampX",
"type",
"vatId",
"vatIncluded",
"xmlId",
"property94",
"property95",
],
"filter": {
"iblockId": 23,
">id": 10,
"vatId": [1, 2],
},
"order": {
"id": "desc",
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.service.list',
[
'select' => [
'id',
'iblockId',
'name',
'active',
'available',
'bundle',
'code',
'createdBy',
'dateActiveFrom',
'dateActiveTo',
'dateCreate',
'detailPicture',
'detailText',
'detailTextType',
'iblockSectionId',
'modifiedBy',
'previewPicture',
'previewText',
'previewTextType',
'sort',
'timestampX',
'type',
'vatId',
'vatIncluded',
'xmlId',
'property94',
'property95',
],
'filter' => [
'iblockId' => 23,
'>id' => 10,
'vatId' => [1, 2],
],
'order' => [
'id' => 'desc',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"services": [
{
"active": "Y",
"available": "N",
"bundle": "N",
"code": "service",
"createdBy": 1,
"dateActiveFrom": "2024-05-28T10:00:00+03:00",
"dateActiveTo": "2024-05-29T10:00:00+03:00",
"dateCreate": "2024-05-27T10:00:00+03:00",
"detailPicture": {
"id": "6497",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6497\u0026fields%5BproductId%5D=1265",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6497\u0026fields%5BproductId%5D=1265"
},
"detailText": null,
"detailTextType": "text",
"iblockId": 23,
"iblockSectionId": 47,
"id": 1265,
"modifiedBy": 1,
"name": "Услуга",
"previewPicture": {
"id": "6496",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6496\u0026fields%5BproductId%5D=1265",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6496\u0026fields%5BproductId%5D=1265"
},
"previewText": null,
"previewTextType": "text",
"sort": 100,
"timestampX": "2024-06-14T11:59:04+03:00",
"type": 7,
"vatId": 1,
"vatIncluded": "Y",
"xmlId": "1265"
}
]
},
"total": 1,
"time": {
"start": 1718363637.281945,
"finish": 1718363637.984081,
"duration": 0.7021360397338867,
"processing": 0.2966270446777344,
"date_start": "2024-06-14T14:13:57+03:00",
"date_finish": "2024-06-14T14:13:57+03:00"
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
services |
Массив объектов с информацией о выбранных услугах |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения торгового каталога |
|
|
Не указаны поля |
|
|
Не указано поле |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить услугу catalog.product.service.add
- Обновить поля услуги catalog.product.service.update
- Получить значения полей услуги catalog.product.service.get
- Скачать файлы услуги catalog.product.service.download
- Удалить услугу catalog.product.service.delete
- Получить поля услуги по фильтру catalog.product.service.getFieldsByFilter