метод REST scope: sale

sale.shipmentproperty.add

Добавить свойство отгрузки

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

Описание

Метод sale.shipmentproperty.add добавляет свойство отгрузки.

Параметры

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

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

Параметр fields

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

Идентификатор типа плательщика

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

Идентификатор группы свойств

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

Название свойства отгрузки

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

Тип свойства отгрузки.
Возможные значения:
- STRING
- Y/N
- NUMBER
- ENUM
- FILE
- DATE
- LOCATION
- ADDRESS

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

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

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

Индикатор активности свойства отгрузки.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение Y (свойство добавляется активным)

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

Индикатор, является ли свойство отгрузки служебным. Служебные свойства отгрузки не отображаются в публичной части.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

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

Индикатор, входит ли свойство отгрузки в профиль покупателя.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

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

Индикатор, доступно ли свойство отгрузки в фильтре на странице списка отгрузок.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

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

Сортировка

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

Описание свойства отгрузки

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

Индикатор обязательности заполнения значения свойства отгрузки.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

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

Индикатор, является ли свойство отгрузки множественным. Для множественных свойств возможно указать несколько значений.
Возможные значения:
- Y — да
- N — нет

Если не передано, то по умолчанию значение N

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

Внешний идентификатор свойства отгрузки

defaultValue any необязательный

Дефолтное значение свойства отгрузки.
Для множественных свойств отгрузки (multiple) поддерживается передача массива значений

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

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

Список поддерживаемых ключей этого объекта зависит от типа свойства. Для некоторых типов свойств (например, Y/N) дополнительные свойства не предусмотрены. Описание параметра settings для разных типов свойств приведено ниже

Ответ

HTTP-статус: 200

{
   "result":{
      "property":{
         "active":"Y",
         "code":"PHONE",
         "defaultValue":"",
         "description":"описание свойства",
         "id":96,
         "inputFieldLocation":"0",
         "isAddress":"N",
         "isAddressFrom":"N",
         "isAddressTo":"N",
         "isEmail":"N",
         "isFiltered":"N",
         "isLocation":"N",
         "isLocation4tax":"N",
         "isPayer":"Y",
         "isPhone":"N",
         "isProfileName":"Y",
         "isZip":"N",
         "multiple":"N",
         "name":"Телефон (для связи с курьером)",
         "personTypeId":3,
         "propsGroupId":6,
         "required":"Y",
         "settings":{
            "maxlength":"100",
            "multiline":"Y"
         },
         "sort":500,
         "type":"STRING",
         "userProps":"Y",
         "util":"N",
         "xmlId":""
      }
   },
   "time":{
      "start":1712818563.754118,
      "finish":1712818566.840385,
      "duration":3.0862669944763184,
      "processing":1.0286660194396973,
      "date_start":"2024-04-11T09:56:03+03:00",
      "date_finish":"2024-04-11T09:56:06+03:00"
   }
}

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

result object

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

property sale_shipment_property

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

time time

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

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

HTTP-статус: 400

{
   "error":0,
   "error_description":"Required fields: propsGroupId"
}

Код	Описание	Значение
`200850000005`	Указано пустое значение для типа плательщика
`200850000006`	Внутренняя ошибка добавления свойства
`200850000009`	Ошибка возникает при попытке создать свойство отгрузки со значением параметра `multiple`, выставленным в `Y`, в том случае, если не передан параметр `isFiltered`. Фильтрация по множественным свойствам отгрузок не поддерживается
`200850000010`	Ошибка возникает при попытке создать свойство отгрузки со значением параметра `multiple`, выставленным в `Y`, в том случае, если значение параметра `isFiltered` не равно `N`. Фильтрация по множественным свойствам отгрузок не поддерживается
`200850000011`	Ошибка возникает при попытке создать свойство отгрузки с типом `LOCATION` и значением параметра `isLocation`, выставленным в `Y`, в том случае, если значение параметра `multiple` не указано. Не поддерживается множественность у свойств отгрузки, отмеченных индикатором `isLocation`
`200850000012`	Ошибка возникает при попытке создать свойство отгрузки с типом `LOCATION` и значением параметра `isLocation`, выставленным в `Y`, в том случае, если значение параметра `multiple` не равно `N`. Не поддерживается множественность у свойств отгрузки, отмеченных индикатором `isLocation`
`200850000013`	Ошибка возникает при попытке создать свойство отгрузки с типом `LOCATION` и значением параметра `isLocation4tax`, выставленным в `Y`, в том случае, если значение параметра `multiple` не указано. Не поддерживается множественность у свойств отгрузки, отмеченных индикатором `isLocation4tax`
`200850000014`	Ошибка возникает при попытке создать свойство отгрузки с типом `LOCATION` и значением параметра `isLocation4tax`, выставленным в `Y`, в том случае, если значение параметра `multiple` не равно `N`. Не поддерживается множественность у свойств отгрузки, отмеченных индикатором `isLocation4tax`
`200850000015`	Ошибка возникает при попытке создать свойство отгрузки с типом `STRING` и значением параметра `isProfileName`, выставленным в `Y`, в том случае, если значение параметра `required` не указано. Название профиля обязательно и не может быть пустым
`200850000016`	Ошибка возникает при попытке создать свойство отгрузки с типом `STRING` и значением параметра `isProfileName`, выставленным в `Y`, в том случае, если значение параметра `required` не равно `Y`. Название профиля обязательно и не может быть пустым
`200040300020`	Недостаточно прав для добавления свойства отгрузки
`100`	Не указан или пустой параметр `fields`
`0`	Не переданы обязательные поля
`0`	Другие ошибки (например, фатальные ошибки)

Описание

Параметры

Параметр fields

Ответ

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

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

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