Skip to content

Source WebAPI

Ievgen Shakhsuvarov edited this page Jul 16, 2019 · 9 revisions

Description

A Web API for Source Management is required to allow integration with external services. The Web API provides a set of endpoints that enable Create, Read, Update, and Delete (CRUD) operations on Sources by third parties.

Details

SourceInterface reference

Resource Request method Permissions Payload Response Implementation Description
/V1/inventory/source/:sourceCode GET Admin InventoryApi::source SourceInterface Magento\InventoryApi\Api\SourceRepositoryInterface::get Get Single Source by identifier
/V1/inventory/source/search GET Admin InventoryApi::source SourceInterface[] Magento\InventoryApi\Api\SourceRepositoryInterface::getList Load Sources filtered by Search Criteria
/V1/inventory/source POST Admin InventoryApi::source, InventoryApi::source_edit SourceInterface Created source_id Magento\InventoryApi\Api\SourceRepositoryInterface::save Create Source
/V1/inventory/source/:sourceCode PUT Admin InventoryApi::source SourceInterface SourceInterface Magento\InventoryApi\Api\SourceRepositoryInterface::save Update Source

MSI Documentation:

  1. Technical Vision. Catalog Inventory
  2. Installation Guide
  3. List of Inventory APIs and their legacy analogs
  4. MSI Roadmap
  5. Known Issues in Order Lifecycle
  6. MSI User Guide
  7. DevDocs Documentation
  8. User Stories
  9. User Scenarios:
  10. Technical Designs:
  11. Admin UI
  12. MFTF Extension Tests
  13. Weekly MSI Demos
  14. Tutorials
Clone this wiki locally