Для AI-агентов: markdown этой страницы — /docs-content/entities/order-properties/create.md индекс документации — /llms.txt

Создать свойство заказа

POST /v1/order-properties

Создаёт определение поля интернет-магазина для ввода дополнительных данных при оформлении заказа.

Поля передаются плоско в корне JSON, без обёртки fields.

Поля запроса (body)

Поле	Тип	Обяз.	Описание
`personTypeId`	number	да	ID типа плательщика. Список: `GET /v1/person-types`
`type`	string	да	Тип свойства: `STRING`, `Y/N`, `NUMBER`, `ENUM`, `FILE`, `DATE`, `LOCATION`, `ADDRESS`
`name`	string	да	Название поля заказа
`propsGroupId`	number	да	ID группы свойств выбранного типа плательщика. Источник: `GET /v1/order-properties`, поле `propsGroupId`
`code`	string \| null	нет	Символьный код
`sort`	number	нет	Порядок сортировки
`defaultValue`	any	нет	Значение по умолчанию. Скаляр или структура в зависимости от типа и `multiple`. Для `FILE` загрузка — `{ "fileData": ["имя файла", "base64"] }`
`description`	string \| null	нет	Описание поля
`settings`	object	нет	Настройки типа свойства. JSON-объект. Поля самого свойства передавайте на верхнем уровне тела
`xmlId`	string \| null	нет	Внешний идентификатор
`inputFieldLocation`	number	нет	Устаревшее поле. Битрикс24 его не использует
`active`	boolean	нет	Свойство активно
`required`	boolean	нет	Значение обязательно при оформлении заказа
`multiple`	boolean	нет	Свойство содержит несколько значений
`userProps`	boolean	нет	Сохранять значение в профиле покупателя
`util`	boolean	нет	Служебное свойство
`isAddress`	boolean	нет	Свойство содержит адрес
`isAddressFrom`	boolean	нет	Адрес отправления
`isAddressTo`	boolean	нет	Адрес назначения
`isEmail`	boolean	нет	Свойство содержит электронную почту
`isFiltered`	boolean	нет	Использовать свойство в фильтре
`isLocation`	boolean	нет	Свойство содержит местоположение
`isLocation4tax`	boolean	нет	Местоположение для расчёта налогов
`isPayer`	boolean	нет	Имя плательщика
`isPhone`	boolean	нет	Телефон
`isProfileName`	boolean	нет	Название профиля покупателя
`isZip`	boolean	нет	Почтовый индекс

id задаётся сервером.

Примеры

curl — личный ключ

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/order-properties" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "personTypeId": 5,
  "type": "STRING",
  "name": "Комментарий курьеру",
  "propsGroupId": 9,
  "code": "DELIVERY_COMMENT",
  "sort": 500,
  "active": false,
  "required": false,
  "defaultValue": "Позвонить перед доставкой",
  "settings": {
    "maxlength": 200
  }
}'

curl — OAuth-приложение

Terminal

curl -X POST "https://vibecode.bitrix24.tech/v1/order-properties" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "personTypeId": 5,
  "type": "STRING",
  "name": "Комментарий курьеру",
  "propsGroupId": 9,
  "code": "DELIVERY_COMMENT",
  "sort": 500,
  "active": false,
  "required": false,
  "defaultValue": "Позвонить перед доставкой",
  "settings": {
    "maxlength": 200
  }
}'

JavaScript — личный ключ

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "personTypeId": 5,
    "type": "STRING",
    "name": "Комментарий курьеру",
    "propsGroupId": 9,
    "code": "DELIVERY_COMMENT",
    "sort": 500,
    "active": false,
    "required": false,
    "defaultValue": "Позвонить перед доставкой",
    "settings": {
      "maxlength": 200
    }
  }),
})

const { success, data } = await res.json()

JavaScript — OAuth-приложение

javascript

const res = await fetch('https://vibecode.bitrix24.tech/v1/order-properties', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "personTypeId": 5,
    "type": "STRING",
    "name": "Комментарий курьеру",
    "propsGroupId": 9,
    "code": "DELIVERY_COMMENT",
    "sort": 500,
    "active": false,
    "required": false,
    "defaultValue": "Позвонить перед доставкой",
    "settings": {
      "maxlength": 200
    }
  }),
})

const { success, data } = await res.json()

Поля ответа

Поле	Тип	Описание
`success`	boolean	`true` при успехе. HTTP-статус — `201`
`data`	object	Созданное свойство заказа. Полный список полей: Поля свойства заказа

Пример ответа

Показаны основные поля. Полный список: Поля свойства заказа.

JSON

{
  "success": true,
  "data": {
    "id": 125,
    "personTypeId": 5,
    "type": "STRING",
    "name": "Комментарий курьеру",
    "propsGroupId": 9,
    "code": "DELIVERY_COMMENT",
    "active": false,
    "defaultValue": "Позвонить перед доставкой",
    "settings": {
      "maxlength": 200,
      "multiline": "N"
    }
  }
}

Пример ответа при ошибке

400 — в settings передано null: