метод REST scope: sale

sale.statusLang.list

Получить список локализаций статусов

Кто может выполнять: администратор

Описание

Метод sale.statusLang.list получает список локализаций статусов заказа или доставки.

Параметры

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

Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта sale_status_lang).

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

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

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

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

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

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

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

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

Возможные значения для 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":["statusId","lid","name","description"],"filter":{"statusId":"N","lid":"ru"},"order":{"statusId":"asc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.statusLang.list

Ответ

HTTP-статус: 200

{
    "result":{
        "statusLangs":[
            {
                "description":"Заказ принят, но пока не обрабатывается (например, заказ только что создан или ожидается оплата заказа)",
                "lid":"ru",
                "name":"Принят, ожидается оплата",
                "statusId":"N"
            }
        ]
    },
    "total":1,
    "time":{
        "start":1712656146.769524,
        "finish":1712656146.98067,
        "duration":0.21114587783813477,
        "processing":0.02018594741821289,
        "date_start":"2024-04-09T12:49:06+03:00",
        "date_finish":"2024-04-09T12:49:06+03:00"
    }
}

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

result object

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

statusLangs sale_status_lang[]

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

total integer

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

time time

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

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

HTTP-статус: 400

{
   "error":0,
   "error_description":"error"
}
Код Описание Значение
200040300010 Недостаточно прав для чтения локализаций статусов
0 Другие ошибки (например, фатальные ошибки)

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

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