Download Service Files v 3.0 catalog.product.service.download
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: a user with the "View product catalog", "View catalog products", or "Edit selling price" permission
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The catalog.product.service.download method returns the data of a service file: the name, the content type, and the file link.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object with the file parameters. Parameter description |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
productId* |
Service identifier. The identifier can be retrieved using the catalog.product.service.list method |
|
fieldName* |
Name of the file field in uppercase. Possible values:
The method does not accept names in the |
|
fileId* |
File identifier. The identifier is returned by the catalog.product.service.get method: in the |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or 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();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or 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());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or 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 and ctx are already created — see the Go SDK section
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("parse response: %w", err)
}
fmt.Println(result.File.FileName, result.File.Src)
Response Handling
HTTP status: 200
{
"result": {
"file": {
"id": 39453,
"fileName": "montazh-detail.png",
"contentType": "image/png",
"src": "https://cdn-com.bitrix24.com/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+02:00",
"date_finish": "2026-10-22T12:19:36+02:00",
"operating_reset_at": 1792661340,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object with the response data |
|
result.file |
File data. Field description |
|
time |
Information about the request execution time |
File Object
|
Name |
Description |
|
id |
File identifier |
|
fileName |
File name |
|
contentType |
MIME type of the file, for example |
|
src |
File link |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating request object.",
"validation": [
{
"message": "Name file field is not available"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
Name file field is not available |
Pass |
|
|
Product file wrong |
There is no file with this identifier in the specified service field. Check |
|
|
Product is empty |
The file was not found in the storage. Check |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
There is no service with this identifier, or |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Check the user's permissions to view the catalog and read information block elements |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |