Документация API v2
Этот сайт генерируется из public/docs-v2.openapi.yaml. Тот же контракт используется для /docs.openapi и публичного справочника /docs.

NWMS API v2

Полный справочник по unified-контракту NWMS API v2. Он описывает endpoint, параметры, поля запросов, поля ответов, ошибки, примеры и ограничения схем из OpenAPI-источника истины.

88

Пути

136

Операции

255

Схемы

60

Тела запросов

440

Переиспользуемые параметры

Практическое руководство: первый запрос, повтор, ошибки и синхронизация
Новые возможности и особенности актуального контракта

Разделы справочника

Авторизация и пользователи

3 операции с параметрами, полями запроса, полями ответа, ошибками и примерами.

Товары

7 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Разукомплектация квантов

5 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Заказы

14 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Документы отправок

9 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Приемки

15 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Кросс-докинг

46 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Склады и магазины

10 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Движения остатков

1 операция с параметрами, полями запроса, полями ответа, ошибками и примерами.

DataMatrix

5 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Визиты погрузки

6 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Платежи доставки

1 операция с параметрами, полями запроса, полями ответа, ошибками и примерами.

Шаблоны уведомлений

12 операций с параметрами, полями запроса, полями ответа, ошибками и примерами.

Матрица endpoint

Метод URL Кратко operationId Раздел
GET /api/v2/acceptances Получить список приемок listAcceptances Приемки
POST /api/v2/acceptances Создать обычную, возвратную или cross-dock-приёмку createAcceptances Приемки
GET /api/v2/acceptances/{id} Получить приемку getAcceptances Приемки
PUT /api/v2/acceptances/{id} Обновить приемку replaceAcceptances Приемки
PATCH /api/v2/acceptances/{id} Обновить приемку patchAcceptances Приемки
DELETE /api/v2/acceptances/{id} Удалить приемку deleteAcceptances Приемки
POST /api/v2/acceptances/{id}/cancel Cancel acceptance cancelAcceptance Приемки
GET /api/v2/acceptances/{id}/lines Получить список приемок listAcceptancesLines Приемки
POST /api/v2/acceptances/{id}/lines Создать приемку createAcceptancesLines Приемки
PUT /api/v2/acceptances/{id}/lines/{lineId} Обновить приемку replaceAcceptancesLines Приемки
PATCH /api/v2/acceptances/{id}/lines/{lineId} Обновить приемку patchAcceptancesLines Приемки
DELETE /api/v2/acceptances/{id}/lines/{lineId} Удалить приемку deleteAcceptancesLines Приемки
POST /api/v2/acceptances/{id}/offers Создать приемку createAcceptancesOffers Приемки
PUT /api/v2/acceptances/{id}/offers/{lineId} Обновить приемку replaceAcceptancesOffers Приемки
DELETE /api/v2/acceptances/{id}/offers/{lineId} Удалить приемку deleteAcceptancesOffers Приемки
GET /api/v2/me Получить текущего пользователя getCurrentUser Аккаунт
GET /api/v2/closed-boxes List closed boxes currently in stock listClosedBoxes Closed Boxes
GET /api/v2/closed-boxes/{box} Get one closed box getClosedBox Closed Boxes
GET /api/v2/datamatrix Получить список DataMatrix listDataMatrix DataMatrix
POST /api/v2/datamatrix Создать DataMatrix createDataMatrix DataMatrix
DELETE /api/v2/datamatrix Удалить DataMatrix deleteDataMatrix DataMatrix
PUT /api/v2/datamatrix/status Обновить статус DataMatrix updateDataMatrixStatus DataMatrix
PATCH /api/v2/datamatrix/status Обновить статус DataMatrix updateDataMatrixStatusByPath DataMatrix
GET /api/v2/order-delivery-payments Получить список платежей доставки listOrderDeliveryPayments Платежи доставки
GET /api/v2/loading/visits Получить список визитов погрузки listLoadingVisits Визиты погрузки
POST /api/v2/loading/visits Создать визит погрузки createLoadingVisits Визиты погрузки
GET /api/v2/loading/visits/{id} Получить визит погрузки getLoadingVisits Визиты погрузки
PUT /api/v2/loading/visits/{id} Обновить визит погрузки replaceLoadingVisits Визиты погрузки
PATCH /api/v2/loading/visits/{id} Обновить визит погрузки patchLoadingVisits Визиты погрузки
POST /api/v2/loading/visits/{id}/cancel Отменить визит погрузки cancelLoadingVisitByPath Визиты погрузки
GET /api/v2/notification-templates Получить список шаблонов уведомлений listNotificationTemplates Шаблоны уведомлений
POST /api/v2/notification-templates Создать шаблон уведомления createNotificationTemplate Шаблоны уведомлений
GET /api/v2/notification-templates/{id} Получить шаблон с привязками getNotificationTemplate Шаблоны уведомлений
PUT /api/v2/notification-templates/{id} Изменить шаблон уведомления replaceNotificationTemplate Шаблоны уведомлений
PATCH /api/v2/notification-templates/{id} Изменить шаблон уведомления patchNotificationTemplate Шаблоны уведомлений
DELETE /api/v2/notification-templates/{id} Удалить шаблон уведомления deleteNotificationTemplate Шаблоны уведомлений
GET /api/v2/notification-templates/{id}/bindings Получить список складских привязок listNotificationTemplateBindings Шаблоны уведомлений
POST /api/v2/notification-templates/{id}/bindings Создать складскую привязку createNotificationTemplateBinding Шаблоны уведомлений
GET /api/v2/notification-templates/{id}/bindings/{bindingId} Получить складскую привязку getNotificationTemplateBinding Шаблоны уведомлений
PUT /api/v2/notification-templates/{id}/bindings/{bindingId} Изменить складскую привязку replaceNotificationTemplateBinding Шаблоны уведомлений
PATCH /api/v2/notification-templates/{id}/bindings/{bindingId} Изменить складскую привязку patchNotificationTemplateBinding Шаблоны уведомлений
DELETE /api/v2/notification-templates/{id}/bindings/{bindingId} Удалить складскую привязку deleteNotificationTemplateBinding Шаблоны уведомлений
GET /api/v2/orders Получить список заказов listOrders Заказы
POST /api/v2/orders Создать заказ createOrders Заказы
GET /api/v2/orders/{id} Получить заказ getOrders Заказы
PUT /api/v2/orders/{id} Обновить заказ replaceOrders Заказы
PATCH /api/v2/orders/{id} Обновить заказ patchOrders Заказы
DELETE /api/v2/orders/{id} Удалить заказ deleteOrders Заказы
GET /api/v2/orders/{id}/integration-events Export Ozon and Wildberries interaction history for one order getOrderIntegrationEvents Заказы
POST /api/v2/orders/{id}/lines Создать заказ createOrdersLines Заказы
PUT /api/v2/orders/{id}/lines/{lineId} Обновить заказ replaceOrdersLines Заказы
PATCH /api/v2/orders/{id}/lines/{lineId} Обновить заказ patchOrdersLines Заказы
DELETE /api/v2/orders/{id}/lines/{lineId} Удалить заказ deleteOrdersLines Заказы
POST /api/v2/orders/{id}/offers Создать заказ createOrdersOffers Заказы
PUT /api/v2/orders/{id}/offers/{lineId} Обновить заказ replaceOrdersOffers Заказы
DELETE /api/v2/orders/{id}/offers/{lineId} Удалить заказ deleteOrdersOffers Заказы
GET /api/v2/products Получить список товаров listProducts Товары
POST /api/v2/products Создать товар createProducts Товары
PUT /api/v2/products Обновить товар replaceProducts Товары
PATCH /api/v2/products Обновить товар patchProducts Товары
GET /api/v2/products/{id} Получить товар getProducts Товары
DELETE /api/v2/products/{id} Удалить товар deleteProducts Товары
GET /api/v2/products/{id}/stock-lots List physical stock lots getProductStockLots Товары
GET /api/v2/quant-unpackings Получить список разукомплектаций квантов listQuantUnpackings Разукомплектация квантов
POST /api/v2/quant-unpackings Создать разукомплектацию кванта createQuantUnpackings Разукомплектация квантов
GET /api/v2/quant-unpackings/{id} Получить разукомплектацию кванта getQuantUnpackings Разукомплектация квантов
POST /api/v2/quant-unpackings/{id}/conduct Провести разукомплектацию кванта conductQuantUnpacking Разукомплектация квантов
POST /api/v2/quant-unpackings/{id}/items Добавить строку разукомплектации addQuantUnpackingsItems Разукомплектация квантов
GET /api/v2/send-documents Получить список документов отправок listSendDocuments Документы отправок
POST /api/v2/send-documents Создать документ отправки createSendDocuments Документы отправок
GET /api/v2/send-documents/{id} Получить документ отправки getSendDocuments Документы отправок
PUT /api/v2/send-documents/{id} Обновить документ отправки replaceSendDocuments Документы отправок
PATCH /api/v2/send-documents/{id} Обновить документ отправки patchSendDocuments Документы отправок
DELETE /api/v2/send-documents/{id} Удалить документ отправки deleteSendDocuments Документы отправок
GET /api/v2/send-documents/{id}/events Получить журнал событий документа отправки listSendDocumentsEvents Документы отправок
POST /api/v2/send-documents/{id}/orders Добавить заказы в документ отправки createSendDocumentsOrders Документы отправок
DELETE /api/v2/send-documents/{id}/orders/{orderId} Удалить заказ из документа отправки deleteSendDocumentsOrders Документы отправок
GET /api/v2/shops Получить список магазинов listShops Магазины
POST /api/v2/shops Создать магазин createShops Магазины
GET /api/v2/shops/{id} Получить магазин getShops Магазины
PUT /api/v2/shops/{id} Обновить магазин replaceShops Магазины
PATCH /api/v2/shops/{id} Обновить магазин patchShops Магазины
GET /api/v2/stock-movements Получить журнал движений остатков listStockMovements Движения остатков
GET /api/v2/users Получить список пользователей listUsers Пользователи
GET /api/v2/users/{id} Получить пользователя getUsers Пользователи
GET /api/v2/warehouses Получить список складов listWarehouses Склады
POST /api/v2/warehouses Создать склад createWarehouses Склады
GET /api/v2/warehouses/{id} Получить склад getWarehouses Склады
PUT /api/v2/warehouses/{id} Обновить склад replaceWarehouses Склады
PATCH /api/v2/warehouses/{id} Обновить склад patchWarehouses Склады
GET /api/v2/crossdock/cases Получить список cross-dock-кейсов crossDockListCases Кросс-докинг
GET /api/v2/crossdock/cases/{case} Получить cross-dock-кейс crossDockGetCase Кросс-докинг
PATCH /api/v2/crossdock/cases/{case} Обновить реквизиты cross-dock-кейса crossDockUpdateCaseMetadata Кросс-докинг
GET /api/v2/crossdock/cases/{case}/allocations Получить распределения cross-dock crossDockListAllocations Кросс-докинг
POST /api/v2/crossdock/cases/{case}/cancel Отменить cross-dock-кейс crossDockCancelCase Кросс-докинг
POST /api/v2/crossdock/cases/{case}/close Закрыть cross-dock-кейс crossDockCloseCase Кросс-докинг
GET /api/v2/crossdock/cases/{case}/demands Получить потребности cross-dock crossDockListDemands Кросс-докинг
GET /api/v2/crossdock/cases/{case}/events Получить события аудита cross-dock crossDockListEvents Кросс-докинг
GET /api/v2/crossdock/cases/{case}/exceptions Получить исключения cross-dock crossDockListExceptions Кросс-докинг
POST /api/v2/crossdock/cases/{case}/exceptions Открыть исключение cross-dock crossDockOpenException Кросс-докинг
POST /api/v2/crossdock/cases/{case}/fallback Выполнить fallback cross-dock через alias crossDockExecuteFallbackByAlias Кросс-докинг
GET /api/v2/crossdock/cases/{case}/fallbacks Получить компенсирующие маршруты cross-dock crossDockListFallbacks Кросс-докинг
POST /api/v2/crossdock/cases/{case}/fallbacks Выполнить fallback cross-dock crossDockExecuteFallback Кросс-докинг
GET /api/v2/crossdock/cases/{case}/fulfillments Получить исполненные фрагменты cross-dock crossDockListFulfillments Кросс-докинг
GET /api/v2/crossdock/cases/{case}/labels Получить этикетки направлений cross-dock crossDockListTargetLabels Кросс-докинг
POST /api/v2/crossdock/cases/{case}/labels/print-jobs Создать задания печати cross-dock crossDockCreatePrintJobs Кросс-докинг
GET /api/v2/crossdock/cases/{case}/loading-visits Получить связи кейса с визитами погрузки crossDockListCaseLoadingVisitAssociations Кросс-докинг
POST /api/v2/crossdock/cases/{case}/loading-visits/attach Привязать визит погрузки к cross-dock-кейсу crossDockAttachLoadingVisitToCase Кросс-докинг
POST /api/v2/crossdock/cases/{case}/loading-visits/detach Отвязать визит погрузки от cross-dock-кейса crossDockDetachLoadingVisitFromCase Кросс-докинг
POST /api/v2/crossdock/cases/{case}/loading-visits/{visit}/attach Привязать визит погрузки по ID в пути crossDockAttachLoadingVisitByPathId Кросс-докинг
POST /api/v2/crossdock/cases/{case}/loading-visits/{visit}/detach Отвязать визит погрузки по ID в пути crossDockDetachLoadingVisitByPathId Кросс-докинг
POST /api/v2/crossdock/cases/{case}/loading/scans Подтвердить погрузочный скан cross-dock crossDockConfirmLoadingScan Кросс-докинг
PUT /api/v2/crossdock/cases/{case}/manifest Заменить манифест грузовых единиц cross-dock crossDockReplaceHandlingUnitManifest Кросс-докинг
GET /api/v2/crossdock/cases/{case}/orders Получить заказы cross-dock-кейса crossDockListOrders Кросс-докинг
POST /api/v2/crossdock/cases/{case}/orders Создать cross-dock-заказ и направление crossDockCreateOrderAndTarget Кросс-докинг
POST /api/v2/crossdock/cases/{case}/plan Рассчитать распределение cross-dock crossDockPlanAllocation Кросс-докинг
GET /api/v2/crossdock/cases/{case}/print-jobs Получить задания печати cross-dock crossDockListPrintJobs Кросс-докинг
GET /api/v2/crossdock/cases/{case}/readiness Get crossdock listCrossdockCasesReadiness Кросс-докинг
POST /api/v2/crossdock/cases/{case}/release Выпустить план cross-dock в работу crossDockReleasePlan Кросс-докинг
POST /api/v2/crossdock/cases/{case}/return-to-draft Run crossdock action createCrossdockCasesReturnToDraft Кросс-докинг
GET /api/v2/crossdock/cases/{case}/scan-sessions Get crossdock listCrossdockCasesScanSessions Кросс-докинг
POST /api/v2/crossdock/cases/{case}/scans/source Отсканировать источник cross-dock crossDockScanSource Кросс-докинг
POST /api/v2/crossdock/cases/{case}/scans/target Подтвердить скан направления cross-dock crossDockConfirmTargetScan Кросс-докинг
POST /api/v2/crossdock/cases/{case}/submit Run crossdock action createCrossdockCasesSubmit Кросс-докинг
GET /api/v2/crossdock/cases/{case}/supplies Получить входящие количества cross-dock crossDockListSupplies Кросс-докинг
GET /api/v2/crossdock/cases/{case}/targets Получить направления cross-dock crossDockListTargets Кросс-докинг
PUT /api/v2/crossdock/cases/{case}/targets/places Назначить места направлениям cross-dock crossDockAssignTargetPlaces Кросс-докинг
GET /api/v2/crossdock/cases/{case}/tasks Получить задания cross-dock crossDockListTasks Кросс-докинг
GET /api/v2/crossdock/commands/{commandId} Получить статус команды cross-dock crossDockGetCommandStatus Кросс-докинг
POST /api/v2/crossdock/exceptions/{exception}/resolve Разрешить исключение cross-dock crossDockResolveException Кросс-докинг
GET /api/v2/crossdock/loading-visits/{visit}/documents Получить cross-dock-документы визита погрузки crossDockListDocumentsForLoadingVisit Кросс-докинг
POST /api/v2/crossdock/print-jobs/{job}/acknowledge Подтвердить результат печати cross-dock crossDockAcknowledgePrintJob Кросс-докинг
POST /api/v2/crossdock/print-jobs/{job}/dispatch Передать задание cross-dock на принтер crossDockDispatchPrintJob Кросс-докинг
GET /api/v2/crossdock/scan-sessions/{session} Получить сессию сканирования cross-dock crossDockGetScanSession Кросс-докинг
POST /api/v2/crossdock/scan-sessions/{session}/cancel Отменить сессию сканирования cross-dock crossDockCancelScanSession Кросс-докинг
POST /api/v2/crossdock/scan-sessions/{session}/quantity Задать количество сессии cross-dock crossDockSetScanQuantity Кросс-докинг

Общий контракт

АутентификацияЗащищенные операции используют Authorization: Bearer {token} и Accept: application/json.
EnvelopeОтветы одного ресурса используют {data, meta}. Ответы коллекций используют {data, links, meta}.
ПагинацияPaginated endpoint описывают page, per_page, filters, includes и допустимые поля сортировки в таблицах операций.
ЗаписьWrite-операции содержат выделенные схемы тела запроса для create, replace, patch, command или bulk-сценариев.