MageSmith
magento/module-inventory-api · Magento 2.4.9

InventoryApi REST endpoints

vendor/magento/module-inventory-api/etc/webapi.xml

16 endpoints

GET

GET

/V1/inventory/get-sources-assigned-to-stock-ordered-by-priority/:stockId

Get Sources assigned to Stock ordered by priority

InventoryApi · Magento\InventoryApi\Api\GetSourcesAssignedToStockOrderedByPriorityInterface::execute

→
GET

/V1/inventory/source-items

Find SourceItems by SearchCriteria

InventoryApi · Magento\InventoryApi\Api\SourceItemRepositoryInterface::getList

→
GET

/V1/inventory/sources

Find Sources by SearchCriteria

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::getList

→
GET

/V1/inventory/sources/:sourceCode

Get Source data by given code. If you want to create plugin on get method, also you need to create separate

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::get

→
GET

/V1/inventory/stock-source-links

Find StockSourceLink list by given SearchCriteria

InventoryApi · Magento\InventoryApi\Api\GetStockSourceLinksInterface::execute

→
GET

/V1/inventory/stocks

Find Stocks by given SearchCriteria

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::getList

→
GET

/V1/inventory/stocks/:stockId

Get Stock data by given stockId. If you want to create plugin on get method, also you need to create separate

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::get

→

POST

POST

/V1/inventory/source-items

Save Multiple Source item data

InventoryApi · Magento\InventoryApi\Api\SourceItemsSaveInterface::execute

→
POST

/V1/inventory/source-items-delete

Delete Multiple Source item data

InventoryApi · Magento\InventoryApi\Api\SourceItemsDeleteInterface::execute

→
POST

/V1/inventory/sources

Save Source data

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::save

→
POST

/V1/inventory/stock-source-links

Save StockSourceLink list data

InventoryApi · Magento\InventoryApi\Api\StockSourceLinksSaveInterface::execute

→
POST

/V1/inventory/stock-source-links-delete

Remove StockSourceLink list list

InventoryApi · Magento\InventoryApi\Api\StockSourceLinksDeleteInterface::execute

→
POST

/V1/inventory/stocks

Save Stock data

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::save

→

PUT

PUT

/V1/inventory/sources/:sourceCode

Save Source data

InventoryApi · Magento\InventoryApi\Api\SourceRepositoryInterface::save

→
PUT

/V1/inventory/stocks/:stockId

Save Stock data

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::save

→

DELETE

DELETE

/V1/inventory/stocks/:stockId

Delete the Stock data by stockId. If stock is not found do nothing

InventoryApi · Magento\InventoryApi\Api\StockRepositoryInterface::deleteById

→

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →