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

API Sections and Categories Catalog

Date: 2025-02-10 Subtask: 2-5 - Catalog all API sections and categories Status: ✅ COMPLETED

Overview​

Lamoda provides three distinct API systems organized into 23 functional categories with 85 total endpoints/methods. This catalog provides a complete overview of all API sections, their purposes, and how they relate to different business models.

API Systems Summary​

API SystemTotal CategoriesTotal EndpointsPrimary PurposeToken Lifetime
B2B Platform API13 categories51 endpointsOrders, Shipments, Logistics24 hours
Seller JSON-RPC API8 categories24 methodsProducts, Prices, Stock15 minutes
Seller REST API3 categories10 endpointsFBS Returns, Feedback15 minutes
TOTAL24 categories85 endpointsComplete Ecosystem-

1. B2B Platform API Categories​

Base URL: https://api-b2b.lamoda.ru API Format: REST (OpenAPI 3.0.0) Total Endpoints: 51 Total Categories: 13

1.1 Authentication (Аутентификация)​

Endpoints: 1 Purpose: OAuth2 token generation for API access

EndpointMethodDescription
/auth/tokenGETПолучение токена авторизации (OAuth2)

Used by: All business models (FBS, FBO, DBS, B2B FF, B2B FBS)

1.2 Addresses (Адреса)​

Endpoints: 3 Purpose: Geographic address lookup and validation for delivery

EndpointMethodDescription
/api/v1/addresses/cityGETПоиск городов
/api/v1/addresses/streetGETПоиск улиц
/api/v1/addresses/buildingGETПоиск зданий/домов

Used by: All business models (for delivery address validation)

1.3 Orders (Заказы)​

Endpoints: 13 Purpose: Complete order lifecycle management - retrieval, updates, customer info, delivery methods, addresses, statuses, and events

EndpointMethodDescription
/api/v1/ordersGETПолучение списка заказов
/api/v1/ordersPOSTСоздание заказа
/api/v1/orders/{id}GETПолучение информации о заказе
/api/v1/orders/{id}PATCHОбновление заказа
/api/v1/orders/{id}/customerGETИнформация о покупателе
/api/v1/orders/{id}/customerPOSTОбновление данных покупателя
/api/v1/orders/{id}/delivery_methodGETМетод доставки
/api/v1/orders/{id}/delivery_methodPOSTОбновление метода доставки
/api/v1/orders/{id}/shipping_addressGETАдрес доставки
/api/v1/orders/{id}/shipping_addressPOSTОбновление адреса доставки
/api/v1/orders/{id}/statusesGETИстория статусов заказа
/api/v1/orders/{id}/eventsPOSTДобавление события к заказу
/api/v1/orders/{orderNr}/change_status_requestPOSTЗапрос на изменение статуса
/api/v1/orders/{orderNr}/items/{itemNr}/change_status_requestPOSTЗапрос на изменение статуса товара

Used by: All business models Key Workflows:

  • FBS: Get new orders → Process → Update status
  • FBO: Monitor order status
  • DBS: Update delivery information

1.4 Nomenclature/Products (Номенклатура)​

Endpoints: 7 Purpose: Product catalog management and barcode lookup

EndpointMethodDescription
/api/v1/nomenclaturesGETСписок номенклатуры
/api/v1/nomenclaturesPOSTСоздание номенклатуры
/api/v1/nomenclatures/{sku}PATCHОбновление номенклатуры
/api/v1/nomenclature/PUTПолное обновление номенклатуры
/api/v1/nomenclature/sell-valuesGETЗначения для продажи
/api/v1/goodsGETСписок товаров
/api/v1/container/{barcode}GETИнформация о контейнере по штрихкоду

Used by: All business models (catalog synchronization)

1.5 Shipments (Отгрузки)​

Endpoints: 8 Purpose: Shipment management - creation, tracking, fulfillment, and events

EndpointMethodDescription
/api/v1/shipmentsGETСписок отгрузок
/api/v1/shipments/fulfilmentGETСписок отгрузок для выполнения
/api/v1/shipments/fulfilmentPOSTСоздание отгрузки для выполнения
/api/v1/shipments/fulfilment/{id}GETДетали отгрузки
/api/v1/shipments/fulfilment/{id}/itemsGETТовары в отгрузке
/api/v1/shipments/outPOSTОтгрузка со склада
/api/v1/shipments/out/{id}/eventsPOSTСобытия отгрузки
/api/v1/brand-packing/pack-shipmentPOSTУпаковка отгрузки

