метод REST scope: catalog

catalog.price.list

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

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

Описание

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

Параметры

select array необязательный

Массив со списком полей catalog_price, которые необходимо выбрать.

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля цены

filter object необязательный

Объект для фильтрации выбранных цен товаров в формате {"field_1": "value_1", ..., "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта catalog_price.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

order object необязательный

Объект для сортировки выбранных цен товаров в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта catalog_price.

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания
start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Примеры запроса

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","productId","catalogGroupId","price","currency"],"filter":{"productId":1},"order":{"id":"ASC"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.price.list

Ответ

HTTP-статус: 200

{
    "result": {
        "prices": [
            {
                "catalogGroupId": 3,
                "currency": "RUB",
                "id": 381,
                "price": 50,
                "productId": 6461
            },
            {
                "catalogGroupId": 1,
                "currency": "USD",
                "id": 787,
                "price": 100.5,
                "productId": 6461
            }
        ]
    },
    "total": 2,
    "time": {
        "start": 1756796975.535775,
        "finish": 1756796975.569925,
        "duration": 0.034150123596191406,
        "processing": 0.0042951107025146484,
        "date_start": "2025-09-02T10:09:35+03:00",
        "date_finish": "2025-09-02T10:09:35+03:00",
        "operating_reset_at": 1756797575,
        "operating": 0
    }
}

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

result object

Корневой элемент ответа

prices catalog_price[]

Массив объектов с информацией о выбранных ценах товаров, структура зависит от параметра select

total integer

Общее количество найденных записей

time time

Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": 200040300010,
    "error_description": "Access Denied"
}
Код Описание Значение
200040300010 Access Denied Недостаточно прав для чтения
0 Другие ошибки

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.