API v2 documentation
This site is generated from
This site is generated from
public/docs-v2.openapi.yaml. The same contract powers /docs.openapi and the public reference under /docs.NWMS API v2
Production-grade reference for the unified NWMS API v2 contract. It documents endpoints, parameters, request fields, response fields, error responses, examples, and schema constraints from the OpenAPI source of truth.
88
Paths
136
Operations
255
Schemas
60
Request bodies
440
Reusable parameters
Integration guide: first request, retries, errors and synchronization
Recent additions and current contract details
Recent additions and current contract details
Reference Sections
Authentication and Users
3 documented operations with parameters, request fields, response fields, errors, and examples.
Products
7 documented operations with parameters, request fields, response fields, errors, and examples.
Quant Unpackings
5 documented operations with parameters, request fields, response fields, errors, and examples.
Orders
14 documented operations with parameters, request fields, response fields, errors, and examples.
Send Documents
9 documented operations with parameters, request fields, response fields, errors, and examples.
Acceptances
15 documented operations with parameters, request fields, response fields, errors, and examples.
Cross-docking
46 documented operations with parameters, request fields, response fields, errors, and examples.
Warehouses and Shops
10 documented operations with parameters, request fields, response fields, errors, and examples.
Stock Movements
1 documented operations with parameters, request fields, response fields, errors, and examples.
DataMatrix
5 documented operations with parameters, request fields, response fields, errors, and examples.
Loading Visits
6 documented operations with parameters, request fields, response fields, errors, and examples.
Delivery Payments
1 documented operations with parameters, request fields, response fields, errors, and examples.
Notification Templates
12 documented operations with parameters, request fields, response fields, errors, and examples.
Endpoint Matrix
| Method | Path | Summary | operationId | Section |
|---|---|---|---|---|
| GET | /api/v2/acceptances |
List acceptances | listAcceptances |
Acceptances |
| POST | /api/v2/acceptances |
Create standard, return, or cross-dock acceptance | createAcceptances |
Acceptances |
| GET | /api/v2/acceptances/{id} |
Get acceptance | getAcceptances |
Acceptances |
| PUT | /api/v2/acceptances/{id} |
Update acceptance | replaceAcceptances |
Acceptances |
| PATCH | /api/v2/acceptances/{id} |
Update acceptance | patchAcceptances |
Acceptances |
| DELETE | /api/v2/acceptances/{id} |
Delete acceptance | deleteAcceptances |
Acceptances |
| POST | /api/v2/acceptances/{id}/cancel |
Cancel acceptance | cancelAcceptance |
Acceptances |
| GET | /api/v2/acceptances/{id}/lines |
List acceptances | listAcceptancesLines |
Acceptances |
| POST | /api/v2/acceptances/{id}/lines |
Create acceptance | createAcceptancesLines |
Acceptances |
| PUT | /api/v2/acceptances/{id}/lines/{lineId} |
Update acceptance | replaceAcceptancesLines |
Acceptances |
| PATCH | /api/v2/acceptances/{id}/lines/{lineId} |
Update acceptance | patchAcceptancesLines |
Acceptances |
| DELETE | /api/v2/acceptances/{id}/lines/{lineId} |
Delete acceptance | deleteAcceptancesLines |
Acceptances |
| POST | /api/v2/acceptances/{id}/offers |
Create acceptance | createAcceptancesOffers |
Acceptances |
| PUT | /api/v2/acceptances/{id}/offers/{lineId} |
Update acceptance | replaceAcceptancesOffers |
Acceptances |
| DELETE | /api/v2/acceptances/{id}/offers/{lineId} |
Delete acceptance | deleteAcceptancesOffers |
Acceptances |
| GET | /api/v2/me |
Get current user | getCurrentUser |
Account |
| 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 |
List datamatrix | listDataMatrix |
DataMatrix |
| POST | /api/v2/datamatrix |
Create datamatrix | createDataMatrix |
DataMatrix |
| DELETE | /api/v2/datamatrix |
Delete datamatrix | deleteDataMatrix |
DataMatrix |
| PUT | /api/v2/datamatrix/status |
Update DataMatrix status | updateDataMatrixStatus |
DataMatrix |
| PATCH | /api/v2/datamatrix/status |
Update DataMatrix status | updateDataMatrixStatusByPath |
DataMatrix |
| GET | /api/v2/order-delivery-payments |
List delivery payments | listOrderDeliveryPayments |
Delivery Payments |
| GET | /api/v2/loading/visits |
List loading visits | listLoadingVisits |
Loading Visits |
| POST | /api/v2/loading/visits |
Create loading visit | createLoadingVisits |
Loading Visits |
| GET | /api/v2/loading/visits/{id} |
Get loading visit | getLoadingVisits |
Loading Visits |
| PUT | /api/v2/loading/visits/{id} |
Update loading visit | replaceLoadingVisits |
Loading Visits |
| PATCH | /api/v2/loading/visits/{id} |
Update loading visit | patchLoadingVisits |
Loading Visits |
| POST | /api/v2/loading/visits/{id}/cancel |
Cancel loading visit | cancelLoadingVisitByPath |
Loading Visits |
| GET | /api/v2/notification-templates |
List notification templates | listNotificationTemplates |
Notification Templates |
| POST | /api/v2/notification-templates |
Create notification template | createNotificationTemplate |
Notification Templates |
| GET | /api/v2/notification-templates/{id} |
Get notification template | getNotificationTemplate |
Notification Templates |
| PUT | /api/v2/notification-templates/{id} |
Update notification template | replaceNotificationTemplate |
Notification Templates |
| PATCH | /api/v2/notification-templates/{id} |
Update notification template | patchNotificationTemplate |
Notification Templates |
| DELETE | /api/v2/notification-templates/{id} |
Delete notification template | deleteNotificationTemplate |
Notification Templates |
| GET | /api/v2/notification-templates/{id}/bindings |
List notification template bindings | listNotificationTemplateBindings |
Notification Templates |
| POST | /api/v2/notification-templates/{id}/bindings |
Create notification template binding | createNotificationTemplateBinding |
Notification Templates |
| GET | /api/v2/notification-templates/{id}/bindings/{bindingId} |
Get notification template binding | getNotificationTemplateBinding |
Notification Templates |
| PUT | /api/v2/notification-templates/{id}/bindings/{bindingId} |
Update notification template binding | replaceNotificationTemplateBinding |
Notification Templates |
| PATCH | /api/v2/notification-templates/{id}/bindings/{bindingId} |
Update notification template binding | patchNotificationTemplateBinding |
Notification Templates |
| DELETE | /api/v2/notification-templates/{id}/bindings/{bindingId} |
Delete notification template binding | deleteNotificationTemplateBinding |
Notification Templates |
| GET | /api/v2/orders |
List orders | listOrders |
Orders |
| POST | /api/v2/orders |
Create order | createOrders |
Orders |
| GET | /api/v2/orders/{id} |
Get order | getOrders |
Orders |
| PUT | /api/v2/orders/{id} |
Update order | replaceOrders |
Orders |
| PATCH | /api/v2/orders/{id} |
Update order | patchOrders |
Orders |
| DELETE | /api/v2/orders/{id} |
Delete order | deleteOrders |
Orders |
| GET | /api/v2/orders/{id}/integration-events |
Export Ozon and Wildberries interaction history for one order | getOrderIntegrationEvents |
Orders |
| POST | /api/v2/orders/{id}/lines |
Create order | createOrdersLines |
Orders |
| PUT | /api/v2/orders/{id}/lines/{lineId} |
Update order | replaceOrdersLines |
Orders |
| PATCH | /api/v2/orders/{id}/lines/{lineId} |
Update order | patchOrdersLines |
Orders |
| DELETE | /api/v2/orders/{id}/lines/{lineId} |
Delete order | deleteOrdersLines |
Orders |
| POST | /api/v2/orders/{id}/offers |
Create order | createOrdersOffers |
Orders |
| PUT | /api/v2/orders/{id}/offers/{lineId} |
Update order | replaceOrdersOffers |
Orders |
| DELETE | /api/v2/orders/{id}/offers/{lineId} |
Delete order | deleteOrdersOffers |
Orders |
| GET | /api/v2/products |
List products | listProducts |
Products |
| POST | /api/v2/products |
Create product | createProducts |
Products |
| PUT | /api/v2/products |
Update product | replaceProducts |
Products |
| PATCH | /api/v2/products |
Update product | patchProducts |
Products |
| GET | /api/v2/products/{id} |
Get product | getProducts |
Products |
| DELETE | /api/v2/products/{id} |
Delete product | deleteProducts |
Products |
| GET | /api/v2/products/{id}/stock-lots |
List physical stock lots | getProductStockLots |
Products |
| GET | /api/v2/quant-unpackings |
List quant unpackings | listQuantUnpackings |
Quant Unpackings |
| POST | /api/v2/quant-unpackings |
Create quant unpacking | createQuantUnpackings |
Quant Unpackings |
| GET | /api/v2/quant-unpackings/{id} |
Get quant unpacking | getQuantUnpackings |
Quant Unpackings |
| POST | /api/v2/quant-unpackings/{id}/conduct |
Conduct quant unpacking | conductQuantUnpacking |
Quant Unpackings |
| POST | /api/v2/quant-unpackings/{id}/items |
Add quant unpacking | addQuantUnpackingsItems |
Quant Unpackings |
| GET | /api/v2/send-documents |
List send documents | listSendDocuments |
Send Documents |
| POST | /api/v2/send-documents |
Create send document | createSendDocuments |
Send Documents |
| GET | /api/v2/send-documents/{id} |
Get send document | getSendDocuments |
Send Documents |
| PUT | /api/v2/send-documents/{id} |
Update send document | replaceSendDocuments |
Send Documents |
| PATCH | /api/v2/send-documents/{id} |
Update send document | patchSendDocuments |
Send Documents |
| DELETE | /api/v2/send-documents/{id} |
Remove send document | deleteSendDocuments |
Send Documents |
| GET | /api/v2/send-documents/{id}/events |
List send document events | listSendDocumentsEvents |
Send Documents |
| POST | /api/v2/send-documents/{id}/orders |
Attach orders to send document | createSendDocumentsOrders |
Send Documents |
| DELETE | /api/v2/send-documents/{id}/orders/{orderId} |
Detach order from send document | deleteSendDocumentsOrders |
Send Documents |
| GET | /api/v2/shops |
List shops | listShops |
Shops |
| POST | /api/v2/shops |
Create shop | createShops |
Shops |
| GET | /api/v2/shops/{id} |
Get shop | getShops |
Shops |
| PUT | /api/v2/shops/{id} |
Update shop | replaceShops |
Shops |
| PATCH | /api/v2/shops/{id} |
Update shop | patchShops |
Shops |
| GET | /api/v2/stock-movements |
List stock movements | listStockMovements |
Stock Movements |
| GET | /api/v2/users |
List users | listUsers |
Users |
| GET | /api/v2/users/{id} |
Get user | getUsers |
Users |
| GET | /api/v2/warehouses |
List warehouses | listWarehouses |
Warehouses |
| POST | /api/v2/warehouses |
Create warehouse | createWarehouses |
Warehouses |
| GET | /api/v2/warehouses/{id} |
Get warehouse | getWarehouses |
Warehouses |
| PUT | /api/v2/warehouses/{id} |
Update warehouse | replaceWarehouses |
Warehouses |
| PATCH | /api/v2/warehouses/{id} |
Update warehouse | patchWarehouses |
Warehouses |
| GET | /api/v2/crossdock/cases |
List cross-dock cases | crossDockListCases |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case} |
Get cross-dock case | crossDockGetCase |
Cross-docking |
| PATCH | /api/v2/crossdock/cases/{case} |
Update cross-dock case metadata | crossDockUpdateCaseMetadata |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/allocations |
List cross-dock allocations | crossDockListAllocations |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/cancel |
Cancel cross-dock case | crossDockCancelCase |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/close |
Close cross-dock case | crossDockCloseCase |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/demands |
List cross-dock demands | crossDockListDemands |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/events |
List cross-dock events | crossDockListEvents |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/exceptions |
List cross-dock exceptions | crossDockListExceptions |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/exceptions |
Open cross-dock exception | crossDockOpenException |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/fallback |
Execute cross-dock fallback by alias | crossDockExecuteFallbackByAlias |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/fallbacks |
List cross-dock fallbacks | crossDockListFallbacks |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/fallbacks |
Execute cross-dock fallback | crossDockExecuteFallback |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/fulfillments |
List cross-dock fulfillments | crossDockListFulfillments |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/labels |
List cross-dock target labels | crossDockListTargetLabels |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/labels/print-jobs |
Create cross-dock print jobs | crossDockCreatePrintJobs |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/loading-visits |
List case loading-visit associations | crossDockListCaseLoadingVisitAssociations |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/loading-visits/attach |
Attach loading visit to cross-dock case | crossDockAttachLoadingVisitToCase |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/loading-visits/detach |
Detach loading visit from cross-dock case | crossDockDetachLoadingVisitFromCase |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/loading-visits/{visit}/attach |
Attach loading visit by path ID | crossDockAttachLoadingVisitByPathId |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/loading-visits/{visit}/detach |
Detach loading visit by path ID | crossDockDetachLoadingVisitByPathId |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/loading/scans |
Confirm cross-dock loading scan | crossDockConfirmLoadingScan |
Cross-docking |
| PUT | /api/v2/crossdock/cases/{case}/manifest |
Replace cross-dock handling-unit manifest | crossDockReplaceHandlingUnitManifest |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/orders |
List cross-dock orders | crossDockListOrders |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/orders |
Create cross-dock order and target | crossDockCreateOrderAndTarget |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/plan |
Plan cross-dock allocation | crossDockPlanAllocation |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/print-jobs |
List cross-dock print jobs | crossDockListPrintJobs |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/readiness |
Get crossdock | listCrossdockCasesReadiness |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/release |
Release cross-dock plan | crossDockReleasePlan |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/return-to-draft |
Run crossdock action | createCrossdockCasesReturnToDraft |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/scan-sessions |
Get crossdock | listCrossdockCasesScanSessions |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/scans/source |
Scan cross-dock source | crossDockScanSource |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/scans/target |
Confirm cross-dock target scan | crossDockConfirmTargetScan |
Cross-docking |
| POST | /api/v2/crossdock/cases/{case}/submit |
Run crossdock action | createCrossdockCasesSubmit |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/supplies |
List cross-dock supplies | crossDockListSupplies |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/targets |
List cross-dock targets | crossDockListTargets |
Cross-docking |
| PUT | /api/v2/crossdock/cases/{case}/targets/places |
Assign cross-dock target places | crossDockAssignTargetPlaces |
Cross-docking |
| GET | /api/v2/crossdock/cases/{case}/tasks |
List cross-dock tasks | crossDockListTasks |
Cross-docking |
| GET | /api/v2/crossdock/commands/{commandId} |
Get cross-dock command status | crossDockGetCommandStatus |
Cross-docking |
| POST | /api/v2/crossdock/exceptions/{exception}/resolve |
Resolve cross-dock exception | crossDockResolveException |
Cross-docking |
| GET | /api/v2/crossdock/loading-visits/{visit}/documents |
List cross-dock documents for loading visit | crossDockListDocumentsForLoadingVisit |
Cross-docking |
| POST | /api/v2/crossdock/print-jobs/{job}/acknowledge |
Acknowledge cross-dock print job | crossDockAcknowledgePrintJob |
Cross-docking |
| POST | /api/v2/crossdock/print-jobs/{job}/dispatch |
Dispatch cross-dock print job | crossDockDispatchPrintJob |
Cross-docking |
| GET | /api/v2/crossdock/scan-sessions/{session} |
Get cross-dock scan session | crossDockGetScanSession |
Cross-docking |
| POST | /api/v2/crossdock/scan-sessions/{session}/cancel |
Cancel cross-dock scan session | crossDockCancelScanSession |
Cross-docking |
| POST | /api/v2/crossdock/scan-sessions/{session}/quantity |
Set cross-dock scan quantity | crossDockSetScanQuantity |
Cross-docking |
Common Contract
| Authentication | Protected operations use Authorization: Bearer {token} and Accept: application/json. |
|---|---|
| Envelope | Single-resource responses use {data, meta}. Collection responses use {data, links, meta}. |
| Pagination | Paginated endpoints document page, per_page, filters, includes and allowed sort fields in the operation tables. |
| Writes | Write operations list their dedicated create, replace, patch, command, or bulk request body schemas. |