Used by: All business models Key Workflows:

  • FBO: Create fulfillment shipment → Deliver to warehouse
  • FBS: Report shipment to Lamoda → Track delivery
  • DBS: Report self-delivery shipments

1.6 Stock (Складские остатки)​

Endpoints: 2 Purpose: Warehouse stock management and updates

EndpointMethodDescription
/api/v1/stock/goodsGETОстатки товаров на складе
/api/v1/stock/goodsPOSTОбновление остатков

Used by: FBO, B2B FF (Lamoda warehouse models)

1.7 Delivery (Доставка)​

Endpoints: 2 Purpose: Delivery methods and delivery information management

EndpointMethodDescription
/api/v1/delivery_methodsGETСписок методов доставки
/api/v1/delivery_infoGETИнформация о доставке
/api/v1/delivery_info/{orderNr}POSTОбновление информации о доставке

Used by: All business models (especially DBS for self-delivery tracking)

1.8 Pickup Points (Пункты выдачи)​

Endpoints: 2 Purpose: Lamoda pickup points location and details

EndpointMethodDescription
/api/v1/pickup_pointsGETСписок пунктов выдачи
/api/v1/pickup_points/{id}GETДетали пункта выдачи

Used by: All business models (for customer pickup information)

1.9 Partner Pickups (Забор товара)​

Endpoints: 3 Purpose: Partner pickup requests and management (courier pickup from seller)

EndpointMethodDescription
/api/v1/partner-pickupsGETСписок pickup-ов партнера
/api/v1/partner-pickupsPOSTСоздание pickup
/api/v1/partner-pickupsPATCHОбновление pickup

Used by: FBS (Lamoda courier pickup from seller warehouse)

1.10 Gift Certificates (Подарочные сертификаты)​

Endpoints: 3 Purpose: Gift certificate management and payments

EndpointMethodDescription
/api/v1/gift-certificatesGETСписок подарочных сертификатов
/api/v1/gift-certificatesPOSTСоздание сертификата
/api/v1/gift-certificates/balanceGETБаланс сертификата
/api/v1/gift-certificates/paymentsPOSTОплата сертификатом

Used by: All business models (gift certificate integration)

1.11 Labels (Этикетки)​

Endpoints: 1 Purpose: Generate shipping labels (PDF) for orders

EndpointMethodDescription
/api/v1/reports/label/streamGETГенерация этикеток (PDF stream)

Used by: FBS, FBO, DBS (shipping labels for packages)

1.12 Notifications (Уведомления)​

Endpoints: 2 Purpose: Notification management and webhooks

EndpointMethodDescription
/api/v1/notifications/resendPOSTПовторная отправка уведомления
Webhook endpointPOSTWebhook для получения уведомлений
Webhook endpointPOSTWebhook для получения запросов

Used by: All business models (event notifications)

1.13 Webhooks (Вебхуки)​

Endpoints: 2 Purpose: Real-time event notifications from Lamoda to seller system

EndpointMethodDescription
Webhook URLPOSTПолучение уведомлений о событиях
Webhook URLPOSTПолучение запросов от Lamoda

Used by: All business models (real-time integration)

2. Seller JSON-RPC API Categories​

Base URL: https://public-api-seller.lamoda.ru/jsonrpc API Format: JSON-RPC 2.0 Total Methods: 24 Total Categories: 8

2.1 Authentication (Аутентификация)​

Methods: 1 Purpose: OAuth2 token generation for Seller API access

MethodDescription
v1.tokens.createСоздание токена авторизации (OAuth2)

Used by: All business models using Seller APIs (FBS, FBO, DBS)

2.2 Dictionaries (Справочники)​

Methods: 2 Purpose: Retrieve reference data and attribute dictionaries

MethodDescription
v1.dictionaries.getПолучение справочников
v1.attribute-dictionaries.listСписок справочников атрибутов

Used by: All business models (reference data for products)

2.3 Nomenclatures/Products (Номенклатура)​

Methods: 10 Purpose: Comprehensive product catalog management - CRUD operations, pricing, images, categories, brands

MethodDescription
v1.nomenclatures.listСписок номенклатуры
v1.nomenclature.listСписок товаров (альтернативный метод)
v1.nomenclatures.storeСоздание/обновление товаров
v1.nomenclatures.update-activationОбновление активности товаров
v1.nomenclatures.set-pricesУстановка цен для нескольких товаров
v1.nomenclature.set-priceУстановка цены для товара
v1.nomenclature.update-priceОбновление цены товара
v1.nomenclatures-metadata.get-axapta-categoriesПолучение категорий Axapta
v1.nomenclatures-metadata.get-brandsПолучение списка брендов
v1.nomenclature-images.updateОбновление изображений товаров

Used by: All business models Key Workflows:

  • Create new products
  • Update product information
  • Set and update prices
  • Manage product images
  • Activate/deactivate products

2.4 Attributes (Атрибуты товаров)​

Methods: 3 Purpose: Product attribute management and dictionary mappings

MethodDescription
v1.attributes.listСписок атрибутов
v1.attributes.sku.listСписок атрибутов для SKU
v1.attributes-dictionaries-mappings.getПолучение маппингов справочников

Used by: All business models (detailed product specifications)

2.5 Stock (Остатки)​

Methods: 2 Purpose: Stock management and FBO warehouse information

MethodDescription
v1.stock.listПолучение остатков на складе
v1.fbo.warehouse.listСписок складов FBO

Used by: All business models Key Workflows:

  • FBS: Report own warehouse stock
  • FBO: Check FBO warehouse availability

2.6 Orders (Заказы)​

Methods: 3 Purpose: Order status tracking and shipment (note: FBS orders have limited statuses)

MethodDescription
v1.order-item-statuses.listСписок статусов товаров в заказе
v1.order.shipОтгрузка заказа
v1.order.delivery-note.downloadСкачать накладную на отгрузку

Used by: FBS (order fulfillment), FBO (order monitoring)

2.7 Categories (Категории)​

Methods: 1 Purpose: ERP category listings

MethodDescription
v1.erp-categories.listСписок категорий ERP

Used by: All business models (product categorization)

2.8 Questions (Вопросы покупателей)​

Methods: 2 Purpose: Customer questions and answers management

MethodDescription
v1.questions.listСписок вопросов от покупателей
v1.questions.answerОтвет на вопрос покупателя

Used by: All business models (customer service)

3. Seller REST API Categories​

Base URL: https://public-api-seller.lamoda.ru/api API Format: REST (OpenAPI 3.0.0) Total Endpoints: 10 Total Categories: 3

3.1 FBS Return Boxes (Возвратные короба FBS)​

Endpoints: 5 Purpose: FBS return box management - tracking returned shipments from customers

EndpointMethodDescription
/v2/fbs/return-boxesGETСписок возвратных коробов FBS
/v2/fbs/return-boxes/{id}GETДетали возвратного короба
/v2/fbs/return-boxes-summaryGETСводка по возвратным коробам
/v2/fbs/return-boxes-anomaliesGETКоробы с аномалиями (неопознанные посылки)
/v2/fbs/return-boxes/{id}/status-historyGETИстория статусов короба

Used by: FBS (returns processing) Key Workflows:

  • Track return boxes from customers
  • Identify anomalies (unidentified packages)
  • Process returns and restock

3.2 FBS Return Items (Возвращенные товары FBS)​

Endpoints: 3 Purpose: Individual returned item tracking within FBS return boxes

EndpointMethodDescription
/v2/fbs/return-itemsGETСписок возвращенных товаров FBS
/v2/fbs/return-items-summaryGETСводка по возвращенным товарам
/v2/fbs/return-items/{itemId}/status-historyGETИстория статусов товара

Used by: FBS (item-level returns tracking)

3.3 Feedback (Обратная связь)​

Endpoints: 2 Purpose: Customer feedback questions and answers

EndpointMethodDescription
/v2/feedback/questionsGETСписок вопросов об обратной связи
/v2/feedback/questions/{questionId}/answerPOSTОтвет на вопрос об обратной связи

Used by: All business models (customer feedback management)

Business Model Usage Matrix​

FBS (Fulfillment by Seller)​

Description: Seller stores, assembles, and ships orders

API SystemCategories UsedKey Endpoints
B2B Platform APIOrders (13), Shipments (8), Labels (1), Partner Pickups (3), Notifications (2)Order processing, shipping labels, courier pickups
Seller JSON-RPC APIProducts (10), Stock (1), Prices (3), Orders (3)Catalog management, stock reporting, order fulfillment
Seller REST APIFBS Return Boxes (5), FBS Return Items (3), Feedback (2)Returns processing

Total Categories Used: 17 out of 24

FBO (Fulfillment by Operator/Lamoda)​

Description: Lamoda warehouse handles all fulfillment

API SystemCategories UsedKey Endpoints
B2B Platform APIOrders (13), Shipments (8), Stock (2), Notifications (2)Order monitoring, warehouse shipments, stock info
Seller JSON-RPC APIProducts (10), Stock (2), Prices (3)Catalog, warehouse delivery, pricing
Seller REST APIFeedback (2)Customer feedback

Total Categories Used: 10 out of 24

DBS (Delivery by Seller)​

Description: Seller handles delivery with own couriers

API SystemCategories UsedKey Endpoints
B2B Platform APIOrders (13), Delivery (2), Notifications (2)Order processing, delivery tracking
Seller JSON-RPC APIProducts (10), Stock (1)Catalog management, stock info
Seller REST APIFeedback (2)Customer feedback

Total Categories Used: 9 out of 24

B2B FF (B2B Fulfillment)​

Description: Corporate orders with Lamoda fulfillment

API SystemCategories UsedKey Endpoints
B2B Platform APIOrders (13), Shipments (8), Stock (2)B2B order processing, shipments
Seller JSON-RPC APIProducts (10), Prices (3)Catalog and pricing

Total Categories Used: 7 out of 24

B2B FBS (B2B Fulfillment by Seller)​

Description: Corporate orders with seller fulfillment

API SystemCategories UsedKey Endpoints
B2B Platform APIOrders (13), Shipments (8), Delivery (2)B2B order processing, delivery tracking
Seller JSON-RPC APIProducts (10), Stock (1)Catalog and stock

Total Categories Used: 7 out of 24

Functional Grouping​

Catalog Management (Управление каталогом)​

Categories: Products (B2B), Nomenclatures (JSON-RPC), Attributes (JSON-RPC), Categories (JSON-RPC) Purpose: Product creation, updates, images, attributes, categorization Total Endpoints: 20

Inventory Management (Управление остатками)​

Categories: Stock (B2B), Stock (JSON-RPC), Shipments (B2B) Purpose: Stock reporting, warehouse management, shipment tracking Total Endpoints: 12

Order Management (Управление заказами)​

Categories: Orders (B2B), Orders (JSON-RPC) Purpose: Order retrieval, updates, status tracking, customer info Total Endpoints: 16

Pricing Management (Управление ценами)​

Categories: Nomenclatures pricing (JSON-RPC) Purpose: Set and update product prices Total Endpoints: 3

Logistics & Delivery (Логистика и доставка)​

Categories: Shipments (B2B), Delivery (B2B), Pickup Points (B2B), Partner Pickups (B2B), Labels (B2B) Purpose: Shipment creation, delivery tracking, labels, pickup management Total Endpoints: 16

Returns Management (Управление возвратами)​

Categories: FBS Return Boxes (REST), FBS Return Items (REST) Purpose: Return box tracking, item-level returns, anomalies Total Endpoints: 8

Customer Service (Сервис для покупателей)​

Categories: Questions (JSON-RPC), Feedback (REST) Purpose: Customer questions and feedback Total Endpoints: 4

Reference Data (Справочные данные)​

Categories: Addresses (B2B), Dictionaries (JSON-RPC), Gift Certificates (B2B) Purpose: Address lookup, reference data, gift certificates Total Endpoints: 8

Integration (Интеграция)​

Categories: Authentication (all), Notifications (B2B), Webhooks (B2B) Purpose: Auth, notifications, real-time events Total Endpoints: 6

Category Size Distribution​

Large Categories (10+ endpoints)​

  1. Orders (B2B) - 13 endpoints
  2. Nomenclatures (JSON-RPC) - 10 methods

Medium Categories (5-9 endpoints)​

  1. Shipments (B2B) - 8 endpoints
  2. FBS Return Boxes (REST) - 5 endpoints
  3. Gift Certificates (B2B) - 4 endpoints (noted as 3 in spec, actually 4)

Small Categories (2-4 endpoints)​

  1. Nomenclature (B2B) - 7 endpoints
  2. Partner Pickups (B2B) - 3 endpoints
  3. Attributes (JSON-RPC) - 3 methods
  4. FBS Return Items (REST) - 3 endpoints
  5. Addresses (B2B) - 3 endpoints
  6. Stock (B2B) - 2 endpoints
  7. Delivery (B2B) - 2 endpoints (actually 3)
  8. Pickup Points (B2B) - 2 endpoints
  9. Notifications (B2B) - 2 endpoints + 2 webhooks
  10. Webhooks (B2B) - 2 webhooks
  11. Stock (JSON-RPC) - 2 methods
  12. Orders (JSON-RPC) - 3 methods
  13. Questions (JSON-RPC) - 2 methods
  14. Dictionaries (JSON-RPC) - 2 methods
  15. Feedback (REST) - 2 endpoints

