Source WebAPI - magento/inventory GitHub Wiki
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
| 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 |