Get the list of product images catalog.productImage.list
Scope:
catalogWho can execute the method: administrator
The method returns a list of product images, parent product images, variations, or services.
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:
|
|
select |
An array with a list of fields to select (see fields of the object catalog_product_image) |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"productId":1,"select":["id","name","productId","type","createTime","downloadUrl","detailUrl"]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productImage.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"productId":1,"select":["id","name","productId","type","createTime","downloadUrl","detailUrl"],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.productImage.list
// callListMethod: Retrieves all data at once. Use only for small selections (< 1000 items) due to high memory usage.
try {
const response = await $b24.callListMethod(
'catalog.productImage.list',
{
productId: 1,
select: [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl',
],
},
(progress) => { console.log('Progress:', progress) }
)
const items = response.getData() || []
for (const entity of items) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
// fetchListMethod: Retrieves data in parts using an iterator. Use it for large data volumes to optimize memory usage.
try {
const generator = $b24.fetchListMethod('catalog.productImage.list', { productId: 1, select: ['id', 'name', 'productId', 'type', 'createTime', 'downloadUrl', 'detailUrl'] }, 'ID')
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error) {
console.error('Request failed', error)
}
// callMethod: Manually controls pagination through the start parameter. Use it for precise control of request batches. For large datasets, it is less efficient than fetchListMethod.
try {
const response = await $b24.callMethod('catalog.productImage.list', { productId: 1, select: ['id', 'name', 'productId', 'type', 'createTime', 'downloadUrl', 'detailUrl'] }, 0)
const result = response.getData().result || []
for (const entity of result) { console.log('Entity:', entity) }
} catch (error) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'catalog.productImage.list',
[
'productId' => 1,
'select' => [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your logic for processing data
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error listing product images: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.productImage.list',
{
productId: 1,
select: [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl',
],
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
result.next();
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.productImage.list',
[
'productId' => 1,
'select' => [
'id',
'name',
'productId',
'type',
'createTime',
'downloadUrl',
'detailUrl'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": {
"productImages": [
{
"createTime": "2024-10-17T10:48:05+02:00",
"detailUrl": "\/upload\/iblock\/6f1\/bkm7jmwso31wisk423gtp28iagy2e8v0\/test.jpeg",
"downloadUrl": "http:\/\/dev.bx\/rest\/download.json?sessid=ae1ada0e5c85babd18ce4af4c702d1d9\u0026token=catalog%7CaWQ9NzY1MSZfPTEzSk9hR2tKNHBRY1I2cFBPNjhvaTFHNTNiYjVsVmdx%7CImRvd25sb2FkfGNhdGFsb2d8YVdROU56WTFNU1pmUFRFelNrOWhSMnRLTkhCUlkxSTJjRkJQTmpodmFURkhOVE5pWWpWc1ZtZHh8YWUxYWRhMGU1Yzg1YmFiZDE4Y2U0YWY0YzcwMmQxZDki.iC0Yzi9feK8V1Zr0WSlp5GZpcmD0osnJGHN%2FZL%2FkQI4%3D",
"id": 1,
"name": "test.jpeg",
"productId": 1,
"type": "MORE_PHOTO"
}
]
},
"total": 1,
"time": {
"start": 1729163241.324569,
"finish": 1729163241.860237,
"duration": 0.535667896270752,
"processing": 0.19502019882202148,
"date_start": "2024-10-17T14:07:21+02:00",
"date_finish": "2024-10-17T14:07:21+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
productImages |
Array of objects with information about the selected product images |
|
total |
Total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":200040300010,
"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 rights to view the trade catalog |
|
|
Insufficient rights to view the product |
|
|
The |
|
|
The product with the specified identifier was 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 Exploring
- Add Image to Product catalog.productImage.add
- Get Information About Product Image catalog.productImage.get
- Delete Image from Product catalog.productImage.delete
- Get Product Image Fields catalog.productImage.getFields