Скачать файлы услуги v 3.0 catalog.product.service.download

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

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

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров», «Просмотр товаров каталога» или «Изменение цены продажи товара»

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.product.service.download возвращает данные файла услуги: имя, тип содержимого и ссылку на файл.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Объект с параметрами файла. Описание параметра

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

productId*
integer

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

Идентификатор можно получить методом catalog.product.service.list

fieldName*
string

Имя поля с файлом в верхнем регистре.

Возможные значения:

  • DETAIL_PICTURE — детальная картинка
  • PREVIEW_PICTURE — картинка для анонса
  • PROPERTY_{id} — свойство типа «Файл», где {id} — идентификатор свойства

Имена в формате detailPicture метод не принимает

fileId*
integer

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

Идентификатор возвращает метод catalog.product.service.get: в полях detailPicture и previewPicture или в ключе VALUE свойства типа «Файл»

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{user_id}/{токен_вебхука}/catalog.product.service.download

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"productId":7551,"fieldName":"DETAIL_PICTURE","fileId":39453}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.service.download
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"productId":7551,"fieldName":"DETAIL_PICTURE","fileId":39453},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.service.download
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type ServiceDownloadResult = {
  file: {
    id: number
    fileName: string
    contentType: string
    src: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<ServiceDownloadResult>({
    method: 'catalog.product.service.download',
    params: {
      fields: {
        productId: 7551,
        fieldName: 'DETAIL_PICTURE',
        fileId: 39453,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('File:', result.file.fileName, result.file.src)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function downloadServiceFile() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.product.service.download',
        params: {
          fields: {
            productId: 7551,
            fieldName: 'DETAIL_PICTURE',
            fileId: 39453,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('File:', result.file.fileName, result.file.src)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', downloadServiceFile)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.product.service.download(
        fields={
            "productId": 7551,
            "fieldName": "DETAIL_PICTURE",
            "fileId": 39453,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.product.service.download',
            [
                'fields' => [
                    'productId' => 7551,
                    'fieldName' => 'DETAIL_PICTURE',
                    'fileId' => 39453,
                ],
            ]
        );

    $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: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.product.service.download',
    {
        fields: {
            productId: 7551,
            fieldName: 'DETAIL_PICTURE',
            fileId: 39453,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.product.service.download',
    [
        'fields' => [
            'productId' => 7551,
            'fieldName' => 'DETAIL_PICTURE',
            'fileId' => 39453,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.service.download", b24.Params{
	"fields": b24.Params{
		"productId": 7551,
		"fieldName": "DETAIL_PICTURE",
		"fileId":    39453,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.product.service.download: %w", err)
}

var result struct {
	File struct {
		ID          int    `json:"id"`
		FileName    string `json:"fileName"`
		ContentType string `json:"contentType"`
		Src         string `json:"src"`
	} `json:"file"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(result.File.FileName, result.File.Src)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "file": {
            "id": 39453,
            "fileName": "montazh-detail.png",
            "contentType": "image/png",
            "src": "https://cdn-ru.bitrix24.ru/b1234567/iblock/0ca/0ca00fa1be74b9ef25c6759290ad85c5/montazh-detail.png"
        }
    },
    "time": {
        "start": 1792660776,
        "finish": 1792660776.659825,
        "duration": 0.6598250865936279,
        "processing": 0,
        "date_start": "2026-10-22T12:19:36+03:00",
        "date_finish": "2026-10-22T12:19:36+03:00",
        "operating_reset_at": 1792661340,
        "operating": 0
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект с данными ответа

result.file
object

Данные файла. Описание полей

time
time

Информация о времени выполнения запроса

Объект file

Название
тип

Описание

id
integer

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

fileName
string

Имя файла

contentType
string

MIME-тип файла, например image/png

src
string

Ссылка на файл

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Name file field is not available"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

Строковый код ошибки. Используйте для идентификации типа исключения

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

fields

Обязательное поле fields не указано

Передайте объект fields

-

Name file field is not available

Передайте в fieldName значение DETAIL_PICTURE, PREVIEW_PICTURE или PROPERTY_{id} свойства типа «Файл» в верхнем регистре

-

Product file wrong

Файла с таким идентификатором нет в указанном поле услуги. Проверьте fileId методом catalog.product.service.get

-

Product is empty

Файл не найден в хранилище. Проверьте fileId

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

Описание ошибки

Как исправить

-

Запись с ID = #ID# не найдена

Услуги с таким идентификатором нет или productId не передан. Ошибка приходит и для идентификатора товара другого типа

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP-статус: 403

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте права пользователя на просмотр каталога и чтение элементов инфоблока

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение