Скачать файлы вариации товара catalog.product.offer.download

Scope: catalog

Кто может выполнять метод: администратор

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

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

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

Название
тип

Описание

fields*
object

Значения полей для скачивания файлов вариации товара

Параметр fields

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

Название
тип

Описание

fileId*
integer

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

Для получения идентификаторов файлов вариации товара необходимо использовать catalog.product.offer.get либо catalog.product.offer.list

productId*
catalog_product_offer.id

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

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

fieldName*
string

Имя поля (свойства или поля элемента информационного блока), в котором хранится файл. Возможные значения:

  • DETAIL_PICTURE — детальная картинка, поле доступно в старой карточке товара
  • PREVIEW_PICTURE — картинка для анонса, поле доступно в старой карточке товара
  • PROPERTY_N — свойство, где N — идентификатор свойства либо код свойства

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

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"fileId":6538,"productId":1286,"fieldName":"detailPicture"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.offer.download
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"fileId":6538,"productId":1286,"fieldName":"detailPicture"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.product.offer.download
        
try
        {
        	const response = await $b24.callMethod(
        		'catalog.product.offer.download',
        		{
        			fields: {
        				fileId: 6538,
        				productId: 1286,
        				fieldName: 'detailPicture',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.product.offer.download',
                    [
                        'fields' => [
                            'fileId'     => 6538,
                            'productId'  => 1286,
                            'fieldName'  => 'detailPicture',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error downloading product offer: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.product.offer.download',
            {
                fields: {
                    fileId: 6538,
                    productId: 1286,
                    fieldName: 'detailPicture',
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.product.offer.download',
            [
                'fields' => [
                    'fileId' => 6538,
                    'productId' => 1286,
                    'fieldName' => 'detailPicture'
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

В качестве ответа приходит файл по переданным параметрам.

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

Возвращается файл по переданным параметрам.

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

HTTP-статус: 400

{	
            "error":0,
            "error_description":"Required fields: fileId"
        }

Название
тип

Описание

error
string

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

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

200040300010

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

0

Вариация товара с указанным идентификатором не существует

0

Указанное свойство не существует либо не является файловым

0

Файл с указанным идентификатором не существует

0

Не переданы обязательные поля

0

Другие ошибки (например, фатальные ошибки)

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

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

Описание

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

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

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

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

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

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

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

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

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

Предыдущая
Получить список вариаций товара
Следующая
Удалить вариацию товара