Получить список изображений товара catalog.productImage.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: администратор
Метод возвращает список изображений товара, головного товара, вариации или услуги.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
productId* |
Идентификатор товара, головного товара, вариации или услуги. Чтобы получить существующие идентификаторы, используйте следующие методы:
|
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_product_image) |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"productId":1,"select":["id","name","productId","type","createTime","downloadUrl","detailUrl"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productImage.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"productId":1,"select":["id","name","productId","type","createTime","downloadUrl","detailUrl"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.productImage.list
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
try {
const response = await $b24.callListMethod(
'catalog.productImage.list',
{
productId: 1,
select: [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl',
],
},
(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.productImage.list', { productId: 1, select: ['id', 'name', 'productId', 'type', 'createTime', 'downloadUrl', 'detailUrl'] }, '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.productImage.list', { productId: 1, select: ['id', 'name', 'productId', 'type', 'createTime', 'downloadUrl', 'detailUrl'] }, 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.productImage.list',
[
'productId' => 1,
'select' => [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing product images: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.productImage.list',
{
productId: 1,
select: [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl',
],
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
result.next();
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.productImage.list',
[
'productId' => 1,
'select' => [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"result": {
"productImages": [
{
"createTime": "2024-10-17T10:48:05+03:00",
"detailUrl": "\/upload\/iblock\/6f1\/bkm7jmwso31wisk423gtp28iagy2e8v0\/test.jpeg",
"downloadUrl": "http:\/\/dev.bx\/rest\/download.json?sessid=ae1ada0e5c85babd18ce4af4c702d1d9\u0026token=catalog%7CaWQ9NzY1MSZfPTEzSk9hR2tKNHBRY1I2cFBPNjhvaTFHNTNiYjVsVmdx%7CImRvd25sb2FkfGNhdGFsb2d8YVdROU56WTFNU1pmUFRFelNrOWhSMnRLTkhCUlkxSTJjRkJQTmpodmFURkhOVE5pWWpWc1ZtZHh8YWUxYWRhMGU1Yzg1YmFiZDE4Y2U0YWY0YzcwMmQxZDki.iC0Yzi9feK8V1Zr0WSlp5GZpcmD0osnJGHN%2FZL%2FkQI4%3D",
"id": 1,
"name": "test.jpeg",
"productId": 1,
"type": "MORE_PHOTO"
}
]
},
"total": 1,
"time": {
"start": 1729163241.324569,
"finish": 1729163241.860237,
"duration": 0.535667896270752,
"processing": 0.19502019882202148,
"date_start": "2024-10-17T14:07:21+03:00",
"date_finish": "2024-10-17T14:07:21+03:00",
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
productImages |
Массив объектов с информацией о выбранных изображениях товара |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300010,
"error_description":"Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для просмотра торгового каталога |
|
|
Недостаточно прав для просмотра товара |
|
|
Не указан или пустой параметр |
|
|
Товар с указанным идентификатором не найден |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить изображение в товар catalog.productImage.add
- Получить информацию об изображении товара catalog.productImage.get
- Удалить изображение из товара catalog.productImage.delete
- Получить поля изображения товара catalog.productImage.getFields