метод REST scope: sale

sale.status.update

Обновить статус

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

Описание

Метод sale.status.update обновляет статус заказа или доставки.

Параметры

id sale_status.id обязательный

Символьный идентификатор статуса

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

Значения полей для обновления статуса

Параметр fields

type string обязательный

Тип статуса:
- O — статус заказа
- D — статус доставки

notify string необязательный

Индикатор того, нужно ли отправлять почтовое уведомление пользователю, когда заказ или доставка переходят в этот статус.

Возможные значения:
- Y — оповещать
- N — не оповещать

sort integer необязательный

Сортировка

color string необязательный

HEX-код цвета статуса (например, #FF0000)

xmlId string необязательный

Внешний код статуса.

Может использоваться для синхронизации со статусом заказа или доставки по идентификатору во внешней системе

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"MS","fields":{"type":"D","notify":"N","sort":100,"color":"#00FF00","xmlId":"updatedXmlId"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.status.update

Ответ

HTTP-статус: 200

{
    "result":{
        "status":{
            "color":"#00FF00",
            "id":"MS",
            "notify":"N",
            "sort":100,
            "type":"D",
            "xmlId":"updatedXmlId"
        }
    },
    "time":{
        "start":1712142575.655577,
        "finish":1712142575.940234,
        "duration":0.28465700149536133,
        "processing":0.02240896224975586,
        "date_start":"2024-04-03T14:09:35+03:00",
        "date_finish":"2024-04-03T14:09:35+03:00"
    }
}

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

result object

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

status sale_status

Объект с информацией об обновленном статусе

time time

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

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

HTTP-статус: 400

{
    "error":0,
    "error_description":"Required fields: type"
}
Код Описание Значение
201340400001 Статус с переданным идентификатором не найден
200040300020 Недостаточно прав для обновления статуса
201350000003 Не передано значение типа статуса или переданное значение некорректно
201350000006

Ошибка возникает при попытке сменить тип некоторых системных статусов:

  • статусы F и N всегда должны иметь тип O (заказ)
  • статусы DF и DN всегда должны иметь тип D (доставка)
201350000007 Ошибка возникает при попытке сменить тип статуса заказа в том случае, если к данному статусу уже прикреплены заказы
201350000008 Ошибка возникает при попытке сменить тип статуса отгрузки в том случае, если к данному статусу уже прикреплены отгрузки
100 Не указан параметр id
100 Не указан или пустой параметр fields
0 Не переданы обязательные поля структуры fields
0 Другие ошибки (например, фатальные ошибки)

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

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