Add an Image to a Product v 3.0 catalog.product.image.add
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 "Edit product" 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.image.add method uploads an image and adds it to a product or variation.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object with the fields of the new image. Field description |
Parameter fields
|
Name |
Description |
|
productId* |
Product or variation identifier. The product identifier can be retrieved using the catalog.product.list method, the variation identifier — using the catalog.product.offer.list method |
|
type* |
Where to add the image. Possible values:
|
|
file* |
Image file. Object description |
Parameter file
|
Name |
Description |
|
upload* |
Data of the file being uploaded. Object description |
Object file.upload
|
Name |
Description |
|
name* |
File name with an extension, for example |
|
data |
File content in Base64 format. Pass either |
|
url |
A public link to the file. Bitrix24 downloads the file from the link. Pass either |
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.image.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"productId":7537,"type":"MORE_PHOTO","file":{"upload":{"name":"photo.png","data":"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg=="}}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.image.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ProductImageAddResult = {
item: {
id: number
productId: number
type: 'PREVIEW_PICTURE' | 'DETAIL_PICTURE' | 'MORE_PHOTO'
name: string
createTime: ISODate
detailUrl: string
downloadUrl: string
}
}
try {
const response = await $b24.actions.v3.call.make<ProductImageAddResult>({
method: 'catalog.product.image.add',
params: {
fields: {
productId: 7537,
type: 'MORE_PHOTO',
file: {
upload: {
name: 'photo.png',
data: 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
},
},
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Image added:', result.item.id, result.item.detailUrl)
}
} 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 addProductImage() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.product.image.add',
params: {
fields: {
productId: 7537,
type: 'MORE_PHOTO',
file: {
upload: {
name: 'photo.png',
data: 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
},
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Image added:', result.item.id, result.item.detailUrl)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addProductImage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.image.add(
fields={
"productId": 7537,
"type": "MORE_PHOTO",
"file": {
"upload": {
"name": "photo.png",
"data": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==",
},
},
},
).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.image.add',
[
'fields' => [
'productId' => 7537,
'type' => 'MORE_PHOTO',
'file' => [
'upload' => [
'name' => 'photo.png',
'data' => base64_encode(file_get_contents('photo.png')),
],
],
],
]
);
$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.image.add',
{
fields: {
productId: 7537,
type: 'MORE_PHOTO',
file: {
upload: {
name: 'photo.png',
data: 'iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==',
},
},
},
},
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.image.add',
[
'fields' => [
'productId' => 7537,
'type' => 'MORE_PHOTO',
'file' => [
'upload' => [
'name' => 'photo.png',
'data' => base64_encode(file_get_contents('photo.png')),
],
],
],
]
);
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.image.add", b24.Params{
"fields": b24.Params{
"productId": 7537,
"type": "MORE_PHOTO",
"file": b24.Params{
"upload": b24.Params{
"name": "photo.png",
"data": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAAFklEQVR4nGO4o6FBEmIY1TCqYfhqAAAyBCwQhvh37QAAAABJRU5ErkJggg==",
},
},
},
})
if err != nil {
return fmt.Errorf("catalog.product.image.add: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
var item struct {
ID int `json:"id"`
ProductID int `json:"productId"`
Type string `json:"type"`
DetailURL string `json:"detailUrl"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.DetailURL)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 39451,
"productId": 7537,
"type": "MORE_PHOTO",
"name": "photo.png",
"createTime": "2026-10-22T12:15:59+02:00",
"detailUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png",
"downloadUrl": "https://cdn-com.bitrix24.com/b1234567/catalog/c02/c020af94aac1804f57f3a5092b8cb4b4/b3759501f5e66f5238a54d2654a7b0cc.png"
}
},
"time": {
"start": 1792660559,
"finish": 1792660559.878817,
"duration": 0.878817081451416,
"processing": 0,
"date_start": "2026-10-22T12:15:59+02:00",
"date_finish": "2026-10-22T12:15:59+02:00",
"operating_reset_at": 1792661040,
"operating": 4.06761908531189
}
}
Returned Data
|
Name |
Description |
|
result |
Response data object |
|
result.item |
Fields of the added image. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Image identifier. Matches the file identifier in Bitrix24 |
|
productId |
Product or variation identifier |
|
type |
Image type: |
|
name |
File name |
|
createTime |
File upload date and time |
|
detailUrl |
Link to view the image |
|
downloadUrl |
Link to download the image |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_INVALIDFILEEXCEPTION",
"message": "REST_V3_EXCEPTION_VALIDATION_INVALIDFILEEXCEPTION",
"validation": [
{
"message": "File of invalid type.",
"field": "FILE_TYPE_NOT_ALLOWED"
}
]
}
}
|
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
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass |
|
|
Required field |
Pass |
|
|
Required field |
Pass the |
|
|
At least one of the required fields must be not empty |
Pass the |
|
|
Only one of the following values must be provided: data, url |
Keep only |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass |
|
|
Image product property does not exists. Create MORE_PHOTO property |
The catalog has no |
|
|
Could not save image. |
Repeat the request |
File Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_INVALIDFILEEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
File of invalid type |
Upload an image. Specify a file name with an image extension in |
|
|
Service response status code is 404 |
The file at the |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
The product was not found or does not belong to the trade catalog. Check the identifier using the catalog.product.list method |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass only |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Make sure the user has the "Edit product" permission and permission to edit the product in the information block |
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 |