-
Notifications
You must be signed in to change notification settings - Fork 248
Magento MSI APIs
Stanislav Idolov edited this page Feb 10, 2020
·
20 revisions
All the services which reside under Magento/InventoryApi/Api namespace.
| Service | Description | Legacy analog |
|---|---|---|
| SourceRepositoryInterface | Service to Retrieve, Save or Find (getList method) Source entity(-ies) | - |
| StockRepositoryInterface | Service to Retrieve, Save, Find (getList method) or delete Stock entity(-ies) | - |
| StockSourceLinksSaveInterface | Save Sources to Stocks assignments | - |
| StockSourceLinksDeleteInterface | Remove Sources to Stocks assignments | - |
| GetStockSourceLinksInterface | Service to retrieve Source to Stock links according to provided SearchCriteria | - |
| GetSourcesAssignedTo StockOrderedByPriorityInterface | Service to Retrieve Sources assigned to provided Stock sorted by priority | - |
| SourceItemRepositoryInterface | Service to Find SourceItems (products assigned to sources with Quantity per Source) by provided SearchCriteria | StockItemRepositoryInterface::getList |
| SourceItemsSaveInterface | Service to save SourceItems (quantites and stock statuses of products on Sources) | StockItemRepositoryInterface::save |
| SourceItemsDeleteInterface | Service to delete SourceItems (quantites and stock statuses of products on Sources) | StockItemRepositoryInterface::delete or deleteById |
| GetSourceItemsBySkuInterface | Service to retrieve all product to Sources assignments by provided SKU | - |
All the services which reside under Magento/InventoryCatalogApi/Api namespace.
| Service | Description | Legacy analog |
|---|---|---|
| DefaultSourceProviderInterface | Service to retrieve Default Source code | - |
| DefaultStockProviderInterface | Service to retrieve Default Stock Id | - |
| BulkInventoryTransferInterface | Service to fully transfer the whole quantity of products from Origin to Destination source | - |
| BulkPartialInventoryTransferInterface | Service to run bulk partial inventory transfer for specified items | - |
All the services which reside under Magento/InventorySalesApi/Api namespace.
| Service | Description | Legacy analog |
|---|---|---|
| StockResolverInterface | Service to resolve linked Stock by provided sales channel type and code | StockRegistryInterface::getStock |
| GetStockBySalesChannelInterface | Service to resolve linked Stock to provided sales channel object | StockRegistryInterface::getStock |
| IsProductSalableInterface | Service to check whether product salable | StockRegistryInterface::getProductStockStatus and StockRegistryInterface::getProductStockStatusBySku and StockRegistryInterface::getStockStatusBySku |
| IsProductSalable ForRequestedQtyInterface | Service to check whether product salable for Requested Quantity (used for Shopping Cart and Checkout) | StockStateInterface::checkQuoteItemQty and StockStateInterface::checkQty |
| GetProductSalableQtyInterface | Get Product Salable Quantity (aggregated stock quantity including reservations) | StockStateInterface::getStockQty or just retrieve Qty from StockStatus entity |
| PlaceReservations ForSalesEventInterface | Place Reservation in the scope some sales event (i.e. Order Placement, Shipment creation, Credit Memo creation, Order Cancelation and so on) | RegisterProductSaleInterface and RevertProductSaleInterface |
All the services which reside under Magento/InventoryConfigurationApi/Api namespace.
| Service | Description | Legacy analog |
|---|---|---|
| GetStockItemConfigurationInterface | Service to retrieve Stock Item configuration by SKU and Stock Id | Catalog Inventory configuration stored in StockItem entity |
| SaveStockItemConfigurationInterface | Service to save Stock Item configuration | Stock Configuration saved via StockItemRepositoryInterface::save |
All the services which reside under Magento/InventorySourceSelectionApi/Api namespace.
| Service | Description | Legacy analog |
|---|---|---|
| GetDefaultSourceSelectionAlgorithmCodeInterface | Service to Get Default Source Selection Algorithm (SSA) code | - |
| GetSourceSelectionAlgorithmListInterface | Service to get the whole Source Selection Algorithm (SSA) list | - |
| SourceSelectionServiceInterface | Service to run specified Source Selection Algorithm (SSA) based on provided Inventory Request object | - |
All the services which reside under Magento/InventoryExportStockApi/Api namespace.
| Service | Description | Legacy analog |
|---|---|---|
| ExportStockIndexDataInterface | Service to return Salable Quantities for provided Sales Channel NOT including placed reservations (for completed Orders). Less precise, but very quick like a rabbit | - |
| ExportStockSalableQtyInterface | Service to return Salable Quantities for provided Sales Channel Including placed reservations (for completed Orders). Precise, but very performance efficient like a turtle | - |
Multi-Source Inventory developed by Magento 2 Community
- Technical Vision. Catalog Inventory
- Installation Guide
- List of Inventory APIs and their legacy analogs
- MSI Roadmap
- Known Issues in Order Lifecycle
- MSI User Guide
- 2.3 LIVE User Guide
- MSI Release Notes and Installation
- Overview
- Get Started with MSI
- MSI features and processes
- Global and Product Settings
- Configure Source Selection Algorithm
- Create Sources
- Create Stock
- Assign Inventory and Product Notifications
- Configure MSI backorders
- MSI Import and Export Product Data
- Mass Action Tool
- Shipment and Order Management
- CLI reference
- Reports and MSI
- MSI FAQs
- DevDocs Documentation
- Manage Inventory Management Modules (install/upgrade info)
- Inventory Management
- Reservations
- Inventory CLI reference
- Inventory API reference
- Inventory In-Store Pickup API reference
- Order Processing with Inventory Management
- Managing sources
- Managing stocks
- Link and unlink stocks and sources
- Manage source items
- Perform bulk actions
- Manage Low-Quantity Notifications
- Check salable quantities
- Manage source selection algorithms
- User Stories
- Support of Store Pickup for MSI
- Product list assignment per Source
- Source assignment per Product
- Stocks to Sales Channel Mapping
- Adapt Product Import/Export to support multi Sourcing
- Introduce SourceCode attribute for Source and SourceItem entities
- Assign Source Selector for Processing of Returns Credit Memo
- User Scenarios:
- Technical Designs:
- Module Structure in MSI
- When should an interface go into the Model directory and when should it go in the Api directory?
- Source and Stock Item configuration Design and DB structure
- Stock and Source Configuration design
- Open Technical Questions
- Inconsistent saving of Stock Data
- Source API
- Source WebAPI
- Sources to Sales Channels mapping
- Service Contracts MSI
- Salable Quantity Calculation and Mechanism of Reservations
- StockItem indexation
- Web API and How To cover them with Functional Testing
- Source Selection Algorithms
- Validation of Domain Entities
- PHP 7 Syntax usage for Magento contribution
- The first step towards pre generated IDs. And how this will improve your Integration tests
- The Concept of Default Source and Domain Driven Design
- Extension Point of Product Import/Export
- Source Selection Algorithm
- SourceItem Entity Extension
- Design Document for changing SerializerInterface
- Stock Management for Order Cancelation
- Admin UI
- MFTF Extension Tests
- Weekly MSI Demos
- Tutorials