Получить список типов цен по фильтру v 3.0 catalog.pricetype.list

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров» или «Управление типами цен»

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.pricetype.list возвращает список типов цен по фильтру.

В REST 3.0 имя метода пишется в нижнем регистре: catalog.pricetype.list. Вызов catalog.priceType.list по адресу /rest/api/ возвращает ошибку BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION.

Параметры метода

Название `тип`	Описание
select `array`	Массив полей типа цены, которые нужно вернуть в ответе. Доступные поля: `id` — идентификатор типа цены `name` — название `base` — признак базового типа цены `sort` — сортировка `xmlId` — внешний код `timestampX` — дата и время последнего изменения `modifiedBy` — идентификатор пользователя, который последним изменил тип цены `dateCreate` — дата и время создания `createdBy` — идентификатор пользователя, который создал тип цены Поле `id` возвращается всегда, даже если его нет в `select`. Значение `["*"]` не поддерживается. По умолчанию: все поля
filter `array`	Фильтр в формате REST 3.0: массив условий вида `["поле", "оператор", "значение"]`. Фильтровать можно по всем полям из `select`. Для `base` передавайте `true` или `false`. Синтаксис и операторы описаны в обзоре REST 3.0
order `object`	Сортировка в формате `{"поле": "направление"}`. Сортировать можно по всем полям из `select`. Возможные значения направления: `ASC` — по возрастанию `DESC` — по убыванию По умолчанию: `{"id": "ASC"}`
pagination `object`	Объект постраничной навигации. Описание структуры объекта

Параметр pagination

Название `тип`	Описание
limit `integer`	Количество типов цен на странице. Значения больше `1000` уменьшаются до `1000`. Ноль вызывает ошибку. По умолчанию: `50`
page `integer`	Номер страницы, начиная с `1`. Смещение вычисляется как `(page - 1) × limit`
offset `integer`	Количество типов цен, которые нужно пропустить от начала списка. По умолчанию: `0`

Ответ не содержит общего количества типов цен. Если на странице вернулось меньше типов цен, чем указано в limit, это последняя страница.

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.pricetype.list

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 '{"select":["id","name","base","sort"],"filter":[["base","=",false]],"order":{"sort":"asc"},"pagination":{"limit":2}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.pricetype.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","base","sort"],"filter":[["base","=",false]],"order":{"sort":"asc"},"pagination":{"limit":2},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.pricetype.list

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type PriceTypeListResult = {
  items: Array<{
    id: number
    name: string
    base: boolean
    sort: number
  }>
}

try {
  const response = await $b24.actions.v3.call.make<PriceTypeListResult>({
    method: 'catalog.pricetype.list',
    params: {
      select: ['id', 'name', 'base', 'sort'],
      filter: [
        ['base', '=', false],
      ],
      order: {
        sort: 'asc',
      },
      pagination: {
        limit: 2,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Price types:', result.items.length)
  }
} 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 listPriceTypes() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.pricetype.list',
        params: {
          select: ['id', 'name', 'base', 'sort'],
          filter: [
            ['base', '=', false],
          ],
          order: {
            sort: 'asc',
          },
          pagination: {
            limit: 2,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Price types:', result.items.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', listPriceTypes)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.pricetype.list(
        select=["id", "name", "base", "sort"],
        filter=[
            ["base", "=", False],
        ],
        order={"sort": "asc"},
        pagination={"limit": 2},
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.pricetype.list',
            [
                'select' => ['id', 'name', 'base', 'sort'],
                'filter' => [
                    ['base', '=', false],
                ],
                'order' => [
                    'sort' => 'asc',
                ],
                'pagination' => [
                    'limit' => 2,
                ],
            ]
        );

    $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();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.pricetype.list',
    {
        select: ['id', 'name', 'base', 'sort'],
        filter: [
            ['base', '=', false],
        ],
        order: {
            sort: 'asc',
        },
        pagination: {
            limit: 2,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.pricetype.list',
    [
        'select' => ['id', 'name', 'base', 'sort'],
        'filter' => [
            ['base', '=', false],
        ],
        'order' => [
            'sort' => 'asc',
        ],
        'pagination' => [
            'limit' => 2,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.pricetype.list", b24.Params{
	"select": []string{"id", "name", "base", "sort"},
	"filter": []any{
		[]any{"base", "=", false},
	},
	"order": b24.Params{
		"sort": "asc",
	},
	"pagination": b24.Params{
		"limit": 2,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.pricetype.list: %w", err)
}

var result struct {
	Items []struct {
		ID   int    `json:"id"`
		Name string `json:"name"`
		Base bool   `json:"base"`
		Sort int    `json:"sort"`
	} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range result.Items {
	fmt.Println(item.ID, item.Name, item.Sort)
}

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 5,
                "name": "Wholesale price",
                "base": false,
                "sort": 1
            },
            {
                "id": 7,
                "name": "Wholesale price",
                "base": false,
                "sort": 10
            }
        ]
    },
    "time": {
        "start": 1792668177,
        "finish": 1792668177.817243,
        "duration": 0.8172430992126465,
        "processing": 0,
        "date_start": "2026-10-22T14:22:57+03:00",
        "date_finish": "2026-10-22T14:22:57+03:00",
        "operating_reset_at": 1792668720,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Объект с данными ответа
result.items `array`	Массив типов цен на странице. Состав полей зависит от `select`. Описание полей
time `time`	Информация о времени выполнения запроса

Элемент items

Название `тип`	Описание
id `integer`	Идентификатор типа цены
name `string`	Название типа цены
base `boolean`	Признак базового типа цены: `true` — базовый, `false` — обычный
sort `integer`	Сортировка
xmlId `string`	Внешний код типа цены. Пустая строка, если код не задан
timestampX `datetime`	Дата и время последнего изменения
modifiedBy `integer`	Идентификатор пользователя, который последним изменил тип цены
dateCreate `datetime`	Дата и время создания
createdBy `integer`	Идентификатор пользователя, который создал тип цены

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION",
        "message": "Неизвестный оператор фильтра `%`"
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле	Описание ошибки	Как исправить
`select`, `filter`, `order`	Неизвестное поле `#FIELD#` для сущности `PriceTypeDto`	Используйте только поля из списка параметра `select`

Ошибка формата фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Поле	Описание ошибки	Как исправить
`filter`	Не удается распознать выражение фильтра `Unknown filter condition`	Передайте `filter` массивом условий, например `[["base","=",false]]`

Ошибка оператора фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION

Поле	Описание ошибки	Как исправить
`filter`	Неизвестный оператор фильтра `#OPERATOR#`	Используйте операторы из обзора REST 3.0

Ошибка сортировки

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION

Поле	Описание ошибки	Как исправить
`order`	Не удается распознать выражение сортировки `#ORDER#`	Передайте направление `ASC` или `DESC`

Ошибка пагинации

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`pagination`	Не удается распознать параметр пагинации `#PAGINATION#`	Передайте в `limit` положительное число

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Проверьте, что у пользователя есть право «Просмотр каталога товаров» или «Управление типами цен»

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Получить список типов цен

Удалить тип цены

Получить список типов цен по фильтру v 3.0 catalog.pricetype.list

Параметры методаПараметры метода

Параметр paginationПараметр pagination

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Элемент itemsЭлемент items

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Ошибка неизвестного поляОшибка неизвестного поля

Ошибка формата фильтраОшибка формата фильтра

Ошибка оператора фильтраОшибка оператора фильтра

Ошибка сортировкиОшибка сортировки

Ошибка пагинацииОшибка пагинации

Ошибка доступаОшибка доступа

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Параметры метода

Параметр pagination

Примеры кода

Обработка ответа

Возвращаемые данные

Элемент items

Обработка ошибок

Возможные коды ошибок

Ошибка неизвестного поля

Ошибка формата фильтра

Ошибка оператора фильтра

Ошибка сортировки

Ошибка пагинации

Ошибка доступа

Статусы и коды системных ошибок

Продолжите изучение