Download Parent Product Files catalog.product.sku.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" access permission and the permission to read the catalog information block element
The catalog.product.sku.download method returns a parent product file: the preview image, the detailed image, or a file from a "File" type property.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Parameters of the file to download (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
fileId* |
File identifier. You can retrieve the identifier using the catalog.product.sku.get method: it is the |
|
productId* |
Identifier of the parent product. You can retrieve parent product identifiers using the catalog.product.sku.list method |
|
fieldName* |
Name of the field that stores the file. Pass the name in camelCase:
The method rejects uppercase names, such as You can retrieve property identifiers using the catalog.product.sku.getFieldsByFilter method: for file properties, |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"fileId":40051,"productId":7679,"fieldName":"detailPicture"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.sku.download
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"fileId":40051,"productId":7679,"fieldName":"detailPicture"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.sku.download
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'catalog.product.sku.download',
params: {
fields: {
fileId: 40051,
productId: 7679,
fieldName: 'detailPicture',
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info(result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function downloadProductSku() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.product.sku.download',
params: {
fields: {
fileId: 40051,
productId: 7679,
fieldName: 'detailPicture',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info(result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', downloadProductSku)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.sku.download(
fields={
"fileId": 40051,
"productId": 7679,
"fieldName": "detailPicture",
},
).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}")
try {
$response = $b24Service
->core
->call(
'catalog.product.sku.download',
[
'fields' => [
'fileId' => 40051,
'productId' => 7679,
'fieldName' => 'detailPicture',
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.product.sku.download',
{
fields: {
fileId: 40051,
productId: 7679,
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.sku.download',
[
'fields' => [
'fileId' => 40051,
'productId' => 7679,
'fieldName' => 'detailPicture'
]
]
);
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.sku.download", b24.Params{
"fields": b24.Params{
"fileId": 40051,
"productId": 7679,
"fieldName": "detailPicture",
},
})
if err != nil {
return fmt.Errorf("catalog.product.sku.download: %w", err)
}
// The response arrives as json.RawMessage — unmarshal it
// into a struct matching the response shape shown below on this page.
fmt.Printf("%s\n", res.Result)
Response Handling
HTTP status: 200
The method returns the file itself, not JSON. The Content-Type header matches the file type, for example image/png, and the file name is passed in the Content-Disposition header.
Returned Data
The file content. Save the response body to a file with the name from the Content-Disposition header.
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Product file wrong"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access Denied |
The user does not have a permission to view the catalog |
|
|
|
Access Denied |
The user does not have the permission to read the catalog information block element |
|
|
Empty value |
sku does not exist. |
No product exists with the specified |
|
|
|
Could not find value for parameter |
The |
|
|
|
Required fields: fileId |
The |
|
|
|
Name file field is not available |
|
|
|
|
Product file wrong |
The |
|
|
|
Product is empty |
No file exists with the specified |
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 |
Continue Learning
- Add Parent Product catalog.product.sku.add
- Update Parent Product Fields catalog.product.sku.update
- Get Parent Product Field Values catalog.product.sku.get
- Get List of Parent Products catalog.product.sku.list
- Delete Parent Product catalog.product.sku.delete
- Get Parent Product Fields by Filter catalog.product.sku.getFieldsByFilter