📚 Документация по категориям API

Подробная документация по каждой категории OZON Seller API с примерами использования, TypeScript типами и лучшими практиками.

🏗️ Структура документации

Каждая категория содержит:

Обзор методов — полный список доступных endpoint’ов
Быстрый старт — базовые примеры использования
Детальные сценарии — реальные use cases с кодом
TypeScript типы — интерфейсы запросов и ответов
Особенности API — ограничения и нюансы
Лучшие практики — рекомендации по использованию

📦 Доступные категории

✅ Готовая документация

🏪 Warehouse API — Управление складами FBS/rFBS
🏭 Supplier API — Таможенные счёт-фактуры для турецких продавцов

🚧 В разработке

📦 Products API — Управление каталогом товаров
💰 Finance API — Финансовые операции
📊 Analytics API — Аналитика продаж
⭐ Review API — Работа с отзывами
🎯 Promos API — Акции и скидки
📄 Report API — Бизнес-отчеты
🔄 Returns API — Управление возвратами

🎯 Специализация документации

По уровню сложности

🟢 Начинающий уровень

Warehouse API — простые CRUD операции
Category API — работа с категориями
Barcode API — генерация штрихкодов

🟡 Средний уровень

Products API — управление каталогом
Finance API — финансовая отчетность
Review API — работа с отзывами

🔴 Продвинутый уровень

Analytics API — сложная аналитика
FBS/FBO API — комплексная логистика
Promos API — маркетинговые кампании

По функциональности

📦 Управление товарами

Products API
Category API
Prices & Stocks API
Barcode API

📋 Обработка заказов

FBO API
FBS API
Delivery API
Cancellation API

💰 Финансы и аналитика

Finance API
Report API
Analytics API
Seller Rating API

🎯 Маркетинг

Promos API
Premium API
Pricing Strategy API

👥 Работа с клиентами

Review API (Premium Plus)
Questions & Answers API (Premium Plus)
Chat API

📖 Как читать документацию

1. Начните с обзора

Каждая страница начинается с краткого описания назначения API и списка методов.

2. Изучите быстрый старт

Базовые примеры покажут основные возможности API.

3. Углубитесь в сценарии

Реальные примеры использования с полным кодом и объяснениями.

4. Проверьте типы

TypeScript интерфейсы помогут понять структуру данных.

5. Изучите особенности

Ограничения, нюансы и подводные камни конкретного API.

🔧 Соглашения в документации

Стиль кода

// ✅ Хорошо - с обработкой ошибок
try {
  const result = await client.products.getList({ limit: 100 });
  console.log(`Найдено товаров: ${result.result?.items?.length}`);
} catch (error) {
  console.error('Ошибка при получении товаров:', error);
}

// ❌ Плохо - без обработки ошибок  
const result = await client.products.getList({ limit: 100 });

Логирование

// ✅ Информативные логи
console.log('🔄 Начинаем синхронизацию товаров...');
console.log(`✅ Успешно обработано: ${successCount} товаров`);
console.log(`❌ Ошибок: ${errorCount}`);

// ❌ Минимальные логи
console.log('start');
console.log('done');

Примеры данных

Используются реальные форматы OZON (номера отправлений, SKU и т.д.)
Все суммы в рублях, если не указано иное
Даты в формате ISO 8601

🤝 Как внести вклад

Улучшение существующей документации

Нашли ошибку? Создайте Issue
Хотите добавить пример? Создайте Pull Request
Не хватает объяснений? Напишите в Discussions

Создание новой документации

Изучите структуру существующих файлов
Используйте единый стиль оформления
Добавьте реальные примеры использования
Проверьте TypeScript типы

Требования к качеству

✅ Все примеры должны быть рабочими
✅ Код должен проходить TypeScript проверку
✅ Обязательная обработка ошибок
✅ Информативные комментарии на русском языке
✅ Emoji для лучшей навигации

📞 Поддержка

Нужна помощь с документацией?

💬 GitHub Discussions
🐛 GitHub Issues для ошибок

Хотите предложить улучшения?

💡 GitHub Discussions для идей
🔧 Pull Requests для конкретных изменений
⭐ Star репозитория, если документация полезна

🏠 Главная страница документации