Get Service Field Values catalog.product.service.get
Scope:
catalogWho can execute the method: administrator
The method returns the field values of the service by its identifier.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the service. To obtain service identifiers, use catalog.product.service.list |
Working with Service Prices
To get service prices, use the methods catalog.price.*.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1265}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.service.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1265,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.product.service.get
try
{
const response = await $b24.callMethod(
'catalog.product.service.get', {
id: 1265
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.product.service.get',
[
'id' => 1265
]
);
$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 getting product service: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.product.service.get', {
id: 1265
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.product.service.get',
[
'id' => 1265
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": {
"service": {
"active": "Y",
"available": "N",
"bundle": "N",
"code": "service",
"createdBy": 1,
"dateActiveFrom": "2024-05-28T10:00:00+02:00",
"dateActiveTo": "2024-05-29T10:00:00+02:00",
"dateCreate": "2024-05-27T10:00:00+02:00",
"detailPicture": {
"id": "6497",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6497\u0026fields%5BproductId%5D=1265",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6497\u0026fields%5BproductId%5D=1265"
},
"detailText": null,
"detailTextType": "text",
"iblockId": 23,
"iblockSectionId": 47,
"id": 1265,
"modifiedBy": 1,
"name": "Service",
"previewPicture": {
"id": "6496",
"url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6496\u0026fields%5BproductId%5D=1265",
"urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6496\u0026fields%5BproductId%5D=1265"
},
"previewText": null,
"previewTextType": "text",
"property258": {
"value": "test",
"valueId": "9809"
},
"property259": [
{
"value": "test1",
"valueId": "9810"
},
{
"value": "test2",
"valueId": "9811"
}
],
"sort": 100,
"timestampX": "2024-06-14T11:59:04+02:00",
"type": 7,
"vatId": 1,
"vatIncluded": "Y",
"xmlId": "1265"
}
},
"time": {
"start": 1718363239.355821,
"finish": 1718363240.027938,
"duration": 0.6721169948577881,
"processing": 0.2661628723144531,
"date_start": "2024-06-14T14:07:19+02:00",
"date_finish": "2024-06-14T14:07:20+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
service |
Object containing service information |
|
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 |
|
|
The information block with the specified identifier does not exist |
|
|
Insufficient rights to read the information block element |
|
|
Insufficient rights to read the trade catalog |
|
|
The |
|
|
The service does not exist |
|
|
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 Service catalog.product.service.add
- Update Service Fields catalog.product.service.update
- Get the list of services catalog.product.service.list
- Download Files for Service catalog.product.service.download
- Delete Service catalog.product.service.delete
- Get Service Fields by Filter catalog.product.service.getFieldsByFilter