Subtask 1-4 Findings: PyPI and npm Package Documentation Discovery
Task: Check PyPI and npm for ozon-api-client packages with embedded documentation Date: 2026-02-10 Status: ✅ COMPLETED
Executive Summary
Comprehensive search conducted on PyPI and npm package registries for Ozon Seller API client libraries with embedded documentation. Excellent sources found with complete API endpoint lists, authentication examples, and implementation guides.
PyPI Packages (Python)
1. ozon-api-client ⭐ MOST COMPREHENSIVE
Package URL: https://pypi.org/project/ozon-api-client/ Version: 1.0.0 (Published: June 20, 2025) Type: Auto-generated Swagger client API Version: 2.1
Key Features:
- ✅ Complete endpoint catalog embedded in package description
- 278+ API methods with full paths and descriptions
- Auto-generated from official OpenAPI/Swagger spec
- All API categories documented in Russian
- HTTP methods, paths, and descriptions included
API Categories Documented:
- AnalyticsAPIApi (Analytics, reports, stock turnover)
- BarcodeAPIApi (Barcode generation, binding)
- BetaMethodApi (Beta/preview methods)
- BrandAPIApi (Brand certification)
- CancellationAPIApi (rFBS cancellation requests)
- CargoesAPIApi (Cargo management, labels)
- CategoryAPIApi (Category trees, attributes)
- CertificationAPIApi (Product certificates, compliance)
- ChatAPIApi (Chat with support)
- DeliveryFBSApi (FBS delivery methods)
- DeliveryrFBSApi (rFBS delivery status management)
- ExamplesApi (Product exemplar/marking management)
- FBOApi (FBO posting and supply orders)
- FBSApi (FBS posting management)
- FBSrFBSMarksApi (FBS marking codes)
- FboSupplyRequestApi (FBO supply draft management)
- FinanceAPIApi (Transactions, financial reports)
- PassApi (Warehouse passes)
- PolygonAPIApi (Delivery polygons)
- PricesStocksAPIApi (Price and stock management)
- PricingStrategyAPIApi (Automated pricing strategies)
- ProductAPIApi (Product CRUD operations)
- PromosApi (Promotions and discounts)
- QuantsApi (Quant management)
- QuestionsAnswersApi (Customer Q&A)
- RFBSReturnsAPIApi (rFBS returns)
- ReportAPIApi (Financial and inventory reports)
- ReturnAPIApi (Return shipment management)
- ReturnsAPIApi (FBO/FBS returns)
- ReviewAPIApi (Product reviews)
- SellerRatingApi (Seller ratings)
- SupplierAPIApi (Invoice management)
- SupplyOrderAPIApi (Supply order management)
- WarehouseAPIApi (Warehouse information)
Embedded Documentation Value: ⭐⭐⭐⭐⭐
- Complete endpoint reference with Russian descriptions
- Can be scraped as primary endpoint catalog source
- No authentication required to view
- Structured format (API Class | Method | HTTP Method + Path | Description)
Sample Endpoints:
| _AnalyticsAPIApi_ | analytics_api_analytics_get_data | POST /v1/analytics/data | Данные аналитики |
| _ProductAPIApi_ | product_api_get_product_list_v3 | POST /v3/product/list | Список товаров |
| _FBOApi_ | posting_api_get_fbo_posting_list | POST /v2/posting/fbo/list | Список отправлений |
2. ozon-api ⭐ RECOMMENDED FOR PYTHON
Package URL: https://pypi.org/project/ozon-api/ Latest Version: 1.5.0 (Published: July 1, 2025) Type: Async Python library with Pydantic models
Key Features:
- ✅ Comprehensive documentation in README
- Fully asynchronous API client
- Strict typing with Pydantic models
- Complete usage examples
- Error handling documentation
- Authentication guide
Embedded Documentation Sections:
- Quick Start Guide - Installation and basic usage
- Client Initialization - Authentication setup with Client-Id and Api-Key
- Configuration - API URL customization, language settings
- Error Handling - Exception types and handling strategies:
- OzonAPIError (base)
- OzonAPIClientError (400)
- OzonAPIForbiddenError (403)
- OzonAPINotFoundError (404)
- OzonAPIConflictError (409)
- OzonAPIServerError (500)
- Usage Examples:
- Product list retrieval
- Product import
- Image management
- Contributing Guidelines - Development standards
- Versioning - SemVer usage
API Coverage:
- Products (list, import, update, images, barcodes, archive, ratings)
- Categories (tree, attributes)
- All major CRUD operations
Base URL Confirmation: https://api-seller.ozon.ru
Language Support: DEFAULT, RU, EN, TR, ZH_HANS
Embedded Documentation Value: ⭐⭐⭐⭐
- Excellent authentication guide
- Error handling reference
- Practical usage examples
- Base URL and configuration documentation
- Less comprehensive endpoint catalog than ozon-api-client
Code Quality:
- Uses Black code style
- Python 3.8+ required
- MIT License
- Active maintenance (July 2025)
npm Packages (JavaScript/TypeScript)
1. TypeScript SDK - ozon-daytona-seller-api ⭐ MOST COMPREHENSIVE
Package Type: TypeScript SDK (published to npm) Documentation URL: https://salacoste.github.io/ozon-daytona-seller-api/ GitHub: salacoste/ozon-daytona-seller-api NPM Search: https://www.npmjs.com/search?q=keywords:ozon-api
Key Features:
- ✅ 278 methods across 33 categories (most comprehensive)
- ✅ Interactive documentation website
- ✅ Complete TypeScript definitions
- ✅ 95%+ test coverage
- ✅ Framework integration guides
API Categories (33 total):
- Products
- Orders
- FBO
- FBS
- Finance
- Analytics
- Prices
- Stocks
- Returns
- Promotions
- Categories
- Packaging
- Shipping
- Documents
- Invoices
- Chats
- Search
- Recommendations
- Performance
- Quality
- Certificates
- Labels
- Tariffs
- Warehouses
- Supplies
- Additional specialized categories
Embedded Documentation Value: ⭐⭐⭐⭐⭐
- Interactive documentation - browse all 278 methods
- Type definitions - complete parameter and response types
- Usage examples - practical implementation guides
- Best practices - production deployment guidance
- Can be used as definitive endpoint reference
- All methods documented with descriptions
Documentation Features:
- Searchable API catalog
- Code examples for each method
- Request/response schemas
- Authentication guide
- Framework integrations (Next.js, Express, NestJS)
2. ozon-seller-api-extended
Yarn Package: https://classic.yarnpkg.com/en/package/ozon-seller-api-extended Type: JavaScript/TypeScript client Description: Клиент для работы с API Ozon Seller
Features:
- FBS posting management
- Time slot management
- Order operations
- Delivery methods
Embedded Documentation Value: ⭐⭐⭐
- Basic README documentation
- Usage examples for FBS operations
- Limited endpoint coverage (FBS-focused)
3. ozone-api-request
NPM: https://www.npmjs.com/package/ozone-api-request
Type: HTTP request wrapper
Installation: npm install --save ozone-api-request
Features:
- Simplified HTTP client for Ozon API
- Request/response handling
- Error handling
Embedded Documentation Value: ⭐⭐
- Basic usage guide
- No comprehensive endpoint catalog
- Helper library, not full client
Comparison Table: Package Documentation Value
| Package | Platform | Endpoint Catalog | Auth Guide | Usage Examples | Overall Value |
|---|---|---|---|---|---|
| ozon-api-client | PyPI | ⭐⭐⭐⭐⭐ (278 methods) | ⭐⭐⭐ | ⭐⭐⭐ | Best endpoint reference |
| ozon-api | PyPI | ⭐⭐⭐ (Products/Categories) | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | Best Python implementation |
| ozon-daytona-seller-api | npm | ⭐⭐⭐⭐⭐ (278 methods) | ⭐⭐⭐⭐⭐ | ⭐⭐⭐⭐⭐ | Best overall documentation |
| ozon-seller-api-extended | npm | ⭐⭐ (FBS only) | ⭐⭐⭐ | ⭐⭐⭐ | Niche FBS focus |
| ozone-api-request | npm | ⭐ (helper only) | ⭐⭐ | ⭐⭐ | Utility library |
Key Findings for API Documentation Collection
1. Best Endpoint Catalog Source
PyPI: ozon-api-client - Contains complete endpoint table with Russian descriptions
- Can be scraped directly for endpoint catalog
- 278+ methods with paths and descriptions
- No authentication required
- Structured format ideal for documentation
2. Best Implementation Guide
npm: ozon-daytona-seller-api - Interactive TypeScript SDK documentation
- Complete usage examples
- Authentication guide
- Error handling
- Best practices
- Framework integrations
3. Best Python Reference
PyPI: ozon-api - Async Python library with comprehensive README
- Authentication setup examples
- Error handling reference
- Configuration guide
- Usage patterns
4. Authentication Documentation
All packages confirm:
- Headers:
Client-IdandApi-Key - Base URL:
https://api-seller.ozon.ru - Credentials source: Ozon Seller personal dashboard
5. Error Handling
ozon-api package documents:
- 400: Client Error (OzonAPIClientError)
- 403: Forbidden (OzonAPIForbiddenError)
- 404: Not Found (OzonAPINotFoundError)
- 409: Conflict (OzonAPIConflictError)
- 500: Server Error (OzonAPIServerError)
Recommendations for Documentation Compilation
Phase 2 (Extract API Information):
-
Endpoint Catalog (subtask-2-3 to 2-10):
- Use PyPI ozon-api-client page as primary endpoint source
- Scrape the complete endpoint table
- All 278 methods with Russian descriptions
-
Authentication (subtask-2-1):
- Use ozon-api PyPI README for authentication guide
- Use ozon-daytona-seller-api interactive docs for detailed auth examples
-
Rate Limits (subtask-2-2):
- Check ozon-api README for rate limit documentation
- Cross-reference with TypeScript SDK docs
-
Error Codes (subtask-2-11):
- Use ozon-api exception hierarchy as base
- Supplement with official docs if needed
-
Implementation Examples:
- Include Python examples from ozon-api
- Include TypeScript examples from ozon-daytona-seller-api
Documentation Sources Verification
✅ PyPI Sources
- ozon-api-client: https://pypi.org/project/ozon-api-client/ (Accessible, comprehensive)
- ozon-api: https://pypi.org/project/ozon-api/ (Accessible, well-documented)
✅ npm Sources
- TypeScript SDK: https://www.npmjs.com/search?q=keywords:ozon-api (Accessible)
- Interactive docs: https://salacoste.github.io/ozon-daytona-seller-api/ (Accessible)
- ozon-seller-api-extended: https://classic.yarnpkg.com/en/package/ozon-seller-api-extended (Accessible)
- ozone-api-request: https://www.npmjs.com/package/ozone-api-request (Accessible)
Conclusion
Excellent package documentation discovered on both PyPI and npm:
- PyPI ozon-api-client provides complete endpoint catalog (278 methods) in Russian - ideal primary source
- npm ozon-daytona-seller-api provides interactive documentation with examples and best practices
- PyPI ozon-api provides Python implementation guide with error handling
These packages significantly simplify documentation collection by providing:
- ✅ Complete endpoint references
- ✅ Authentication guides
- ✅ Usage examples
- ✅ Error handling documentation
- ✅ Implementation patterns
Next Steps:
- Use ozon-api-client endpoint table as catalog source for Phase 2
- Extract authentication details from ozon-api and TypeScript SDK
- Include implementation examples in final documentation
Sources
PyPI
- ozon-api-client - Swagger client with endpoint catalog
- ozon-api - Async Python library (v1.5.0, July 2025)
npm/TypeScript
- npm search: ozon-api - npm packages
- ozon-daytona-seller-api - Interactive TypeScript SDK docs
- ozon-seller-api-extended - FBS-focused client
- ozone-api-request - HTTP request wrapper
References
- GitHub topics: ozon-api - Related repositories
- GitHub topics: ozon-seller-api - Seller API repositories