Get Service Field Values v 3.0 catalog.product.service.get

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: catalog

Who can execute the method: a user with the "View product catalog", "View catalog products", or "Edit selling price" 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.service.get method returns the service fields by identifier.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Service identifier.

The identifier can be retrieved using the catalog.product.service.list method

select
array

An array of service fields to return in the response.

Available fields:

id — service identifier
iblockId — information block identifier
name — name
code — symbolic code
xmlId — external code
active — activity status
sort — sort order
createdBy — created by
modifiedBy — modified by
dateCreate — creation date
timestampX — modification date
dateActiveFrom — activity start
dateActiveTo — activity end
previewText — preview description
previewTextType — preview description type
previewPicture — preview picture
detailText — detail description
detailTextType — detail description type
detailPicture — detail picture
iblockSectionId — main section
iblockSection — all sections
type — product type
available — available for purchase
bundle — set flag
quantity — quantity
quantityReserved — reserved quantity
quantityTrace — quantity tracking
canBuyZero — out-of-stock purchase
subscribe — subscription
vatId — VAT rate
vatIncluded — VAT included in the price
purchasingPrice — purchase price
purchasingCurrency — purchase price currency
barcodeMulti — unique barcodes
weight — weight
length — length
width — width
height — height
measure — unit of measurement
recurSchemeLength — payment period length
recurSchemeType — payment period unit
trialPriceId — product for a trial payment
withoutOrder — renewal without an order
quantityTraceRaw — saved tracking mode
paymentType — payment type
subscribeRaw — saved subscription permission
canBuyZeroRaw — saved out-of-stock purchase permission
properties — property values

Property values are returned only as a whole in the properties field; individual PROPERTY_{id} keys cannot be passed in select. The ["*"] value is not supported. The id field is returned only if it is specified in select.