Single-Endpoint Categories​

  1. Authentication (B2B) - 1 endpoint
  2. Labels (B2B) - 1 endpoint
  3. Authentication (JSON-RPC) - 1 method
  4. Categories (JSON-RPC) - 1 method

Cross-Reference: Category → Business Model​

CategoryFBSFBODBSB2B FFB2B FBS
Authentication (B2B)✅✅✅✅✅
Addresses (B2B)✅✅✅✅✅
Orders (B2B)✅✅✅✅✅
Nomenclature (B2B)✅✅✅✅✅
Shipments (B2B)✅✅✅✅✅
Stock (B2B)❌✅❌✅❌
Delivery (B2B)❌❌✅❌✅
Pickup Points (B2B)✅✅✅✅✅
Partner Pickups (B2B)✅❌❌❌❌
Gift Certificates (B2B)✅✅✅✅✅
Labels (B2B)✅✅✅✅✅
Notifications (B2B)✅✅✅✅✅
Webhooks (B2B)✅✅✅✅✅
Authentication (JSON-RPC)✅✅✅✅✅
Dictionaries (JSON-RPC)✅✅✅✅✅
Nomenclatures (JSON-RPC)✅✅✅✅✅
Attributes (JSON-RPC)✅✅✅✅✅
Stock (JSON-RPC)✅✅✅✅✅
Orders (JSON-RPC)✅✅❌❌❌
Categories (JSON-RPC)✅✅✅✅✅
Questions (JSON-RPC)✅✅✅✅✅
FBS Return Boxes (REST)✅❌❌❌❌
FBS Return Items (REST)✅❌❌❌❌
Feedback (REST)✅✅✅✅✅

Legend:

  • ✅ = Category used by this business model
  • ❌ = Category not applicable to this business model

API System Selection Guide​

When to use B2B Platform API​

  • Order management and lifecycle
  • Shipment creation and tracking
  • Logistics and delivery
  • FBO warehouse operations
  • Label generation
  • Real-time webhooks
  • Gift certificate management

When to use Seller JSON-RPC API​

  • Product catalog management
  • Price updates
  • Stock reporting
  • Product attributes management
  • Customer questions (JSON-RPC version)
  • Order shipment (FBS)

When to use Seller REST API​

  • FBS returns processing
  • Return box tracking
  • Customer feedback

Integration Workflows by Category​

New Seller Onboarding​

  1. Authentication → Get tokens
  2. Products → Create product catalog
  3. Prices → Set prices
  4. Stock → Report initial stock
  5. Orders → Start receiving orders

Daily Operations (FBS)​

  1. Orders → Get new orders
  2. Orders → Update order status
  3. Labels → Generate shipping labels
  4. Shipments → Report shipment
  5. Stock → Update stock levels
  6. FBS Returns → Process returns
  7. Feedback → Respond to customers

Daily Operations (FBO)​

  1. Orders → Monitor order status
  2. Shipments → Create warehouse shipments
  3. Stock → Check warehouse stock
  4. Products → Update catalog
  5. Prices → Update prices
  6. Feedback → Respond to customers

Summary Statistics​

  • Total API Systems: 3
  • Total Categories: 24
  • Total Endpoints/Methods: 85
  • Most Complex Category: Orders (B2B) - 13 endpoints
  • Largest API System: B2B Platform API - 51 endpoints
  • Most Used Categories (across all business models):
    1. Orders (B2B) - All 5 models
    2. Nomenclatures (JSON-RPC) - All 5 models
    3. Authentication - All 5 models
    4. Notifications - All 5 models
    5. Feedback - All 5 models

Next Steps​

The following subtasks will provide detailed documentation for each category:

  • Subtask 2-6: Products API endpoints (Nomenclatures)
  • Subtask 2-7: Orders API endpoints
  • Subtask 2-8: Returns API endpoints (FBS Returns)
  • Subtask 2-9: Prices API endpoints
  • Subtask 2-10: Stocks API endpoints
  • Subtask 2-11: Shipments API endpoints
  • Subtask 2-12: Other API sections (Attributes, Categories, Delivery, etc.)

Documentation Sources:

  • B2B Platform API: /Users/antonnozdrin/Tools/SCRAP/marketplace-api-specs/lamoda/lamoda_b2b_openapi.yaml
  • Seller JSON-RPC API: /Users/antonnozdrin/Tools/SCRAP/marketplace-api-specs/lamoda/lamoda_seller_jsonrpc_api.yaml
  • Seller REST API: /Users/antonnozdrin/Tools/SCRAP/marketplace-api-specs/lamoda/lamoda_seller_rest_api.yaml