метод REST scope: sale

sale.status.add

Создать статус

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

Описание

Метод sale.status.add создает статус заказа или доставки.

Параметры

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

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

Параметр fields

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

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

Идентификатор статуса должен быть уникальным независимо от его типа. То есть нельзя добавить два статуса с одинаковым идентификатором (один для заказа, а другой для доставки)

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 '{"fields":{"id":"MS","type":"O","notify":"Y","sort":500,"color":"#FF0000","xmlId":"myStatusXmlId"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.status.add

Ответ

HTTP-статус: 200

{
    "result":{
        "status":{
            "color":"#FF0000",
            "id":"MS",
            "notify":"Y",
            "sort":500,
            "type":"O",
            "xmlId":"myStatusXmlId"
        }
    },
    "time":{
        "start":1712137817.343984,
        "finish":1712137817.605804,
        "duration":0.26182007789611816,
        "processing":0.018325090408325195,
        "date_start":"2024-04-03T12:50:17+03:00",
        "date_finish":"2024-04-03T12:50:17+03:00"
    }
}

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

result object

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

status sale_status

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

time time

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

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

HTTP-статус: 400

{
    "error":201350000001,
    "error_description":"Duplicate entry for key [id]"
}
Код Описание Значение
201350000001 Статус с переданным идентификатором уже существует
201350000003 Не передано значение типа статуса или переданное значение некорректно
201350000004 Передано пустое значение идентификатора статуса
201350000005 Превышено ограничение длины идентификатора статуса
200040300020 Недостаточно прав для добавления статуса
100 Не указан или пустой параметр fields
0 Не переданы обязательные поля
0 Другие ошибки (например, фатальные ошибки)

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

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