Default: all fields

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.service.get

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7551,"select":["id","name","xmlId","active","type","iblockSectionId","vatId","vatIncluded","measure","detailPicture"]}' \
        https://**put_your_bitrix24_address**/rest/api/**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":7551,"select":["id","name","xmlId","active","type","iblockSectionId","vatId","vatIncluded","measure","detailPicture"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.service.get

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ServiceGetResult = {
          item: {
            id: number
            iblockId: number
            name: string
            xmlId: string | null
            active: 'Y' | 'N'
            sort: number
            type: number
            iblockSectionId: number | null
            vatId: number | null
            vatIncluded: 'Y' | 'N'
            measure: number | null
            previewText: string | null
            detailPicture: string | null
            timestampX: ISODate
            properties: Record<string, { VALUE: string, VALUE_ID: string } | Array<{ VALUE: string, VALUE_ID: string }> | null>
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<ServiceGetResult>({
            method: 'catalog.product.service.get',
            params: {
              id: 7551,
              select: [
                'id',
                'name',
                'xmlId',
                'active',
                'type',
                'iblockSectionId',
                'vatId',
                'vatIncluded',
                'measure',
                'detailPicture',
              ],
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Service:', result.item.id, result.item.name)
          }
        } 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 getService() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.service.get',
                params: {
                  id: 7551,
                  select: [
                    'id',
                    'name',
                    'xmlId',
                    'active',
                    'type',
                    'iblockSectionId',
                    'vatId',
                    'vatIncluded',
                    'measure',
                    'detailPicture',
                  ],
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Service:', result.item.id, result.item.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', getService)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.service.get(
                bitrix_id=7551,
                select=[
                    "id",
                    "name",
                    "xmlId",
                    "active",
                    "type",
                    "iblockSectionId",
                    "vatId",
                    "vatIncluded",
                    "measure",
                    "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}")

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.service.get',
                    [
                        'id' => 7551,
                        'select' => [
                            'id',
                            'name',
                            'xmlId',
                            'active',
                            'type',
                            'iblockSectionId',
                            'vatId',
                            'vatIncluded',
                            'measure',
                            'detailPicture',
                        ],
                    ]
                );
        
            $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.service.get',
            {
                id: 7551,
                select: [
                    'id',
                    'name',
                    'xmlId',
                    'active',
                    'type',
                    'iblockSectionId',
                    'vatId',
                    'vatIncluded',
                    'measure',
                    'detailPicture',
                ],
            },
            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.service.get',
            [
                'id' => 7551,
                'select' => [
                    'id',
                    'name',
                    'xmlId',
                    'active',
                    'type',
                    'iblockSectionId',
                    'vatId',
                    'vatIncluded',
                    'measure',
                    '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.service.get", b24.Params{
        	"id":     7551,
        	"select": []string{"id", "name", "xmlId", "active", "type", "iblockSectionId", "vatId", "vatIncluded", "measure", "detailPicture"},
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("catalog.product.service.get: %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"`
        	Name    string `json:"name"`
        	Type    int    `json:"type"`
        	Measure int    `json:"measure"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.Type)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 7551,
                    "name": "Equipment installation and setup",
                    "xmlId": "DOCS-V3-SERVICE-1",
                    "active": "Y",
                    "detailPicture": "39453",
                    "iblockSectionId": 45,
                    "type": 7,
                    "vatId": 1,
                    "vatIncluded": "Y",
                    "measure": 9
                }
            },
            "time": {
                "start": 1792660775,
                "finish": 1792660775.911054,
                "duration": 0.9110538959503174,
                "processing": 0,
                "date_start": "2026-10-22T12:19:35+02:00",
                "date_finish": "2026-10-22T12:19:35+02:00",
                "operating_reset_at": 1792661340,
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	An object with the response data
result.item `object`	Service fields. The content depends on `select`. Field description
time `time`	Information about the request execution time

Item Object

Name `type`	Description
id `integer`	Service identifier
iblockId `integer`	Identifier of the trade catalog information block
name `string`	Name of the service
code `string`	Symbolic code
xmlId `string`	External code. If the code was not passed on creation, it equals the service identifier
active `string`	Service activity status: `Y` — active, `N` — inactive
sort `integer`	Sort order
createdBy `integer`	Identifier of the user who created the service
modifiedBy `integer`	Identifier of the user who last modified the service
dateCreate `datetime`	Creation date and time
timestampX `datetime`	Date and time of the last modification
dateActiveFrom `datetime`	Activity start date
dateActiveTo `datetime`	Activity end date
previewText `string`	Preview description
previewTextType `string`	Preview description type: `text` or `html`
previewPicture `string`	Preview picture file identifier as a string. `null` if there is no picture
detailText `string`	Detail description
detailTextType `string`	Detail description type: `text` or `html`
detailPicture `string`	Detail picture file identifier as a string. `null` if there is no picture. The file can be retrieved using the catalog.product.service.download method
iblockSectionId `integer`	Main section identifier. `null` if the service is not linked to a section
iblockSection `array`	An array of identifiers of all sections the service is linked to
type `integer`	Product type. Always `7` for a service
available `string`	Available for purchase: `Y` — yes, `N` — no
bundle `string`	Set flag: `Y` — yes, `N` — no
quantity `double`	Quantity
quantityReserved `double`	Reserved quantity
quantityTrace `string`	Effective quantity tracking mode, taking the catalog settings into account: `Y` — enabled, `N` — disabled
canBuyZero `string`	Effective out-of-stock purchase permission, taking the catalog settings into account: `Y` — yes, `N` — no
subscribe `string`	Effective subscription permission, taking the catalog settings into account: `Y` — yes, `N` — no
vatId `integer`	VAT rate identifier. `null` if no rate is set
vatIncluded `string`	VAT is included in the price: `Y` — yes, `N` — no
purchasingPrice `double`	Purchase price. `null` if not set
purchasingCurrency `string`	Purchase price currency. `null` if not set
barcodeMulti `string`	Unique barcodes for each item: `Y` — yes, `N` — no
weight `double`	Weight
length `double`	Length. `null` if not set
width `double`	Width. `null` if not set
height `double`	Height. `null` if not set
measure `integer`	Unit of measurement identifier
recurSchemeLength `integer`	Payment period length. Used for content sales in the on-premise version
recurSchemeType `string`	Time unit of the payment period, for example `D` — day. Used for content sales in the on-premise version
trialPriceId `integer`	Identifier of the product for a trial payment. Used for content sales in the on-premise version
withoutOrder `string`	Renewal without placing an order: `Y` — yes, `N` — no
quantityTraceRaw `string`	Saved value of the quantity tracking mode: `Y`, `N`, or `D` — according to the catalog settings
paymentType `string`	Payment type: `S` — one-time, `R` — recurring, `T` — trial
subscribeRaw `string`	Saved value of the subscription permission: `Y`, `N`, or `D` — according to the catalog settings
canBuyZeroRaw `string`	Saved value of the out-of-stock purchase permission: `Y`, `N`, or `D` — according to the catalog settings
properties `object`	Service property values. The keys are `PROPERTY_{id}`, where `{id}` is the property identifier. A property value is an object `{"VALUE": "...", "VALUE_ID": "..."}`, and for a multiple property it is an array of such objects. `null` if no value is set

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
                "message": "Entity with ID 999999 was not found."
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	Description of the error related to the specified field

Possible Error Codes

Request Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Field	Error description	How to Fix
`id`	Required field `id` is missing	Pass a positive number in `id`

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`id`	Entity with ID `#ID#` was not found	There is no service with this identifier. The error is also returned for the identifier of a product of another type. Check the identifier using the catalog.product.service.list method

Errors in the `select` Parameter

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`select`	Unknown field `#FIELD#` found in entity `ProductDto`	Pass only the fields from the `select` parameter description in `select`

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP status: 403

Field	Error description	How to Fix
`-`	Access denied	Check the user's permissions to view the catalog and read information block elements

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Was the article helpful?

Get Service Field Values

Get List of Services

Get Service Field Values v 3.0 catalog.product.service.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Item ObjectItem Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Not Found ErrorObject Not Found Error

Errors in the ParameterErrors in the select Parameter

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Item Object

Error Handling

Possible Error Codes

Request Validation Errors

Object Not Found Error

Errors in the `select` Parameter

Access Error

Statuses and System Error Codes

Continue Learning