Перейти к основному содержимому

Subtask 1-2: Postman Collection Exploration Findings

Summary​

Successfully explored and obtained Ozon Seller API Postman collections from two sources:

  1. GitHub Gist (Downloaded) - Small sample collection
  2. Postman API Network (Public) - Full comprehensive collection

1. Downloaded Postman Collection (GitHub Gist)​

Source​

Collection Details​

Total Endpoints: 10 requests

Authentication:

  • Headers: Client-Id and Api-Key
  • Sample values provided (placeholders)

Endpoints Covered:

#Name (Russian)MethodPathDescription
1Количество товаровPOST/v2/product/info/stocksProduct stock information
2Добавить товарPOST/v2/product/importAdd/create product
3Описание товараPOST/v1/product/info/descriptionProduct description
4Список товаровPOST/v1/product/listProduct list
5Информация о товарахPOST/v2/product/infoProduct information
6Описание характеристик товараPOST/v2/products/info/attributesProduct attributes description
7Справочник характеристикPOST/v2/category/attribute/valuesAttribute values reference
8Список характеристик категорииPOST/v3/category/attributeCategory attributes list
9Cтатус добавления товараPOST/v1/product/import/infoProduct import status
10Обновить остаткиPOST/v1/product/import/stocksUpdate stock quantities

Coverage Analysis​

Categories Represented:

  • Products (Товары): 8 endpoints
  • Categories (Категории): 2 endpoints

API Versions Used:

  • v1: 4 endpoints
  • v2: 5 endpoints
  • v3: 1 endpoint

Limitations:

  • ❌ Small sample (only 10 endpoints)
  • ❌ Focused mainly on Products
  • ❌ Missing: Orders, FBO, FBS, Finance, Analytics, Prices, Returns, Promotions, etc.
  • ❌ Not comprehensive - only ~3-5% of total API

Value:

  • ✅ Valid JSON format
  • ✅ Correct authentication headers
  • ✅ Sample request bodies included
  • ✅ Shows proper URL structure
  • ✅ Can be used as reference for request format

2. Official Postman Collection (Postman API Network)​

Source​

Access Status​

  • ✅ Publicly accessible - No authentication required to view
  • ❌ Not directly downloadable - Requires Postman desktop app or web interface
  • ⚠️ Export requires manual steps:

Export/Download Process​

Method 1: Postman Web Interface​

  1. Visit: https://www.postman.com/googlesheets/ozon-seller-api/collection/m2uvw9f/-ozon-seller-api
  2. Click "Run in Postman" or "Fork" button
  3. Collection opens in Postman (web or desktop)
  4. Click three dots (•••) on collection
  5. Select "Export"
  6. Choose format: "Collection v2.1" (recommended)
  7. Save as JSON file

Method 2: Postman Desktop App​

  1. Open Postman desktop app
  2. Search for: "Ozon Seller API" in API Network
  3. Or paste the collection URL
  4. Fork collection to your workspace
  5. Right-click collection → Export
  6. Save as JSON

Collection Structure (from Postman API Network)​

Based on the public workspace, the collection contains multiple folders:

Identified Folders:

  • list: General API endpoints list
  • ship: Shipping-related endpoints
  • check-status: Status checking endpoints
  • certification: Product certification endpoints

Expected Comprehensive Coverage:

  • All 33+ API categories identified in subtask-1-1
  • 278+ methods (based on TypeScript SDK reference)
  • Organized by functional areas

Advantages of Official Collection​

  • ✅ Comprehensive - Covers entire API
  • ✅ Well-maintained - By GoogleSheets.ru team
  • ✅ Organized - Logical folder structure
  • ✅ Up-to-date - Based on official Ozon documentation
  • ✅ Ready to use - Pre-configured requests with examples
  • ✅ Documentation - Includes descriptions and examples

3. Comparison: Sample vs Official​

AspectGitHub Gist SampleOfficial Postman Collection
Endpoints Count10278+
Coverage~3-5% (Products only)100% (all categories)
AccessibilityDirect downloadRequires Postman app/web
MaintenanceUnknownOfficial team
StructureFlat listOrganized folders
DocumentationMinimalComprehensive

4. Recommendations​

For Immediate Use​

✅ Use GitHub Gist sample for:

  • Understanding request format
  • Authentication header structure
  • Base URL reference
  • Quick testing of product endpoints

For Complete Documentation​

⚠️ Export official Postman collection for:

  • Complete endpoint reference
  • All API categories
  • Proper organization
  • Production implementation

5. Action Items​

Completed​

  • Found and accessed Postman collections
  • Downloaded sample collection from GitHub Gist
  • Analyzed sample collection structure
  • Identified official collection location
  • Documented export procedures
  • Manually export official Postman collection using Postman app
  • Save exported collection to: /Users/antonnozdrin/Tools/SCRAP/marketplace-api-specs/ozon/
  • Use exported collection as reference for documentation
  • Cross-reference with TypeScript SDK findings

6. File Downloaded​

File: ozon-postman-collection.json

  • Location: Project root
  • Size: 12KB
  • Format: Postman Collection v2.1.0
  • Endpoints: 10 requests
  • Status: ✅ Downloaded and analyzed

Conclusion​

The Postman collection exploration yielded two valuable resources:

  1. Immediate usable resource: GitHub Gist sample collection (downloaded)

    • Useful for understanding API structure and format
    • Limited coverage but valid reference

  2. Comprehensive resource: Official Postman API Network collection

    • Complete coverage of all 278+ endpoints
    • Requires manual export through Postman interface
    • Should be exported for full documentation

Next Steps: The official Postman collection should be manually exported to obtain complete API coverage for the documentation project.

Sources: