tuneFlexField. Гибкие поля

Гибкие поля добавляют дополнительные колонки к справочникам и документам системы: клиентам, товарам, точкам продаж, поступлениям и другим. Методы раздела позволяют получить список настроенных гибких полей, создать новое поле, изменить или удалить его.

Допустим, вы продаёте одежду и настроили для справочника «Клиенты» поле «Размер». Тогда у каждого клиента можно указать размер одежды: в карточке клиента в панели управления или через API. Настроенные гибкие поля видны в панели управления в разделе Настройки → Гибкие поля.

Как записать значение поля через API, описано ниже, в разделе «Как задать значение гибкого поля в записи».

Метод listTables возвращает справочники, поддерживающие гибкие поля. Код справочника указывается в параметре table_name других методов.

GET https://[компания].myvirtualpos.ru/api/flexField/listTables?apikey=MySecret

{
  "success": 1,
  "type": "frexfield.tables",
  "count": 25,
  "tables": [
    { "table": { "name": "warehouse", "description": "Точка продаж" } },
    { "table": { "name": "location", "description": "Территория" } }
  ]
}

Тот же ответ при format=xml (сокращённо):

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>frexfield.tables</type>
  <count>25</count>
  <tables>
    <table><name>warehouse</name><description>Точка продаж</description></table>
    <table><name>location</name><description>Территория</description></table>
  </tables>
</root>

Полный список кодов:

Тип задаётся параметром attr_type:

Для типов list и multi допустимые значения задаются в list_values строкой через запятую: Да,Нет,Возможно. Пробелы вокруг значений отбрасываются.

Каждое поле занимает одну колонку attributeN справочника, где N — значение attr_num. Количество колонок ограничено: у клиента, например, их 15.

GET https://[компания].myvirtualpos.ru/api/flexField?apikey=MySecret&table_name=customer

Параметры можно сочетать, условия объединяются по «и». Если параметров нет, возвращаются все настроенные поля.

{
  "success": 1,
  "type": "flexfield",
  "count": 1,
  "flexfields": [
    {
      "flexfield": {
        "id": 7,
        "table_name": "customer",
        "name": "Откуда узнали",
        "attr_num": 2,
        "attr_type": "list",
        "enabled": "Y",
        "default_value": "",
        "list_values": "Сайт,Журнал,Листовка",
        "created_date": "2026-02-02 16:12:50",
        "last_update_date": "2026-02-02 16:12:50"
      }
    }
  ]
}

Тот же ответ при format=xml:

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <success>1</success>
  <type>flexfield</type>
  <count>1</count>
  <flexfields>
    <flexfield>
      <id>7</id>
      <table_name>customer</table_name>
      <name>Откуда узнали</name>
      <attr_num>2</attr_num>
      <attr_type>list</attr_type>
      <enabled>Y</enabled>
      <default_value/>
      <list_values>Сайт,Журнал,Листовка</list_values>
      <created_date>2026-02-02 16:12:50</created_date>
      <last_update_date>2026-02-02 16:12:50</last_update_date>
    </flexfield>
  </flexfields>
</root>

Если ничего не найдено, метод возвращает успешный ответ с count равным 0 и пустым списком flexfields.

GET https://[компания].myvirtualpos.ru/api/flexField/update?apikey=MySecret&table_name=customer&name=%D0%A0%D0%B0%D0%B7%D0%BC%D0%B5%D1%80&create_if_not_exist=1&attr_type=list&list_values=S,M,L,XL

Поле ищется по id, а если он не указан — по паре table_name и name. Если поле не найдено:

• при create_if_not_exist=1 создаётся новое;
• иначе возвращается ошибка «Record not found».

Изменяются только переданные параметры, остальные остаются прежними.

{"success":1,"id":"21","isnew":"1"}

GET https://[компания].myvirtualpos.ru/api/flexField/delete?apikey=MySecret&id=21

Ответ: {«success»:1}. Если поля нет — ошибка «Record not found».

Значение гибкого поля задаётся тем же запросом, который создаёт или изменяет запись справочника. К обычным параметрам добавьте параметр [имя поля]=[значение]. Имя — либо название поля («Размер»), либо системное имя attribute1…attribute15. Номер колонки для каждого поля показывает attr_num в ответе метода получения или колонка «Номер атрибута» в разделе Настройки → Гибкие поля.

GET https://[компания].myvirtualpos.ru/api/customer/update?apikey=MySecret&id=40824&%D0%A0%D0%B0%D0%B7%D0%BC%D0%B5%D1%80=XL
GET https://[компания].myvirtualpos.ru/api/customer/update?apikey=MySecret&id=40824&attribute1=XL

Пустое значение очищает поле. Поле должно быть включено (enabled=Y). Запись значений описана для клиентов в статье Customer. Клиенты; в ответах методов клиентов гибкие поля не возвращаются.

Ошибка авторизации и общие ошибки описаны в статье Общие сведения. Ошибки методов раздела приходят с кодом HTTP 200 и success равным 0: