Delete Image from Product catalog.productImage.delete
Scope:
catalogWho can execute the method: administrator
This method removes an image from a product, parent product, variation, or service.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
productId* |
Identifier of the product, parent product, variation, or service. To obtain existing identifiers, use the following methods:
|
|
Identifier of the image |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"productId":1,"id":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productImage.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"productId":1,"id":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.productImage.delete
try
{
const response = await $b24.callMethod(
'catalog.productImage.delete',
{
productId: 1,
id: 1
}
);
const result = response.getData().result;
console.log(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.productImage.delete',
[
'productId' => 1,
'id' => 1
]
);
$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 deleting product image: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.productImage.delete',
{
productId: 1,
id: 1
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.productImage.delete',
[
'productId' => 1,
'id' => 1
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1729001588.54184,
"finish": 1729001589.40018,
"duration": 0.8583400249481201,
"processing": 0.4529080390930176,
"date_start": "2024-10-15T17:13:08+02:00",
"date_finish": "2024-10-15T17:13:09+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Result of the image deletion |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error":200040300020,
"error_description":"Access Denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
Insufficient permissions to modify the trade catalog |
|
|
Insufficient permissions to modify the product |
|
|
Parameter |
|
|
Parameter |
|
|
Product with the specified identifier not found |
|
|
Image with the specified identifier not found |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Image to Product catalog.productImage.add
- Get Information About Product Image catalog.productImage.get
- Get the list of product images catalog.productImage.list
- Get Product Image Fields catalog.productImage.getFields