Власні довідники через API

Власні довідники використовуються в додаткових полях. Якщо додаткове поле має тип вибору зі списку, його значення можуть посилатися на записи власного довідника.

API дозволяє читати ці записи, щоб зовнішня система могла правильно передавати значення додаткових полів.

Повʼязані інструкції:

• Додаткові поля;
• Товари через API;
• Контрагенти через API;
• Документи через API;
• Платежі через API.

Endpoint-и

Метод	Endpoint	Призначення
GET	/v1/custom_terms	отримати список значень власних довідників
GET	/v1/custom_terms/:id	отримати одне значення

Створення, оновлення й видалення значень власних довідників через API V1 не описані.

Поля у відповіді

Поле	Призначення
id	ID значення довідника.
title	Назва значення.
parent_id	Батьківське значення, якщо довідник має ієрархію.
code	Код значення.
api_id	Зовнішній ID значення.
created_at	Дата створення.
updated_at	Дата оновлення.

Використання в custom_fields

У додаткових полях ключем є ID додаткового поля, а значенням може бути ID або назва значення довідника, залежно від типу поля та сценарію.

Приклад:

{
  "product": {
    "custom_fields": {
      "custom-field-id": "custom-term-id"
    }
  }
}

Для мультивибору використовується рядок, у якому значення розділені комами.

порада

Для стабільної інтеграції краще зберігати id або api_id значення довідника, а не покладатися лише на назву.

Чеклист

Перед використанням власних довідників через API перевірте:

• які додаткові поля використовують власні довідники;
• чи потрібне одне значення або мультивибір;
• чи є у довідника ієрархія через parent_id;
• яке поле зовнішня система використовує як стабільний ключ: id, api_id або code;
• що робити, якщо значення довідника перейменували.

Підсумок

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