Категорії через API

Категорії в API відповідають категоріям товарів у Skynum. Вони використовуються в картотеці товарів, фільтрах, звітах, інтеграціях із сайтами та маркетплейсами.

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

• Каталог і категорії;
• Картотека товарів;
• Товари через API.

Endpoint-и

Метод	Endpoint	Призначення
GET	/v1/categories	отримати список категорій
POST	/v1/categories	створити категорію
GET	/v1/categories/:id	отримати одну категорію
PUT	/v1/categories/:id	оновити категорію
DELETE	/v1/categories/:id	видалити категорію

Поля категорії

У відповіді API категорія містить:

Поле	Призначення
id	Внутрішній ID категорії.
title	Назва категорії.
code	Код категорії.
parent_id	Батьківська категорія для вкладеної структури.
visible_in_shop	Ознака видимості в інтернет-магазині.
created_at	Дата створення.
updated_at	Дата оновлення.

Для запису API приймає:

• id;
• title;
• code;
• parent_id;
• visible_in_shop.

Отримання списку категорій

GET /v1/categories повертає список категорій товарів.

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

Отримання однієї категорії

GET /v1/categories/:id повертає одну категорію за внутрішнім ID Skynum.

Цей endpoint зручно використовувати для перевірки конкретної категорії перед оновленням або після синхронізації з зовнішньою системою.

Створення категорії

Для створення категорії передайте обʼєкт category.

{
  "category": {
    "title": "Взуття",
    "code": "shoes",
    "visible_in_shop": true
  }
}

parent_id використовується, якщо потрібно створити підкатегорію:

{
  "category": {
    "title": "Кросівки",
    "parent_id": "parent-category-id"
  }
}

Оновлення категорії

Endpoint:

PUT /v1/categories/:id

Оновлює ті самі поля, що й створення: назву, код, батьківську категорію та видимість в інтернет-магазині.

Видалення категорії

Endpoint:

DELETE /v1/categories/:id

попередження

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

Чеклист

Перед синхронізацією категорій перевірте:

• яка система є головною для структури категорій;
• чи потрібна вкладеність через parent_id;
• чи збігаються коди категорій у зовнішній системі та Skynum;
• чи потрібно керувати видимістю категорії в інтернет-магазині;
• як інтеграція обробляє перейменування й видалення категорій.

Підсумок

API категорій призначений для підтримки структури товарного каталогу. Для товарів використовуйте окремий ресурс Товари через API.